aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYves Senn <yves.senn@gmail.com>2013-01-16 20:17:35 +0100
committerYves Senn <yves.senn@gmail.com>2013-01-16 20:51:04 +0100
commita7772405dc900f0660404381faa5007b5f0f0d23 (patch)
tree411e4ad64fad3b86d11cf5e260d769a573903f8b
parent555cb0afb5a8a8e98fc982edb9e09dfaafd46380 (diff)
downloadrails-a7772405dc900f0660404381faa5007b5f0f0d23.tar.gz
rails-a7772405dc900f0660404381faa5007b5f0f0d23.tar.bz2
rails-a7772405dc900f0660404381faa5007b5f0f0d23.zip
document Intercepters in ActionMailer guide
-rw-r--r--guides/source/action_mailer_basics.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/guides/source/action_mailer_basics.md b/guides/source/action_mailer_basics.md
index 7c6ef52f4a..7f992025e4 100644
--- a/guides/source/action_mailer_basics.md
+++ b/guides/source/action_mailer_basics.md
@@ -575,3 +575,23 @@ end
```
In the test we send the email and store the returned object in the `email` variable. We then ensure that it was sent (the first assert), then, in the second batch of assertions, we ensure that the email does indeed contain what we expect.
+
+Intercepting 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.
+
+```ruby
+class SandboxEmailInterceptor
+ def self.delivering_email(message)
+ message.to = ['sandbox@example.com']
+ end
+end
+```
+
+Before the Interceptor can do it's job you need to register it with the Action Mailer framework. You can do this in an initializer file `config/initializers/sandbox_email_interceptor.rb`
+
+```ruby
+ActionMailer::Base.register_interceptor(SandboxEmailInterceptor) if Rails.env.staging?
+```
+
+NOTE: The example above uses a custom environment called "staging" for a production like server but for testing purposes.