Skip to content

Commit 603631b

Browse files
authored
Merge pull request rails#43560 from c960657/action-mailer-docs
ActionMailer: Document delivery_job and deliver_later_queue_name
2 parents 9f98066 + 9a2cbb1 commit 603631b

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

actionmailer/lib/action_mailer/base.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,9 @@ module ActionMailer
435435
# * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
436436
# <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
437437
#
438+
# * <tt>delivery_job</tt> - The job class used with <tt>deliver_later</tt>. Defaults to
439+
# +ActionMailer::MailDeliveryJob+.
440+
#
438441
# * <tt>deliver_later_queue_name</tt> - The name of the queue used with <tt>deliver_later</tt>.
439442
class Base < AbstractController::Base
440443
include DeliveryMethods

guides/source/action_mailer_basics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,8 @@ files (environment.rb, production.rb, etc...)
810810
|`delivery_method`|Defines a delivery method. Possible values are:<ul><li>`:smtp` (default), can be configured by using `config.action_mailer.smtp_settings`.</li><li>`:sendmail`, can be configured by using `config.action_mailer.sendmail_settings`.</li><li>`:file`: save emails to files; can be configured by using `config.action_mailer.file_settings`.</li><li>`:test`: save emails to `ActionMailer::Base.deliveries` array.</li></ul>See [API docs](https://api.rubyonrails.org/classes/ActionMailer/Base.html) for more info.|
811811
|`perform_deliveries`|Determines whether deliveries are actually carried out when the `deliver` method is invoked on the Mail message. By default they are, but this can be turned off to help functional testing. If this value is `false`, `deliveries` array will not be populated even if `delivery_method` is `:test`.|
812812
|`deliveries`|Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful for unit and functional testing.|
813+
|`delivery_job`|The job class used with `deliver_later`. Defaults to `ActionMailer::MailDeliveryJob`.|
814+
|`deliver_later_queue_name`|The name of the queue used with `deliver_later`.|
813815
|`default_options`|Allows you to set default values for the `mail` method options (`:from`, `:reply_to`, etc.).|
814816

815817
For a complete writeup of possible configurations see the

0 commit comments

Comments
 (0)