Skip to content

Commit 4d2eeaf

Browse files
committed
Update Action Mailer's deliver_later_queue_name documentation with current defaults
Since Rails 6.1, the default configuration has been to use Active Job's default queue, achieved by setting the queue name to `nil`. Refs: - rails#47408 - rails#47408 (comment)
1 parent c15093c commit 4d2eeaf

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

actionmailer/lib/action_mailer/base.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ module ActionMailer
464464
# custom delivery job. Defaults to +ActionMailer::MailDeliveryJob+.
465465
#
466466
# * <tt>deliver_later_queue_name</tt> - The queue name used by <tt>deliver_later</tt> with the default
467-
# <tt>delivery_job</tt>. Mailers can set this to use a custom queue. Defaults to <tt>:mailers</tt>.
467+
# <tt>delivery_job</tt>. Mailers can set this to use a custom queue name.
468468
class Base < AbstractController::Base
469469
include DeliveryMethods
470470
include QueuedDelivery

actionmailer/lib/action_mailer/message_delivery.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def processed?
6363
# * <tt>:priority</tt> - Enqueues the email with the specified priority
6464
#
6565
# By default, the email will be enqueued using <tt>ActionMailer::MailDeliveryJob</tt> on
66-
# the +:mailers+ queue. Mailer classes can customize the queue name used for the default
66+
# the default queue. Mailer classes can customize the queue name used for the default
6767
# job by assigning a +deliver_later_queue_name+ class variable, or provide a custom job
6868
# by assigning a +delivery_job+. When a custom job is used, it controls the queue name.
6969
#
@@ -90,7 +90,7 @@ def deliver_later!(options = {})
9090
# * <tt>:priority</tt> - Enqueues the email with the specified priority
9191
#
9292
# By default, the email will be enqueued using <tt>ActionMailer::MailDeliveryJob</tt> on
93-
# the +:mailers+ queue. Mailer classes can customize the queue name used for the default
93+
# the default queue. Mailer classes can customize the queue name used for the default
9494
# job by assigning a +deliver_later_queue_name+ class variable, or provide a custom job
9595
# by assigning a +delivery_job+. When a custom job is used, it controls the queue name.
9696
#

guides/source/action_mailer_basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ files (environment.rb, production.rb, etc...)
818818
|`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`.|
819819
|`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.|
820820
|`delivery_job`|The job class used with `deliver_later`. Defaults to `ActionMailer::MailDeliveryJob`.|
821-
|`deliver_later_queue_name`|The name of the queue used with the default `delivery_job`. Defaults to `:mailers`|
821+
|`deliver_later_queue_name`|The name of the queue used with the default `delivery_job`. Defaults to the default Active Job queue.|
822822
|`default_options`|Allows you to set default values for the `mail` method options (`:from`, `:reply_to`, etc.).|
823823

824824
For a complete writeup of possible configurations see the

0 commit comments

Comments
 (0)