aboutsummaryrefslogtreecommitdiffstats
path: root/guides
diff options
context:
space:
mode:
authorGannon McGibbon <gannon.mcgibbon@gmail.com>2018-10-23 18:09:57 -0400
committerGitHub <noreply@github.com>2018-10-23 18:09:57 -0400
commit3081a54ee39ebc837799eb2d35d879a8de248926 (patch)
tree5a2b7c51577f7ef63be2d1d06d9a72a693f1c37f /guides
parent8cdb5df7c5c966495730587470295ac2ab3ce7fc (diff)
parent06ab7bb729f83bb5fbf0733baff1c0053b99d105 (diff)
downloadrails-3081a54ee39ebc837799eb2d35d879a8de248926.tar.gz
rails-3081a54ee39ebc837799eb2d35d879a8de248926.tar.bz2
rails-3081a54ee39ebc837799eb2d35d879a8de248926.zip
Merge pull request #34080 from baerjam/add-email-observer-to-guides
Add observing emails to action mailer guide [ci skip]
Diffstat (limited to 'guides')
-rw-r--r--guides/source/action_mailer_basics.md29
1 files changed, 24 insertions, 5 deletions
diff --git a/guides/source/action_mailer_basics.md b/guides/source/action_mailer_basics.md
index 041a427f7c..1acb993cad 100644
--- a/guides/source/action_mailer_basics.md
+++ b/guides/source/action_mailer_basics.md
@@ -839,13 +839,14 @@ Mailer Testing
You can find detailed instructions on how to test your mailers in the
[testing guide](testing.html#testing-your-mailers).
-Intercepting Emails
+Intercepting and Observing Emails
-------------------
-There are situations where you need to edit an email before it's
-delivered. Fortunately Action Mailer provides hooks to intercept every
-email. You can register an interceptor to make modifications to mail messages
-right before they are handed to the delivery agents.
+Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to register classes that are called during the mail delivery life cycle of every email sent.
+
+### Intercepting Emails
+
+Interceptors allow you to make modifications to emails before they are handed off to the delivery agents. An interceptor class must implement the `:delivering_email(message)` method which will be called before the email is sent.
```ruby
class SandboxEmailInterceptor
@@ -869,3 +870,21 @@ NOTE: The example above uses a custom environment called "staging" for a
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.
+
+### 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.
+
+```ruby
+class EmailDeliveryObserver
+ def self.delivered_email(message)
+ EmailDelivery.log(message)
+ end
+end
+```
+Like interceptors, you need to register observers with the Action Mailer framework. You can do this in an initializer file
+`config/initializers/email_delivery_observer.rb`
+
+```ruby
+ActionMailer::Base.register_observer(EmailDeliveryObserver)
+```