QuMailer

QuMailer is a library for the asynchronous delivery of emails sent out by ActionMailer in Rails 3 applications. It is heavily inspired by ResqueMailer.

Email jobs created by QuMailer are processed by Qu, a Ruby library for queuing and processing background jobs.

Installation

It is assumed that you are using Qu. If you aren’t already using it, please visit the Qu project page for details on getting set up.

Rails 3

Add the QuMailer gem to your Gemfile.

gem 'qu_mailer'

Usage

Include QuMailer in your ActionMailer subclass(es):

class MyMailer < ActionMailer::Base
  include Qu::Mailer
end

Fire up Qu with a 'mailer' queue:

$ bundle exec rake qu:work QUEUES=mailer,default

Now, when you send a deliver message to an action in MyMailer, it will be placed on Qu’s mailer queue, and a Qu worker will deliver it in due course. If you want to bybass Qu in a particular scenario and send the email synchronously, then use deliver!.

It is recommended that instead of passing objects to your emails as parameters, record identifiers are used instead. Jobs are handled in a separate process.

Configuration

Queue Name

QuMailer defaults to a queue called mailer. You can change the name of the queue using an initializer.

config/initializers/qu_mailer.rb:

  Qu::Mailer.default_queue_name = 'asynchronous_electronic_mailbox'

Excluded Environments

You may want to prevent QuMailer from sending out email in certain environments. By default QuMailer exludes the test environment. You may add additional excluded environments using an initializer.

config/initializers/qu_mailer.rb:

  Qu::Mailer.excluded_environments << :cucumber

License

Copyright (c) 2011 Philip Poots

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.