Spec-Zone.ru › Ruby on Rails 7.1

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 = {}) Show source
# 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 = {}) Show source
# 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 - Поместить электронное письмо в очередь с указанным приоритетом

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

class AccountRegistrationMailer < ApplicationMailer
  self.delivery_job = RegistrationDeliveryJob
end
deliver_now() Show source
# 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!() Show source
# 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() Show source
# File actionmailer/lib/action_mailer/message_delivery.rb, line 41
def message
  __getobj__
end

Возвращает результирующий Mail::Message

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

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

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API