Class: ActionMailer::ARSendmail

Inherits:
Object
  • Object
show all
Defined in:
lib/action_mailer/ar_sendmail.rb

Overview

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

  • –create-migration

  • –create-model

  • –table-name

Constant Summary collapse

VERSION =

The version of ActionMailer::ARSendmail you are running.

'1.3.2'
MAX_AUTH_FAILURES =

Maximum number of times authentication will be consecutively retried

2

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ARSendmail

Creates a new ARSendmail.

Valid options are:

:BatchSize

Maximum number of emails to send per delay

:Delay

Delay between deliver attempts

:TableName

Table name that stores the emails

:Once

Only attempt to deliver emails once when run is called

:Verbose

Be verbose.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/action_mailer/ar_sendmail.rb', line 376

def initialize(options = {})
  options[:Delay] ||= 60
  options[:TableName] ||= 'Email'
  options[:MaxAge] ||= 86400 * 7

  @batch_size = options[:BatchSize]
  @delay = options[:Delay]
  @email_class = Object.path2class options[:TableName]
  @once = options[:Once]
  @verbose = options[:Verbose]
  @max_age = options[:MaxAge]

  @failed_auth_count = 0
end

Instance Attribute Details

#batch_size ⇒ Object

Email delivery attempts per run



67
68
69
 
# File 'lib/action_mailer/ar_sendmail.rb', line 67

def batch_size
  @batch_size
end

#delay ⇒ Object

Seconds to delay between runs



72
73
74
 
# File 'lib/action_mailer/ar_sendmail.rb', line 72

def delay
  @delay
end

#email_class ⇒ Object (readonly)

ActiveRecord class that holds emails



87
88
89
 
# File 'lib/action_mailer/ar_sendmail.rb', line 87

def email_class
  @email_class
end

#failed_auth_count ⇒ Object

Times authentication has failed



97
98
99
 
# File 'lib/action_mailer/ar_sendmail.rb', line 97

def failed_auth_count
  @failed_auth_count
end

#max_age ⇒ Object

Maximum age of emails in seconds before they are removed from the queue.



77
78
79
 
# File 'lib/action_mailer/ar_sendmail.rb', line 77

def max_age
  @max_age
end

#once ⇒ Object (readonly)

True if only one delivery attempt will be made per call to run



92
93
94
 
# File 'lib/action_mailer/ar_sendmail.rb', line 92

def once
  @once
end

#verbose ⇒ Object

Be verbose



82
83
84
 
# File 'lib/action_mailer/ar_sendmail.rb', line 82

def verbose
  @verbose
end

Class Method Details

.create_migration(table_name) ⇒ Object

Creates a new migration using table_name and prints it on stdout.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/action_mailer/ar_sendmail.rb', line 102

def self.create_migration(table_name)
  require 'active_support'
  puts <<-EOF
class Add#{table_name.classify} < ActiveRecord::Migration
def self.up
  create_table :#{table_name.tableize} do |t|
    t.column :from, :string
    t.column :to, :string
    t.column :last_send_attempt, :integer, :default => 0
    t.column :deliver_after, :datetime
    t.column :mail, :text
    t.column :created_on, :datetime
  end
end

def self.down
  drop_table :#{table_name.tableize}
end
end
  EOF
end

.create_model(table_name) ⇒ Object

Creates a new model using table_name and prints it on stdout.



127
128
129
130
131
132
133
 
# File 'lib/action_mailer/ar_sendmail.rb', line 127

def self.create_model(table_name)
  require 'active_support'
  puts <<-EOF
class #{table_name.classify} < ActiveRecord::Base
end
  EOF
end

.mailq(table_name) ⇒ Object

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 api.rubyonrails.org/classes/ActiveRecord/Timestamp.html to learn how to enable ActiveRecord::Timestamp.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/action_mailer/ar_sendmail.rb', line 142

def self.mailq(table_name)
  klass = table_name.split('::').inject(Object) { |k,n| k.const_get n }
  emails = klass.find :all, :conditions => ["deliver_after > ?", Time.now]

  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

.process_args(args) ⇒ Object

Processes command line options in args



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/action_mailer/ar_sendmail.rb', line 183

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[:TableName] = 'Email'

  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(      "--mailq",
            "Display a list of emails waiting to be sent") do |mailq|
      options[:MailQ] = true
    end

    opts.separator ''
    opts.separator 'Setup Options:'

    opts.on(      "--create-migration",
            "Prints a migration to add an Email table",
            "to stdout") do |create|
      options[:Migrate] = true
    end

    opts.on(      "--create-model",
            "Prints a model for an Email ActiveRecord",
            "object to stdout") do |create|
      options[:Model] = true
    end

    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("-t", "--table-name TABLE_NAME",
            "Name of table holding emails",
            "Used for both sendmail and",
            "migration creation",
            "Default: #{options[:TableName]}") do |name|
      options[:TableName] = name
    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.separator ''
  end

  opts.parse! args

  return options if options.include? :Migrate or options.include? :Model

  ENV['RAILS_ENV'] = options[:RailsEnv]

  Dir.chdir options[:Chdir] do
    begin
      require 'config/environment'
    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

