mirrors
/
rails
mirror of https://github.com/rails/rails
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

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:
- https://github.com/rails/rails/pull/47408
- https://github.com/rails/rails/pull/47408#discussion_r1118672914
This commit is contained in:
Jeffrey Hardy 2023-02-27 12:35:11 -05:00
parent c15093c856
commit 4d2eeafa70
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
actionmailer/lib/action_mailer/base.rb
View File

@ -464,7 +464,7 @@ module ActionMailer
# custom delivery job. Defaults to +ActionMailer::MailDeliveryJob+.
#
# * <tt>deliver_later_queue_name</tt> - The queue name used by <tt>deliver_later</tt> with the default
# <tt>delivery_job</tt>. Mailers can set this to use a custom queue. Defaults to <tt>:mailers</tt>.
# <tt>delivery_job</tt>. Mailers can set this to use a custom queue name.
class Base < AbstractController::Base
include DeliveryMethods
include QueuedDelivery

4
actionmailer/lib/action_mailer/message_delivery.rb
View File

@ -63,7 +63,7 @@ module ActionMailer
# * <tt>:priority</tt> - Enqueues the email with the specified priority
#
# By default, the email will be enqueued using <tt>ActionMailer::MailDeliveryJob</tt> on
# the +:mailers+ queue. Mailer classes can customize the queue name used for the default
# 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.
#
@ -90,7 +90,7 @@ module ActionMailer
# * <tt>:priority</tt> - Enqueues the email with the specified priority
#
# By default, the email will be enqueued using <tt>ActionMailer::MailDeliveryJob</tt> on
# the +:mailers+ queue. Mailer classes can customize the queue name used for the default
# 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.
#

2
guides/source/action_mailer_basics.md
View File

@ -818,7 +818,7 @@ files (environment.rb, production.rb, etc...)
|`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`.|
|`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.|
|`delivery_job`|The job class used with `deliver_later`. Defaults to `ActionMailer::MailDeliveryJob`.|
|`deliver_later_queue_name`|The name of the queue used with the default `delivery_job`. Defaults to `:mailers`|
|`deliver_later_queue_name`|The name of the queue used with the default `delivery_job`. Defaults to the default Active Job queue.|
|`default_options`|Allows you to set default values for the `mail` method options (`:from`, `:reply_to`, etc.).|
For a complete writeup of possible configurations see the