Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Add mails to database for background mail sending

branch: master
README.markdown

mail_queue

INSTALATION

1) Install the plugin with script/plugin install http://github.com/fnando/mail_queue.git

2) Generate a migration with script/generate migration create_mails and add the following code:

class CreateMails < ActiveRecord::Migration
  def self.up
    create_table :mails do |t|
      t.string :subject, :from, :to, :cc, :bcc, :charset, :content_type
      t.text :body, :data
      t.boolean :locked, :default => false, :null => false
      t.integer :priority, :default => 3, :null => false
      t.integer :tries, :default => 0, :null => false
      t.integer :maximum_tries, :default => 3, :null => false
      t.timestamps
    end

    add_index :mails, :locked
    add_index :mails, :priority
    add_index :mails, :tries
  end

  def self.down
    drop_table :mails
  end
end

3) Run the migrations with rake db:migrate

USAGE

  1. Create your mailer using script/generate mailer <name>
  2. To queue a message, call Mail.queue(<tmail>) or <Mailer>.queue(<method>, <*args>)
  3. To deliver the messages, call Mail.process(:limit => <limit>)

SAMPLE

Generate a mailer called UserNotifier with script/generate mailer UserNotifier. Here's what it looks like:

class UserNotifier < ActionMailer::Base
  def activation(user)
    subject       "Confirm your subscription"
    recipients    user.email
    from          "mail@cool-app.com"
    body          :user => user

    # you can also specify BCC and CC recipients.
    # check it out the Troubleshooting section if
    # you're getting errors like 
    # ActiveRecord::UnknownAttributeError: unknown attribute: cc
    cc      "cc-recipient@cool-app.com"
    bcc     "bcc-recipient@cool-app.com"
  end
end

# you can queue a TMail
Mail.queue(UserNotifier.create_activation(@user))

# or just call the method queue
UserNotifier.queue(:activation, @user)

# the last argument can be a hash with the following options
UserNotifier.queue(:activation, @user, :priority => 0, :tries => 5)

# save additional data; any additional data will be saved as .to_yaml
UserNotifier.queue(:activation, @user, :data => @user)

# Mail.process accepts two options
Mail.process(:limit => 300)

NOTE: Don't know if will work with multipart mails.

You can run this Mail.process method on a background job. I use simple-daemon gem. I have something like this:

require File.join(File.dirname(__FILE__), "..", "..", "config", "environment")
require "simple-daemon"

class MailDaemon < SimpleDaemon::Base
  SimpleDaemon::WORKING_DIRECTORY = "#{RAILS_ROOT}/tmp"

  def self.start
    loop do
      Mail.process
      sleep(30)
    end
  end

  def self.stop
  end
end

MailDaemon.daemonize

TROUBLESHOOTING

If you're receiving ActiveRecord::UnknownAttributeError: unknown attribute: cc error, create a new migration with script/generate migration add_cc_and_bcc_fields and add the following code:

class AddCcAndBccFields < ActiveRecord::Migration
  def self.up
    add_column :mails, :cc, :string
    add_column :mails, :bcc, :string
  end

  def self.down
    remove_column :mails, :cc
    remove_column :mails, :bcc
  end
end

Run rake db:migrate and be happy!

MAINTAINER

CONTRIBUTORS

LICENSE:

(The MIT License)

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.

Copyright (c) 2007-2009 Nando Vieira, released under the MIT license

Something went wrong with that request. Please try again.