prioritized_ar_mailer_rails3 2.1.12

data/.gitignore

@@ -0,0 +1,3 @@
+test
+pkg
+.DS_Store

data/History.txt

@@ -0,0 +1,163 @@
+= 2.1.12
+
+* Miscellaneous Updates
+  * Added feature to send mail with priority. 
+
+= 2.1.8
+
+* Bugs fixed
+  * Fix BCC addresses being visible to all recipients (laserlemon)
+
+= 2.1.7
+
+* Miscellaneous Updates
+  * Added adzap-ar_mailer file to end the need for the config.gem :lib option
+
+* Bugs fixed
+  * Fix from address being set as address header object.
+
+= 2.1.6
+
+* Miscellaneous Updates
+  * Use return-path as from address if set, as per default ActionMailer::Base SMTP delivery (Dustin Tinney)
+  * Always wait full delay between deliveries (cyu)
+
+* Bugs fixed
+  * Non-zero return code returned in init.d script (hennk)
+  * Use updated Timeout error class (hennk)
+
+= 2.1.5
+
+* Bugs fixed
+  * Load ar_mailer after environment to fix issue with lazy loading of ActionMailer in Rails 2.3
+
+= 2.1.4
+
+* Bugs fixed
+  * Explicitly require ar_mailer in ar_sendmail because its not getting loaded by the Rails environment for some reason
+
+= 2.1.3
+
+* Tests now pass on gem install
+* Removed deprecated ActionMailer::ARMailer class
+* Bugs fixed
+  * Fixed issue with pre-loading ActionMailer. No use ActionMailer::Base.email_class directly rather than store in ARSendmail instance var so no need to pre-load ActionMailer.
+
+= 2.1.2
+
+* Bugs fixed
+  * Require ar_mailer in ar_sendmail since the change to remove TableName and use email_class
+
+= 2.1.1
+
+ * Force gem rebuild
+
+= 2.1.0
+
+* Switched to using a Rails generator for migration and model files. The ar_sendmail options have been removed.
+
+= 2.0.2
+
+* Removed TableName option from ar_sendmail options as its redundant. The Rails environment gets loaded so the settings for email class also get loaded
+* Bugs fixed
+  * Email class reloading issue in development mode causing AR email class defaults to be lost when cached
+
+= 2.0.1
+
+* Added option to use smtp setting of :tls => false to disable TLS auto start in Ruby 1.8.7+
+* Removed some cruft which can be handled by ActiveSupport
+
+= 2.0.0
+
+* Removed need to use ARMailer subclass. Just set the delivery method and you are ready to go. Backwards compatible with a deprecation notice if you subclass old ARMailer class.
+* Only include SMTP TLS patch if Ruby version < 1.8.7 as it has an alternative. Changes based on Calvin Yu's [cyu] fork.
+* Renamed default migration name to the modern Rails default
+* Only authenticate if emails waiting to be sent
+* Added --version switch to ar_sendmail binary
+* Created a lighthouse account for this project (adzap fork only). See README.
+
+= 1.4.4
+
+* Exit init.d script with message if no mailers defined.
+
+= 1.4.3
+
+* Bugs fixed
+  * Replaced mistaken call to log when removing pid file artifact for
+    non-running daemon
+
+= 1.4.2
+
+* New Features
+  * Added Ruby based linux init.d script for handling daemon startup using yaml
+    config file. See files share/linux/ar_sendmail and ar_sendmail.conf
+* Bugs fixed
+  * Proper handling for relative and absolute paths for the pid file
+* Removed hoe dependency since we need the explicit gemspec file for github and
+  not deploying to RubyForge its not as useful.
+* Moved old BSD rc.d script to share/bsd folder
+* Updated README with github gem install, docs and init script info
+
+= 1.4.1
+
+* Bugs fixed
+  * Daemon failed on startup fixed with expanding full path of pid file
+
+= 1.4.0
+
+* Forked gem and published on GitHub (gem sources -a http://gems.github.com)
+* New Features
+  * Added pid file creation on daemonize with command line option to specify pid filename [Dylan Egan]
+
+= 1.3.1
+
+* Fix bug #12530, gmail causes SSL errors.  Submitted by Kyle Maxwell
+  and Alex Ostleitner.
+* Try ActionMailer::Base::server_settings then ::smtp_settings.  Fixes
+  bug #12516.  Submitted by Alex Ostleitner.
+
+= 1.3.0
+
+* New Features
+  * Added automatic mail queue cleanup.
+    * MAY CAUSE LOSS OF DATA.  If you haven't run ar_sendmail within
+      the expiry time, set it to 0.
+* Bugs fixed
+  * Authentication errors are now handled by retrying once.
+
+= 1.2.0
+
+* Bugs fixed
+  * Handle SMTPServerBusy by backing off @delay seconds then re-queueing
+  * Allow email delivery class to be set in ARMailer.
+  * ar_sendmail --mailq works with --table-name now.
+* Miscellaneous Updates
+  * Added documentation to require 'action_mailer/ar_mailer' in
+    instructions.
+  * Moved to ZSS p4 repository
+  * Supports TLS now.  Requested by Dave Thomas. smtp_tls.rb from Kyle
+    Maxwell & etc.
+
+= 1.1.0
+
+* Features
+  * Added --chdir to set rails directory
+  * Added --environment to set RAILS_ENV
+  * Exits cleanly on TERM or INT signals
+  * Added FreeBSD rc.d script
+  * Exceptions during SMTP sending are now logged
+  * No longer waits if sending email took too long
+* Bugs fixed
+  * Fixed last send attempt in --mailq
+  * Better SMTP error handling
+    * Messages are removed from the queue on 5xx errors
+    * Added Net::SMTP.reset to avoid needing to recreate the connection
+
+= 1.0.1
+
+* Bugs fixed
+  * From and to of email destination were swapped
+
+= 1.0.0
+
+* Birthday

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Original code copyright 2006, 2007, Eric Hodel, The Robot Co-op.  All
+rights reserved.  Some code under other license, see individual files
+for details.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,123 @@
+= ar_mailer_rails3
+
+A two-phase delivery agent for ActionMailer which works for Rails 3 with feature for setting mail priority.
+
+https://github.com/yzhang/ar_mailer_rails3
+
+and for forked additions
+
+https://github.com/gsoni-ror/ar_mailer_rails3/wikis
+
+
+== About
+
+Even delivering email to the local machine may take too long when you have to
+send hundreds of messages.  ar_mailer allows you to store messages into the
+database for later delivery by a separate process, ar_sendmail. Now also allows to set priorities to the mails or skip mail from getting into the queue if required.
+
+== Installing ar_mailer_rails3
+
+Don't need remove adzap-ar_mailer or ar_mailer, just install ar_mailer_rails3
+
+$ sudo gem install prioritized_ar_mailer_rails3
+
+== Usage
+
+Go to your Rails project:
+
+  $ cd your_rails_project
+
+Create the migration, model and initializer:
+
+This shows the options which are only the model name, which defaults to Email
+
+  ./script/generate ar_mailer_rails3 -h
+
+Then run with defaults
+
+  ./script/generate ar_mailer email
+
+Or specify a custom model name
+
+  ./script/generate ar_mailer newsletter
+
+See Alternate Mail Storage if you use a custom model name
+
+In your mailer class methods you must be sure to set the From address for your emails.
+Something like:
+
+  def list_send(recipient)
+    from 'no_reply@example.com'
+    # ...
+
+And if you want to set the mail priority, add request level variable @priority Something like:
+
+def list_send(recipient)
+  @priority = 5
+  # ...
+
+@priority could be any number, ar_mailer sort mails on priority and send it in the desc order.
+
+Just in case you want to skip any mail from getting into the queue[for Urgent mails], you can assign @priority = -1 :)
+
+Edit config/initializer/ar_mailer_rails3.rb and uncomment below line to use ar_mailer as
+default delivery method:
+
+  ActionMailer::Base.delivery_method = :active_record
+
+Or if you need to, you can set each mailer class delivery method individually:
+
+  class MyMailer < ActionMailer::Base
+    self.delivery_method = :active_record
+  end
+
+This can be useful when using plugins like ExceptionNotification. Where it
+might be foolish to tie the sending of the email alert to the database when the
+database might be causing the exception being raised. In this instance you could
+override ExceptionNofitier delivery method to be smtp or set the other
+mailer classes to use ARMailer explicitly.
+
+Then to run it:
+
+  $ ar_sendmail_rails3
+
+You can also run it from cron with -o, or as a daemon with -d.
+
+See <tt>ar_sendmail_rails3 -h</tt> for full details.
+
+=== Alternate Mail Storage
+
+By default ar_mailer_rails3 assumes you are using an ActiveRecord model called
+Email to store the emails created before sending. If you want to change
+this you alter it in an intializer like so:
+
+  ActionMailer::Base.add_delivery_method :active_record, ArMailer::ActiveRecord, :email_class => Newsletter
+
+=== A Word on TLS
+
+If you are using Ruby >= 1.8.7, TLS will be enabled automatically if your
+SMTP server supports it. If you do not want it to automatically enabled then
+set the :tls option to false in your smtp_settings.
+
+If you are on Ruby <= 1.8.6, then the TLS patch included in this plugin will
+be loaded, so you don't need another TLS plugin to add the capability. This
+patch allows you to explicit set if the server supports TLS by setting the
+:tls option to true in your smtp_settings.
+
+=== Help
+
+See ar_sendmail_rails3 -h for options to ar_sendmail_rails3.
+
+NOTE: You may need to delete an smtp_tls.rb file if you have one lying
+around.  ar_mailer supplies it own.
+
+== Run as a service (init.d/rc.d scripts)
+
+For Linux both script and demo config files are in share/linux.
+See ar_sendmail.conf for setting up your config. Copy the ar_sendmail file
+to /etc/init.d/ and make it executable. Then for Debian based distros run
+'sudo update-rc.d ar_sendmail defaults' and it should work. Make sure you have
+the config file /etc/ar_sendmail.conf in place before starting.
+
+For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
+support the config file unless someone wants to submit a patch.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "prioritized_ar_mailer_rails3"
+    s.summary = "ArMailer wrapper for Rails 3 with mail priority"
+    s.email = "raveformails@gmail.com"
+    s.homepage = "https://github.com/gsoni-ror/ar_mailer_rails3"
+    s.description = "ArMailer wrapper for Rails 3 with mail priority"
+    s.authors = ["Gaurav Soni"]
+    s.files =  FileList["[A-Z]*", "bin/*", "share/*", "test/*", "{lib}/**/*", '.gitignore']
+    s.test_files = []
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+2.1.12

