diff options
author | Vijay Dev <vijaydev.cse@gmail.com> | 2012-12-01 11:26:39 -0800 |
---|---|---|
committer | Vijay Dev <vijaydev.cse@gmail.com> | 2012-12-01 11:26:39 -0800 |
commit | 583cc11dd75676665e1d106541979d94864ee663 (patch) | |
tree | 50222046411558913e8b30a2a3d6347744eec650 /guides/source | |
parent | 4eca91243dbe717e5a459750df8c49e8f4ed4f65 (diff) | |
parent | 193c31c9a65eb4de29391509a1a7af7c31a5730f (diff) | |
download | rails-583cc11dd75676665e1d106541979d94864ee663.tar.gz rails-583cc11dd75676665e1d106541979d94864ee663.tar.bz2 rails-583cc11dd75676665e1d106541979d94864ee663.zip |
Merge pull request #8382 from asanghi/mailerguide
Add Mailer Callback section to Mailer guides
Diffstat (limited to 'guides/source')
-rw-r--r-- | guides/source/action_mailer_basics.md | 53 |
1 files changed, 52 insertions, 1 deletions
diff --git a/guides/source/action_mailer_basics.md b/guides/source/action_mailer_basics.md index 83cb5e5a3f..ddb0e438c9 100644 --- a/guides/source/action_mailer_basics.md +++ b/guides/source/action_mailer_basics.md @@ -397,7 +397,7 @@ end The above will send a multipart email with an attachment, properly nested with the top level being `multipart/mixed` and the first part being a `multipart/alternative` containing the plain text and HTML email messages. -#### Sending Emails with Dynamic Delivery Options +### Sending Emails with Dynamic Delivery Options If you wish to override the default delivery options (e.g. SMTP credentials) while delivering emails, you can do this using `delivery_method_options` in the mailer action. @@ -444,6 +444,57 @@ class UserMailer < ActionMailer::Base end ``` +Action Mailer Callbacks +--------------------------- + +Action Mailer allows for you to specify a `before_filter`, `after_filter` and 'around_filter'. + +* Filters can be specified with a block or a symbol to a method in the mailer class similar to controllers. + +* You could use a `before_filter` to prepopulate the mail object with defaults, delivery_method_options or insert default headers and attachments. + +* You could use an `after_filter` to do similar setup as a `before_filter` but using instance variables set in your mailer action. + +```ruby +class UserMailer < ActionMailer::Base + after_filter :set_delivery_options, :prevent_delivery_to_guests, :set_business_headers + + def feedback_message(business, user) + @business = business + @user = user + mail + end + + def campaign_message(business, user) + @business = business + @user = user + end + + private + + def set_delivery_options + # You have access to the mail instance and @business and @user instance variables here + if @business && @business.has_smtp_settings? + mail.delivery_method.settings.merge!(@business.smtp_settings) + end + end + + def prevent_delivery_to_guests + if @user && @user.guest? + mail.perform_deliveries = false + end + end + + def set_business_headers + if @business + headers["X-SMTPAPI-CATEGORY"] = @business.code + end + end +end +``` + +* Mailer Filters abort further processing if body is set to a non-nil value. + Using Action Mailer Helpers --------------------------- |