class ActionMailer::MessageDelivery

Parent:: Delegator

Action Mailer MessageDelivery

Класс ActionMailer::MessageDelivery используется классом ActionMailer::Base при создании нового мейлера. MessageDelivery является обёрткой (подклассом Delegator) вокруг лениво созданного Mail::Message. Вы можете получить прямой доступ к Mail::Message, отправить письмо или запланировать его отправку через 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

Публичные методы экземпляра

deliver_later(options = {}) Показать исходный код

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

Добавляет письмо в очередь для отправки через Active Job. При запуске задания письмо будет отправлено с помощью 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)

Параметры:

:wait - Добавить письмо в очередь с задержкой.
:wait_until - Добавить письмо в очередь для отправки в определённую дату/время.
:queue - Добавить письмо в указанную очередь.
:priority - Добавить письмо в очередь с указанным приоритетом

По умолчанию письмо будет добавлено в очередь с использованием ActionMailer::MailDeliveryJob в стандартной очереди. Классы мейлеров могут настроить имя очереди, используемой для задания по умолчанию, назначив переменную класса deliver_later_queue_name, или предоставить настраиваемое задание, назначив delivery_job. При использовании пользовательского задания, оно управляет именем очереди.

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end

deliver_later!(options = {}) Показать исходный код

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

Добавляет письмо в очередь для отправки через Active Job. При запуске задания письмо будет отправлено с помощью deliver_now!. Это означает, что сообщение будет отправлено, минуя проверку perform_deliveries и raise_delivery_errors, поэтому используйте с осторожностью.

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)

Параметры:

:wait - Добавить письмо в очередь с задержкой
:wait_until - Добавить письмо в очередь для отправки в определённую дату/время
:queue - Добавить письмо в указанную очередь
:priority - Добавить письмо в очередь с указанным приоритетом

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end

deliver_now() Показать исходный код

# File actionmailer/lib/action_mailer/message_delivery.rb, line 123
def deliver_now
  processed_mailer.handle_exceptions do
    processed_mailer.run_callbacks(:deliver) do
      message.deliver
    end
  end
end

Отправляет письмо:

Notifier.welcome(User.first).deliver_now

deliver_now!() Показать исходный код

# File actionmailer/lib/action_mailer/message_delivery.rb, line 111
def deliver_now!
  processed_mailer.handle_exceptions do
    processed_mailer.run_callbacks(:deliver) do
      message.deliver!
    end
  end
end

Отправляет письмо, минуя проверку perform_deliveries и raise_delivery_errors, поэтому используйте с осторожностью.

Notifier.welcome(User.first).deliver_now!

message() Показать исходный код

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

Возвращает полученное Mail::Message

processed?() Показать исходный код

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

Была ли загружена делегат, вызвав обработку действия мейлера?