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

Instance Method Summary collapse

Methods included from ActiveSupport::Tryable

#try, #try!

Constructor Details

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

:nodoc:


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

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.


26
27
28
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 26

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

#__setobj__(mail_message) ⇒ Object

Unused except for delegator internals (dup, marshaling).


31
32
33
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 31

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.


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

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


59
60
61
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 59

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

#deliver_nowObject

Delivers an email:

Notifier.welcome(User.first).deliver_now

94
95
96
97
98
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 94

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!

84
85
86
87
88
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 84

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

#messageObject

Returns the resulting Mail::Message


36
37
38
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 36

def message
  __getobj__
end

#processed?Boolean

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

Returns:

  • (Boolean)

41
42
43
# File 'actionmailer/lib/action_mailer/message_delivery.rb', line 41

def processed?
  @processed_mailer || @mail_message
end