data/bin/ar_sendmail_rails3

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'ar_mailer_rails3/ar_sendmail'
+
+ArMailerRails3::ARSendmail.run
+

data/lib/ar_mailer_rails3.rb

@@ -0,0 +1 @@
+require 'ar_mailer_rails3/active_record'

data/lib/ar_mailer_rails3/active_record.rb

@@ -0,0 +1,59 @@
+module ArMailerRails3
+  # A delivery method implementation which sends via sendmail.
+  # 
+  # To use this, first find out where the sendmail binary is on your computer,
+  # if you are on a mac or unix box, it is usually in /usr/sbin/sendmail, this will
+  # be your sendmail location.
+  # 
+  #   Mail.defaults do
+  #     delivery_method :sendmail
+  #   end
+  # 
+  # Or if your sendmail binary is not at '/usr/sbin/sendmail'
+  # 
+  #   Mail.defaults do
+  #     delivery_method :sendmail, :location => '/absolute/path/to/your/sendmail'
+  #   end
+  # 
+  # Then just deliver the email as normal:
+  # 
+  #   Mail.deliver do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  # Or by calling deliver on a Mail message
+  # 
+  #   mail = Mail.new do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  #   mail.deliver!
+  class ActiveRecord
+    
+    def initialize(options)
+      self.email_class = options[:email_class] || Email
+    end
+    
+    attr_accessor :email_class_name, :email_class
+    
+    def deliver!(mail)
+      require "action_mailer/ar_sendmail"
+      destinations = mail.destinations
+      sender = mail.return_path || mail.sender || mail.from_addrs.first
+      destinations.each do |destination|
+        m = self.email_class.create :mail => mail.encoded, :to => destination, :from => sender, :priority => (@priority.present? ? @priority : 3)
+        if m.priority==-1
+          sendmail = ArMailerRails3::ARSendmail.new
+          sendmail.deliver([m])
+          m.destroy
+        end
+      end
+    end
+  end
+end

