ActionMailer::MessageDelivery (original) (raw)
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
Methods
D
M
P
Instance Public methods
deliver_later(options = {})Link
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
def deliver_later(options = {}) enqueue_delivery :deliver_now, options end
deliver_later!(options = {})Link
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
def deliver_later!(options = {}) enqueue_delivery :deliver_now!, options end
deliver_now()Link
Delivers an email:
Notifier.welcome(User.first).deliver_now
def deliver_now processed_mailer.handle_exceptions do processed_mailer.run_callbacks(:deliver) do message.deliver end end end
deliver_now!()Link
Delivers an email without checking perform_deliveries and raise_delivery_errors, so use with caution.
Notifier.welcome(User.first).deliver_now!
def deliver_now! processed_mailer.handle_exceptions do processed_mailer.run_callbacks(:deliver) do message.deliver! end end end
processed?()Link
Was the delegate loaded, causing the mailer action to be processed?
def processed? @processed_mailer || @mail_message end