Class: ActionMailer::MessageDelivery

Inherits:
Delegator show all
Defined in:
actionmailer/lib/action_mailer/message_delivery.rb

Overview

The ActionMailer::MessageDelivery class is used by ActionMailer::Base when creating a new mailer. MessageDelivery is a wrapper (Delegator subclass) around a lazy created Mail::Message. You can get direct access to the Mail::Message, deliver the email or schedule the email to be sent through Active Job.

Notifier.welcome(User.first)               # an ActionMailer::MessageDelivery object
Notifier.welcome(User.first).deliver_now   # sends the email
Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job
Notifier.welcome(User.first).message       # a Mail::Message object

Direct Known Subclasses

Parameterized::MessageDelivery

Instance Method Summary collapse

Methods included from ActiveSupport::Tryable

#try, #try!

Constructor Details

#initialize(mailer_class, action, *args) ⇒ MessageDelivery

:nodoc:


18
19
20
21
22
23
24
25
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 18

def initialize(mailer_class, action, *args) #:nodoc:
  @mailer_class, @action, @args = mailer_class, action, args

  # The mail is only processed if we try to call any methods on it.
  # Typical usage will leave it unloaded and call deliver_later.
  @processed_mailer = nil
  @mail_message = nil
end

Instance Method Details

#__getobj__Object

Method calls are delegated to the Mail::Message that's ready to deliver.


28
29
30
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 28

def __getobj__ #:nodoc:
  @mail_message ||= processed_mailer.message
end

#__setobj__(mail_message) ⇒ Object

Unused except for delegator internals (dup, marshalling).


33
34
35
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 33

def __setobj__(mail_message) #:nodoc:
  @mail_message = mail_message
end

#deliver_later(options = {}) ⇒ Object

Enqueues the email to be delivered through Active Job. When the job runs it will send the email using deliver_now.

Notifier.welcome(User.first).deliver_later
Notifier.welcome(User.first).deliver_later(wait: 1.hour)
Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)

Options:

  • :wait - Enqueue the email to be delivered with a delay.

  • :wait_until - Enqueue the email to be delivered at (after) a specific date / time.

  • :queue - Enqueue the email on the specified queue.

By default, the email will be enqueued using ActionMailer::DeliveryJob. Each ActionMailer::Base class can specify the job to use by setting the class variable delivery_job.

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end

93
94
95
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 93

def deliver_later(options = {})
  enqueue_delivery :deliver_now, options
end

#deliver_later!(options = {}) ⇒ Object

Enqueues the email to be delivered through Active Job. When the job runs it will send the email using deliver_now!. That means that the message will be sent bypassing checking perform_deliveries and raise_delivery_errors, so use with caution.

Notifier.welcome(User.first).deliver_later!
Notifier.welcome(User.first).deliver_later!(wait: 1.hour)
Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)

Options:

  • :wait - Enqueue the email to be delivered with a delay

  • :wait_until - Enqueue the email to be delivered at (after) a specific date / time

  • :queue - Enqueue the email on the specified queue

By default, the email will be enqueued using ActionMailer::DeliveryJob. Each ActionMailer::Base class can specify the job to use by setting the class variable delivery_job.

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end

69
70
71
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 69

def deliver_later!(options = {})
  enqueue_delivery :deliver_now!, options
end

#deliver_nowObject

Delivers an email:

Notifier.welcome(User.first).deliver_now

112
113
114
115
116
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 112

def deliver_now
  processed_mailer.handle_exceptions do
    message.deliver
  end
end

#deliver_now!Object

Delivers an email without checking perform_deliveries and raise_delivery_errors, so use with caution.

Notifier.welcome(User.first).deliver_now!

102
103
104
105
106
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 102

def deliver_now!
  processed_mailer.handle_exceptions do
    message.deliver!
  end
end

#messageObject

Returns the resulting Mail::Message


38
39
40
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 38

def message
  __getobj__
end

#processed?Boolean

Was the delegate loaded, causing the mailer action to be processed?

Returns:

  • (Boolean)

43
44
45
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 43

def processed?
  @processed_mailer || @mail_message
end