data/lib/ar_mailer_rails3/ar_sendmail.rb

@@ -0,0 +1,489 @@
+require 'optparse'
+require 'net/smtp'
+require 'smtp_tls' unless Net::SMTP.instance_methods.include?("enable_starttls_auto")
+
+##
+# Hack in RSET
+
+module Net # :nodoc:
+class SMTP # :nodoc:
+
+  unless instance_methods.include? 'reset' then
+    ##
+    # Resets the SMTP connection.
+
+    def reset
+      getok 'RSET'
+    end
+  end
+
+end
+end
+
+##
+# ActionMailer::ARSendmail delivers email from the email table to the
+# SMTP server configured in your application's config/environment.rb.
+# ar_sendmail does not work with sendmail delivery.
+#
+# ar_mailer can deliver to SMTP with TLS using smtp_tls.rb borrowed from Kyle
+# Maxwell's action_mailer_optional_tls plugin.  Simply set the :tls option in
+# ActionMailer::Base's smtp_settings to true to enable TLS.
+#
+# See ar_sendmail -h for the full list of supported options.
+#
+# The interesting options are:
+# * --daemon
+# * --mailq
+
+module ArMailerRails3; end
+
+class ArMailerRails3::ARSendmail
+
+  ##
+  # The version of ActionMailer::ARSendmail you are running.
+
+  VERSION = '2.1.12'
+
+  ##
+  # Maximum number of times authentication will be consecutively retried
+
+  MAX_AUTH_FAILURES = 2
+
+  ##
+  # Email delivery attempts per run
+
+  attr_accessor :batch_size
+
+  ##
+  # Seconds to delay between runs
+
+  attr_accessor :delay
+
+  ##
+  # Maximum age of emails in seconds before they are removed from the queue.
+
+  attr_accessor :max_age
+
+  ##
+  # Be verbose
+
+  attr_accessor :verbose
+
+
+  ##
+  # True if only one delivery attempt will be made per call to run
+
+  attr_reader :once
+
+  ##
+  # Times authentication has failed
+
+  attr_accessor :failed_auth_count
+
+  @@pid_file = nil
+
+  def self.remove_pid_file
+    if @@pid_file
+      require 'shell'
+      sh = Shell.new
+      sh.rm @@pid_file
+    end
+  end
+
+  ##
+  # Get email class
+  
+  def self.email_class
+    ActionMailer::Base.active_record_settings[:email_class]
+  end
+  
+  ##
+  # Prints a list of unsent emails and the last delivery attempt, if any.
+  #
+  # If ActiveRecord::Timestamp is not being used the arrival time will not be
+  # known.  See http://api.rubyonrails.org/classes/ActiveRecord/Timestamp.html
+  # to learn how to enable ActiveRecord::Timestamp.
+
+  def self.mailq
+    emails = self.email_class.find :all, :order=>"priority desc"
+
+    if emails.empty? then
+      puts "Mail queue is empty"
+      return
+    end
+
+    total_size = 0
+
+    puts "-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------"
+    emails.each do |email|
+      size = email.mail.length
+      total_size += size
+
+      create_timestamp = email.created_on rescue
+                         email.created_at rescue
+                         Time.at(email.created_date) rescue # for Robot Co-op
+                         nil
+
+      created = if create_timestamp.nil? then
+                  '             Unknown'
+                else
+                  create_timestamp.strftime '%a %b %d %H:%M:%S'
+                end
+
+      puts "%10d %8d %s  %s" % [email.id, size, created, email.from]
+      if email.last_send_attempt > 0 then
+        puts "Last send attempt: #{Time.at email.last_send_attempt}"
+      end
+      puts "                                         #{email.to}"
+      puts
+    end
+
+    puts "-- #{total_size/1024} Kbytes in #{emails.length} Requests."
+  end
+
+  ##
+  # Processes command line options in +args+
+
+  def self.process_args(args)
+    name = File.basename $0
+
+    options = {}
+    options[:Chdir] = '.'
+    options[:Daemon] = false
+    options[:Delay] = 60
+    options[:MaxAge] = 86400 * 7
+    options[:Once] = false
+    options[:RailsEnv] = ENV['RAILS_ENV']
+    options[:Pidfile] = options[:Chdir] + '/log/ar_sendmail.pid'
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{name} [options]"
+      opts.separator ''
+
+      opts.separator "#{name} scans the email table for new messages and sends them to the"
+      opts.separator "website's configured SMTP host."
+      opts.separator ''
+      opts.separator "#{name} must be run from a Rails application's root."
+
+      opts.separator ''
+      opts.separator 'Sendmail options:'
+
+      opts.on("-b", "--batch-size BATCH_SIZE",
+              "Maximum number of emails to send per delay",
+              "Default: Deliver all available emails", Integer) do |batch_size|
+        options[:BatchSize] = batch_size
+      end
+
+      opts.on(      "--delay DELAY",
+              "Delay between checks for new mail",
+              "in the database",
+              "Default: #{options[:Delay]}", Integer) do |delay|
+        options[:Delay] = delay
+      end
+
+      opts.on(      "--max-age MAX_AGE",
+              "Maxmimum age for an email. After this",
+              "it will be removed from the queue.",
+              "Set to 0 to disable queue cleanup.",
+              "Default: #{options[:MaxAge]} seconds", Integer) do |max_age|
+        options[:MaxAge] = max_age
+      end
+
+      opts.on("-o", "--once",
+              "Only check for new mail and deliver once",
+              "Default: #{options[:Once]}") do |once|
+        options[:Once] = once
+      end
+
+      opts.on("-d", "--daemonize",
+              "Run as a daemon process",
+              "Default: #{options[:Daemon]}") do |daemon|
+        options[:Daemon] = true
+      end
+
+      opts.on("-p", "--pidfile PIDFILE",
+              "Set the pidfile location",
+              "Default: #{options[:Chdir]}#{options[:Pidfile]}", String) do |pidfile|
+        options[:Pidfile] = pidfile
+      end
+
+      opts.on(      "--mailq",
+              "Display a list of emails waiting to be sent") do |mailq|
+        options[:MailQ] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Setup Options:'
+
+      opts.separator ''
+      opts.separator 'Generic Options:'
+
+      opts.on("-c", "--chdir PATH",
+              "Use PATH for the application path",
+              "Default: #{options[:Chdir]}") do |path|
+        usage opts, "#{path} is not a directory" unless File.directory? path
+        usage opts, "#{path} is not readable" unless File.readable? path
+        options[:Chdir] = path
+      end
+
+      opts.on("-e", "--environment RAILS_ENV",
+              "Set the RAILS_ENV constant",
+              "Default: #{options[:RailsEnv]}") do |env|
+        options[:RailsEnv] = env
+      end
+
+      opts.on("-v", "--[no-]verbose",
+              "Be verbose",
+              "Default: #{options[:Verbose]}") do |verbose|
+        options[:Verbose] = verbose
+      end
+
+      opts.on("-h", "--help",
+              "You're looking at it") do
+        usage opts
+      end
+
+      opts.on("--version", "Version of ARMailer") do
+        usage "ar_mailer #{VERSION} (adzap fork)"
+      end
+
+      opts.separator ''
+    end
+
+    opts.parse! args
+
+    ENV['RAILS_ENV'] = options[:RailsEnv]
+
+    Dir.chdir options[:Chdir] do
+      begin
+        require Dir.pwd + '/config/environment'
+        require 'ar_mailer_rails3/active_record'
+      rescue LoadError
+        usage opts, <<-EOF
+#{name} must be run from a Rails application's root to deliver email.
+#{Dir.pwd} does not appear to be a Rails application root.
+        EOF
+      end
+    end
+
+    return options
+  end
+
+  ##
+  # Processes +args+ and runs as appropriate
+
+  def self.run(args = ARGV)
+    options = process_args args
+
+    if options.include? :MailQ then
+      mailq
+      exit
+    end
+
+    if options[:Daemon] then
+      require 'webrick/server'
+      @@pid_file = File.expand_path(options[:Pidfile], options[:Chdir])
+      if File.exists? @@pid_file
+        # check to see if process is actually running
+        pid = ''
+        File.open(@@pid_file, 'r') {|f| pid = f.read.chomp }
+        if system("ps -p #{pid} | grep #{pid}") # returns true if process is running, o.w. false
+          $stderr.puts "Warning: The pid file #{@@pid_file} exists and ar_sendmail is running. Shutting down."
+          exit -1
+        else
+          # not running, so remove existing pid file and continue
+          self.remove_pid_file
+          $stderr.puts "ar_sendmail is not running. Removing existing pid file and starting up..."
+        end
+      end
+      WEBrick::Daemon.start
+      File.open(@@pid_file, 'w') {|f| f.write("#{Process.pid}\n")}
+    end
+
+    new(options).run
+
+  rescue SystemExit
+    raise
+  rescue SignalException
+    exit
+  rescue Exception => e
+    $stderr.puts "Unhandled exception #{e.message}(#{e.class}):"
+    $stderr.puts "\t#{e.backtrace.join "\n\t"}"
+    exit -2
+  end
+
+  ##
+  # Prints a usage message to $stderr using +opts+ and exits
+
+  def self.usage(opts, message = nil)
+    if message then
+      $stderr.puts message
+      $stderr.puts
+    end
+
+    $stderr.puts opts
+    exit 1
+  end
+
+  ##
+  # Creates a new ARSendmail.
+  #
+  # Valid options are:
+  # <tt>:BatchSize</tt>:: Maximum number of emails to send per delay
+  # <tt>:Delay</tt>:: Delay between deliver attempts
+  # <tt>:Once</tt>:: Only attempt to deliver emails once when run is called
+  # <tt>:Verbose</tt>:: Be verbose.
+
+  def initialize(options = {})
+    options[:Delay] ||= 60
+    options[:MaxAge] ||= 86400 * 7
+
+    @batch_size = options[:BatchSize]
+    @delay = options[:Delay]
+    @once = options[:Once]
+    @verbose = options[:Verbose]
+    @max_age = options[:MaxAge]
+
+    @failed_auth_count = 0
+  end
+
+  ##
+  # Removes emails that have lived in the queue for too long.  If max_age is
+  # set to 0, no emails will be removed.
+
+  def cleanup
+    return if @max_age == 0
+    timeout = Time.now - @max_age
+    conditions = ['last_send_attempt > 0 and created_on < ?', timeout]
+    mail = self.class.email_class.destroy_all conditions
+
+    log "expired #{mail.length} emails from the queue"
+  end
+
+  ##
+  # Delivers +emails+ to ActionMailer's SMTP server and destroys them.
+
+  def deliver(emails)
+    settings = [
+      smtp_settings[:domain],
+      (smtp_settings[:user] || smtp_settings[:user_name]),
+      smtp_settings[:password],
+      smtp_settings[:authentication]
+    ]
+
+    smtp = Net::SMTP.new(smtp_settings[:address], smtp_settings[:port])
+    if smtp.respond_to?(:enable_starttls_auto)
+      smtp.enable_starttls_auto unless smtp_settings[:tls] == false
+    else
+      settings << smtp_settings[:tls]
+    end
+
+    smtp.start(*settings) do |session|
+      @failed_auth_count = 0
+      until emails.empty? do
+        email = emails.shift
+        begin
+          res = session.send_message email.mail, email.from, email.to
+          email.destroy
+          log "sent email %011d from %s to %s: %p" %
+                [email.id, email.from, email.to, res]
+        rescue Net::SMTPFatalError => e
+          log "5xx error sending email %d, removing from queue: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          email.destroy
+          session.reset
+        rescue Net::SMTPServerBusy => e
+          log "server too busy, stopping delivery cycle"
+          return
+        rescue Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError, Timeout::Error => e
+          email.last_send_attempt = Time.now.to_i
+          email.save rescue nil
+          log "error sending email %d: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          session.reset
+        end
+      end
+    end
+  rescue Net::SMTPAuthenticationError => e
+    @failed_auth_count += 1
+    if @failed_auth_count >= MAX_AUTH_FAILURES then
+      log "authentication error, giving up: #{e.message}"
+      raise e
+    else
+      log "authentication error, retrying: #{e.message}"
+    end
+    sleep delay
+  rescue Net::SMTPServerBusy, SystemCallError, OpenSSL::SSL::SSLError
+    # ignore SMTPServerBusy/EPIPE/ECONNRESET from Net::SMTP.start's ensure
+  end
+
+  ##
+  # Prepares ar_sendmail for exiting
+
+  def do_exit
+    log "caught signal, shutting down"
+    self.class.remove_pid_file
+    exit 130
+  end
+
+  ##
+  # Returns emails in email_class that haven't had a delivery attempt in the
+  # last 300 seconds.
+
+  def find_emails
+    options = { :conditions => ['last_send_attempt < ?', Time.now.to_i - 300], :order=> "priority desc" }
+    options[:limit] = batch_size unless batch_size.nil?
+    mail = self.class.email_class.find :all, options
+
+    log "found #{mail.length} emails to send"
+    mail
+  end
+
+  ##
+  # Installs signal handlers to gracefully exit.
+
+  def install_signal_handlers
+    trap 'TERM' do do_exit end
+    trap 'INT'  do do_exit end
+  end
+
+  ##
+  # Logs +message+ if verbose
+
+  def log(message)
+    $stderr.puts message if @verbose
+    ActionMailer::Base.logger.info "ar_sendmail: #{message}"
+  end
+
+  ##
+  # Scans for emails and delivers them every delay seconds.  Only returns if
+  # once is true.
+
+  def run
+    install_signal_handlers
+
+    loop do
+      begin
+        cleanup
+        emails = find_emails
+        deliver(emails) unless emails.empty?
+      rescue
+      end
+      break if @once
+      sleep @delay
+    end
+  end
+
+  ##
+  # Proxy to ActionMailer::Base::smtp_settings.  See
+  # http://api.rubyonrails.org/classes/ActionMailer/Base.html
+  # for instructions on how to configure ActionMailer's SMTP server.
+  #
+  # Falls back to ::server_settings if ::smtp_settings doesn't exist for
+  # backwards compatibility.
+
+  def smtp_settings
+    ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
+  end
+
+end

