kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Update how to configure Action Mailer interceptors/observers

Browse source 
[ci skip]

Fixes #42170
This commit is contained in:
Andrew White 2021-05-08 09:26:24 +01:00
parent 70b6cee5fd
commit acbecc4ad2
No known key found for this signature in database
GPG key ID: 7E83729F16B086CF
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
guides/source/action_mailer_basics.md
View file

@ -877,13 +877,14 @@ class SandboxEmailInterceptor
end
```
Before the interceptor can do its job you need to register it using
[`register_interceptor`][]. You can do this in an initializer file like
`config/initializers/sandbox_email_interceptor.rb`:
Before the interceptor can do its job you need to register it using the `interceptors` config option.
You can do this in an initializer file like `config/initializers/mail_interceptors.rb`:
```ruby
if Rails.env.staging?
ActionMailer::Base.register_interceptor(SandboxEmailInterceptor)
Rails.application.configure do
if Rails.env.staging?
config.action_mailer.interceptors = %w[SandboxEmailInterceptor]
end
end
```
@ -892,8 +893,6 @@ production like server but for testing purposes. You can read
[Creating Rails Environments](configuring.html#creating-rails-environments)
for more information about custom Rails environments.
[`register_interceptor`]: https://api.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_interceptor
### Observing Emails
Observers give you access to the email message after it has been sent. An observer class must implement the `:delivered_email(message)` method, which will be called after the email is sent.
@ -906,11 +905,11 @@ class EmailDeliveryObserver
end
```
Similar to interceptors, you must register observers using [`register_observer`][]. You can do this in an initializer file
like `config/initializers/email_delivery_observer.rb`:
Similar to interceptors, you must register observers using the `observers` config option.
You can do this in an initializer file like `config/initializers/mail_observers.rb`:
```ruby
ActionMailer::Base.register_observer(EmailDeliveryObserver)
Rails.application.configure do
config.action_mailer.observers = %w[EmailDeliveryObserver]
end
```
[`register_observer`]: https://api.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_observer