This is a WORK IN PROGRESS

This Gem relies heavily on both Sidekiq and Celluloid Gems, you are encouraged to use it anywhere with Ruby (a http interface is on the Roadmap ).

This Gem provides workers ready for deploy cooked with MongoDB + Mongoid + Sidekiq + Rubinius (feel free to use on MRI and jruby as well).

You can:

  $ gem install mailcannon

Or just add it to your Gemfile

  gem 'mailcannon'

Create a MailCannon::Envelope:

envelope = MailCannon::Envelope.create(
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Test',
  mail: MailCannon::Mail.create(text: 'you will see this when no HTML reader is available', html: 'this should be an HTML'))
envelope.send!

If you are on Rails, run the following command to generate a config file:

$ rails g mailcannon:config

Edit the file to meet your environemnt needs.

Check the specs to see the testing example, it will surely make it clearer.

You should check the factories to learn what you need to build your objects, and the tests to learn how to use them. But hey, we have docs right here.

Just fork MailCannon, add your feature+spec, and make a pull request. Do not mess up with the version file though.

NOTICE: The project is at embrionary stage, breaking changes will apply.

This is an opensource project so don't expect premium support, but don't be shy, post any troubles you're having in the Issues page and we'll do what we can to help.

MailCannon is free software under the FreeBSD license.