.run(args = ARGV) ⇒ Object

Processes args and runs as appropriate



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/action_mailer/ar_sendmail.rb', line 322

def self.run(args = ARGV)
  options = process_args args

  if options.include? :Migrate then
    create_migration options[:TableName]
    exit
  elsif options.include? :Model then
    create_model options[:TableName]
    exit
  elsif options.include? :MailQ then
    mailq options[:TableName]
    exit
  end

  if options[:Daemon] then
    require 'webrick/server'
    WEBrick::Daemon.start
  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 1
end

.usage(opts, message = nil) ⇒ Object

Prints a usage message to $stderr using opts and exits



356
357
358
359
360
361
362
363
364
 
# File 'lib/action_mailer/ar_sendmail.rb', line 356

def self.usage(opts, message = nil)
  if message then
    $stderr.puts message
    $stderr.puts
  end

  $stderr.puts opts
  exit 1
end

Instance Method Details

#cleanup ⇒ Object

Removes emails that have lived in the queue for too long. If max_age is set to 0, no emails will be removed.



395
396
397
398
399
400
401
402
 
# File 'lib/action_mailer/ar_sendmail.rb', line 395

def cleanup
  return if @max_age == 0
  timeout = Time.now - @max_age
  conditions = ['last_send_attempt > 0 and created_on < ?', timeout]
  mail = @email_class.destroy_all conditions

  log "expired #{mail.length} emails from the queue"
end

#deliver(emails) ⇒ Object

Delivers emails to ActionMailer’s SMTP server and destroys them.



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/action_mailer/ar_sendmail.rb', line 407

def deliver(emails)
  user = smtp_settings[:user] || smtp_settings[:user_name]
  Net::SMTP.start smtp_settings[:address], smtp_settings[:port],
                  smtp_settings[:domain], user,
                  smtp_settings[:password],
                  smtp_settings[:authentication],
                  smtp_settings[:tls] do |smtp|
    @failed_auth_count = 0
    until emails.empty? do
      email = emails.shift
      begin
        res = smtp.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
        smtp.reset
      rescue Net::SMTPServerBusy => e
        log "server too busy, sleeping #{@delay} seconds"
        sleep delay
        return
      rescue Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError => 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")]
        smtp.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

#do_exit ⇒ Object

Prepares ar_sendmail for exiting



456
457
458
459
 
# File 'lib/action_mailer/ar_sendmail.rb', line 456

def do_exit
  log "caught signal, shutting down"
  exit
end

#find_emails ⇒ Object

Returns emails in email_class that haven’t had a delivery attempt in the last 300 seconds.



465
466
467
468
469
470
471
472
 
# File 'lib/action_mailer/ar_sendmail.rb', line 465

def find_emails
  options = { :conditions => ['last_send_attempt < ? and deliver_after > ?', Time.now.to_i - 300, Time.now] }
  options[:limit] = batch_size unless batch_size.nil?
  mail = @email_class.find :all, options

  log "found #{mail.length} emails to send"
  mail
end

#install_signal_handlers ⇒ Object

Installs signal handlers to gracefully exit.



477
478
479
480
 
# File 'lib/action_mailer/ar_sendmail.rb', line 477

def install_signal_handlers
  trap 'TERM' do do_exit end
  trap 'INT'  do do_exit end
end

#log(message) ⇒ Object

Logs message if verbose



485
486
487
488
 
# File 'lib/action_mailer/ar_sendmail.rb', line 485

def log(message)
  $stderr.puts message if @verbose
  ActionMailer::Base.logger.info "ar_sendmail: #{message}"
end

#run ⇒ Object

Scans for emails and delivers them every delay seconds. Only returns if once is true.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/action_mailer/ar_sendmail.rb', line 494

def run
  install_signal_handlers

  loop do
    now = Time.now
    begin
      cleanup
      deliver find_emails
    rescue ActiveRecord::Transactions::TransactionError
    end
    break if @once
    sleep @delay if now + @delay > Time.now
  end
end

#smtp_settings ⇒ Object

Proxy to ActionMailer::Base::smtp_settings. See 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.



517
518
519
 
# File 'lib/action_mailer/ar_sendmail.rb', line 517

def smtp_settings
  ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
end