MailInterceptor

This gem intercepts and forwards email to a forwarding address in non-production environment. However it also provides ability to not intercept certain emails so that testing of emails is easier in development/staging environment.

If subject_prefix is supplied then that is added to every single email in both production and non-production environment.

Installation

Add this line to your application's Gemfile:

gem 'mail_interceptor'

Usage

# config/initializer/mail_interceptor.rb

options = { forward_emails_to: '[email protected]',
            deliver_emails_to: ["@wheel.com"],
            subject_prefix: 'WHEEL' }

interceptor = MailInterceptor::Interceptor.new(options)
ActionMailer::Base.register_interceptor(interceptor)

deliver_emails_to

Passing deliver_emails_to is optional. If no "deliver_emails_to" is passed then all emails will be intercepted and forwarded in non-production environment.

Let's say that you want to actually deliver all emails having the pattern "@BigBinary.com". Here is how it can be accomplished.

MailInterceptor::Interceptor.new({ forward_emails_to: '[email protected]',
                                   deliver_emails_to: ["@bigbinary.com"] })

If you want the emails to be delivered only if the email address is [email protected] then that can be done too.

MailInterceptor::Interceptor.new({ forward_emails_to: '[email protected]',
                                   deliver_emails_to: ["[email protected]"] })

Now only [email protected] will get its emails delivered and all other emails will be intercepted and forwarded.

The regular expression is matched without case sensitive. So you can mix lowercase and uppercase and it won't matter.

subject_prefix

subject_prefix is optional. If it is supplied then it is added to the front of the subject. In non-production environment the environment name is also added.

[WHEEL] Forgot password
[WHEEL STAGING] Forgot password

forward_emails_to

This is a required field.

It takes a single email as string.

MailInterceptor::Interceptor.new({ forward_emails_to: '[email protected]' })

It can also take an array of emails in which case emails are forwarded to each of those emails in the array.