data/lib/generators/ar_mailer_rails3/ar_mailer_rails3_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ArMailerRails3Generator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  
+  def create_ar_mailer_files
+    self.class.check_class_collision class_name
+    template('ar_mailer.rb', 'config/initializers/ar_mailer.rb')
+    template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
+    migration_template 'migration.rb', "db/migrate/create_#{file_path.gsub(/\//, '_').pluralize}.rb"
+  end
+  
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+     "%.3d" % (current_migration_number(dirname) + 1)
+   end
+  end
+  
+  def self.banner
+    "Usage: #{$0} ar_mailer_rails3 EmailModelName (default: Email)"
+  end  
+end

data/lib/generators/ar_mailer_rails3/templates/ar_mailer.rb

@@ -0,0 +1,2 @@
+ActionMailer::Base.add_delivery_method :active_record, ArMailerRails3::ActiveRecord, :email_class => <%= class_name %>
+ActionMailer::Base.delivery_method = :active_record

data/lib/generators/ar_mailer_rails3/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= migration_class_name.gsub(/::/, '') %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :mail, :text
+      t.column :priority, :integer
+      t.column :created_on, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/ar_mailer_rails3/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/smtp_tls.rb

@@ -0,0 +1,105 @@
+# Original code believed public domain from ruby-talk or ruby-core email.
+# Modifications by Kyle Maxwell <kyle@kylemaxwell.com> used under MIT license.
+
+require "openssl"
+require "net/smtp"
+
+# :stopdoc:
+
+class Net::SMTP
+
+  class << self
+    send :remove_method, :start
+  end
+
+  def self.start( address, port = nil,
+                  helo = 'localhost.localdomain',
+                  user = nil, secret = nil, authtype = nil, use_tls = false,
+                  &block) # :yield: smtp
+    new(address, port).start(helo, user, secret, authtype, use_tls, &block)
+  end
+
+  alias tls_old_start start
+
+  def start( helo = 'localhost.localdomain',
+             user = nil, secret = nil, authtype = nil, use_tls = false ) # :yield: smtp
+    start_method = use_tls ? :do_tls_start : :do_start
+    if block_given?
+      begin
+        send start_method, helo, user, secret, authtype
+        return yield(self)
+      ensure
+        do_finish
+      end
+    else
+      send start_method, helo, user, secret, authtype
+      return self
+    end
+  end
+
+  private
+
+  def do_tls_start(helodomain, user, secret, authtype)
+    raise IOError, 'SMTP session already started' if @started
+    check_auth_args user, secret, authtype if user or secret
+
+    sock = timeout(@open_timeout) { TCPSocket.open(@address, @port) }
+    @socket = Net::InternetMessageIO.new(sock)
+    @socket.read_timeout = 60 #@read_timeout
+    @socket.debug_output = STDERR #@debug_output
+
+    check_response(critical { recv_response() })
+    do_helo(helodomain)
+
+    raise 'openssl library not installed' unless defined?(OpenSSL)
+    starttls
+    ssl = OpenSSL::SSL::SSLSocket.new(sock)
+    ssl.sync_close = true
+    ssl.connect
+    @socket = Net::InternetMessageIO.new(ssl)
+    @socket.read_timeout = 60 #@read_timeout
+    @socket.debug_output = STDERR #@debug_output
+    do_helo(helodomain)
+
+    authenticate user, secret, authtype if user
+    @started = true
+  ensure
+    unless @started
+      # authentication failed, cancel connection.
+        @socket.close if not @started and @socket and not @socket.closed?
+      @socket = nil
+    end
+  end
+
+  def do_helo(helodomain)
+     begin
+      if @esmtp
+        ehlo helodomain
+      else
+        helo helodomain
+      end
+    rescue Net::ProtocolError
+      if @esmtp
+        @esmtp = false
+        @error_occured = false
+        retry
+      end
+      raise
+    end
+  end
+
+  def starttls
+    getok('STARTTLS')
+  end
+
+  alias tls_old_quit quit
+
+  def quit
+    begin
+      getok('QUIT')
+    rescue EOFError
+    end
+  end
+
+end unless Net::SMTP.private_method_defined? :do_tls_start or
+           Net::SMTP.method_defined? :tls?

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: prioritized_ar_mailer_rails3
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 12
+  version: 2.1.12
+platform: ruby
+authors: 
+- Gaurav Soni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-21 00:00:00 +05:30
+default_executable: ar_sendmail_rails3
+dependencies: []
+
+description: ArMailer wrapper for Rails 3 with mail priority
+email: raveformails@gmail.com
+executables: 
+- ar_sendmail_rails3
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/ar_sendmail_rails3
+- lib/ar_mailer_rails3.rb
+- lib/ar_mailer_rails3/active_record.rb
+- lib/ar_mailer_rails3/ar_sendmail.rb
+- lib/generators/ar_mailer_rails3/ar_mailer_rails3_generator.rb
+- lib/generators/ar_mailer_rails3/templates/ar_mailer.rb
+- lib/generators/ar_mailer_rails3/templates/migration.rb
+- lib/generators/ar_mailer_rails3/templates/model.rb
+- lib/smtp_tls.rb
+has_rdoc: true
+homepage: https://github.com/gsoni-ror/ar_mailer_rails3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ArMailer wrapper for Rails 3 with mail priority
+test_files: []
+