W3cubDocs

class ActionMailer::MessageDelivery

Parent:: Delegator

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

Public Instance Methods

deliver_later(options = {}) Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 98
def deliver_later(options = {})
  enqueue_delivery :deliver_now, options
end

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

deliver_later!(options = {}) Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 72
def deliver_later!(options = {})
  enqueue_delivery :deliver_now!, options
end

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

deliver_now() Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 117
def deliver_now
  processed_mailer.handle_exceptions do
    message.deliver
  end
end

Delivers an email:

Notifier.welcome(User.first).deliver_now

deliver_now!() Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 107
def deliver_now!
  processed_mailer.handle_exceptions do
    message.deliver!
  end
end

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

Notifier.welcome(User.first).deliver_now!

message() Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 39
def message
  __getobj__
end

Returns the resulting Mail::Message

processed?() Show source

# File actionmailer/lib/action_mailer/message_delivery.rb, line 44
def processed?
  @processed_mailer || @mail_message
end

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