Class: ActionMailer::ARSendmail

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

Constant Summary collapse

VERSION =

The version of ActionMailer::ARSendmail you are running.

'2.1.8'
MAX_AUTH_FAILURES =

Maximum number of times authentication will be consecutively retried

2
@@pid_file = 
nil

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

:Once

Only attempt to deliver emails once when run is called

:Verbose

Be verbose.



330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/action_mailer/ar_sendmail.rb', line 330

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

Instance Attribute Details

#batch_size ⇒ Object

Email delivery attempts per run



55
56
57
 
# File 'lib/action_mailer/ar_sendmail.rb', line 55

def batch_size
  @batch_size
end

#delay ⇒ Object

Seconds to delay between runs



60
61
62
 
# File 'lib/action_mailer/ar_sendmail.rb', line 60

def delay
  @delay
end

#failed_auth_count ⇒ Object

Times authentication has failed



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

def failed_auth_count
  @failed_auth_count
end

#max_age ⇒ Object

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



65
66
67
 
# File 'lib/action_mailer/ar_sendmail.rb', line 65

def max_age
  @max_age
end

#once ⇒ Object (readonly)

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



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

def once
  @once
end

#verbose ⇒ Object

Be verbose



70
71
72
 
# File 'lib/action_mailer/ar_sendmail.rb', line 70

def verbose
  @verbose
end

Class Method Details

.mailq ⇒ 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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/action_mailer/ar_sendmail.rb', line 100

def self.mailq
  emails = ActionMailer::Base.email_class.find :all

  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



140
141
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
179
180
181
182
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
 
# File 'lib/action_mailer/ar_sendmail.rb', line 140

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 'config/environment'
      require 'action_mailer/ar_mailer'
    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

.remove_pid_file ⇒ Object 



85
86
87
88
89
90
91
 
# File 'lib/action_mailer/ar_sendmail.rb', line 85

def self.remove_pid_file
  if @@pid_file
    require 'shell'
    sh = Shell.new
    sh.rm @@pid_file
  end
end

.run(args = ARGV) ⇒ Object

Processes args and runs as appropriate



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
 
# File 'lib/action_mailer/ar_sendmail.rb', line 268

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

.usage(opts, message = nil) ⇒ Object

Prints a usage message to $stderr using opts and exits



311
312
313
314
315
316
317
318
319
 
# File 'lib/action_mailer/ar_sendmail.rb', line 311

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.



347
348
349
350
351
352
353
354
 
# File 'lib/action_mailer/ar_sendmail.rb', line 347

def cleanup
  return if @max_age == 0
  timeout = Time.now - @max_age
  conditions = ['last_send_attempt > 0 and created_on < ?', timeout]
  mail = ActionMailer::Base.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.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/action_mailer/ar_sendmail.rb', line 359

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

#do_exit ⇒ Object

Prepares ar_sendmail for exiting



416
417
418
419
420
 
# File 'lib/action_mailer/ar_sendmail.rb', line 416

def do_exit
  log "caught signal, shutting down"
  self.class.remove_pid_file
  exit 130
end

#find_emails ⇒ Object

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



426
427
428
429
430
431
432
433
 
# File 'lib/action_mailer/ar_sendmail.rb', line 426

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

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

#install_signal_handlers ⇒ Object

Installs signal handlers to gracefully exit.



438
439
440
441
 
# File 'lib/action_mailer/ar_sendmail.rb', line 438

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

#log(message) ⇒ Object

Logs message if verbose



446
447
448
449
 
# File 'lib/action_mailer/ar_sendmail.rb', line 446

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.



455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/action_mailer/ar_sendmail.rb', line 455

def run
  install_signal_handlers

  loop do
    begin
      cleanup
      emails = find_emails
      deliver(emails) unless emails.empty?
    rescue ActiveRecord::Transactions::TransactionError
    end
    break if @once
    sleep @delay
  end
end

#smtp_settings ⇒ Object

Either settings loaded from smtp settings file or 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.



479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/action_mailer/ar_sendmail.rb', line 479

def smtp_settings
  @smtp_settings ||= begin
    if File.exists?(ActionMailer::Base.smtp_settings_path)
      config = YAML::load_file(ActionMailer::Base.smtp_settings_path)
      config = (config.has_key?(Rails.env) ? config[Rails.env] : config).with_indifferent_access
      config[:authentication] = config[:authentication].to_sym if config[:authentication]
      config
    else
      ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
    end
  end
end