Class: ActionMailer::MessageDelivery

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

Overview

Action Mailer MessageDelivery

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 Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

:nodoc:



54
55
56
57
58
59
60
61
 
# File 'lib/action_mailer/message_delivery.rb', line 54

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 Attribute Details

#action ⇒ Object (readonly)

:nodoc:



52
53
54
 
# File 'lib/action_mailer/message_delivery.rb', line 52

def action
  @action
end

#args ⇒ Object (readonly)

:nodoc:



52
53
54
 
# File 'lib/action_mailer/message_delivery.rb', line 52

def args
  @args
end

#mailer_class ⇒ Object (readonly)

:nodoc:



52
53
54
 
# File 'lib/action_mailer/message_delivery.rb', line 52

def mailer_class
  @mailer_class
end

#params ⇒ Object (readonly)

:nodoc:



52
53
54
 
# File 'lib/action_mailer/message_delivery.rb', line 52

def params
  @params
end

Instance Method Details

#__getobj__ ⇒ Object

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



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

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

#__setobj__(mail_message) ⇒ Object

Unused except for delegator internals (dup, marshalling).



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

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)
Notifier.welcome(User.first).deliver_later(priority: 10)

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.

  • :priority - Enqueues the email with the specified priority

By default, the email will be enqueued using ActionMailer::MailDeliveryJob on the default queue. Mailer classes can customize the queue name used for the default job by assigning a deliver_later_queue_name class variable, or provide a custom job by assigning a delivery_job. When a custom job is used, it controls the queue name.

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end



136
137
138
 
# File 'lib/action_mailer/message_delivery.rb', line 136

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)
Notifier.welcome(User.first).deliver_later!(priority: 10)

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

  • :priority - Enqueues the email with the specified priority

By default, the email will be enqueued using ActionMailer::MailDeliveryJob on the default queue. Mailer classes can customize the queue name used for the default job by assigning a deliver_later_queue_name class variable, or provide a custom job by assigning a delivery_job. When a custom job is used, it controls the queue name.

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end



109
110
111
 
# File 'lib/action_mailer/message_delivery.rb', line 109

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

#deliver_now ⇒ Object

Delivers an email:

Notifier.welcome(User.first).deliver_now



157
158
159
160
161
162
163
 
# File 'lib/action_mailer/message_delivery.rb', line 157

def deliver_now
  processed_mailer.handle_exceptions do
    processed_mailer.run_callbacks(:deliver) do
      message.deliver
    end
  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!



145
146
147
148
149
150
151
 
# File 'lib/action_mailer/message_delivery.rb', line 145

def deliver_now!
  processed_mailer.handle_exceptions do
    processed_mailer.run_callbacks(:deliver) do
      message.deliver!
    end
  end
end

#message ⇒ Object

Returns the resulting Mail::Message



75
76
77
 
# File 'lib/action_mailer/message_delivery.rb', line 75

def message
  __getobj__
end

#processed? ⇒ Boolean

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

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/action_mailer/message_delivery.rb', line 80

def processed?
  @processed_mailer || @mail_message
end