sanitize_email

[comment]: <> ( 🔑 KEYED LINKS )

This gem allows you to override your mail delivery settings, globally or in a local context. It is like a Ruby encrusted condom for your email server, just in case it decides to have intercourse with other servers via sundry mail protocols.

Seriously though, this gem solves similar problems as the excellent mailcatcher gem, and mailcatcher solves those problems far more easily.

In addition, this gem solves problems that mailcatcher does not solve. I recommend using both!

To make an analogy, mailcatcher is akin to webmock, entirely preventing interaction with your real live mail server, while this gem allows you to effectively use your real live (production!) mail server, while intercepting and modifying recipients on the way out, so that testing emails go to safe locations.

It is a bit like using the "test" Visa credit card number 4701322211111234 with a real payment gateway.

Encryption

Making special note of this use case because it is important for companies working on HIPAA-compliant products. When you are sending emails through an encrypted email provider, e.g. Paubox, testing your email in the aforementioned mailcatcher may not be enough.

If you want to test all the way through Paubox's system, but have the email go to a safe testing account address, then this is the gem for you.

Compatibility

⚙️ Compatible with all versions of Ruby >= 2.3, plus JRuby and Truffleruby.
⚙️ Compatible with all Ruby web Frameworks (Hanami, Roda, Sinatra, Rails).
⚙️ Compatible with all versions of Rails from 3.0 - 7.1+.
⚙️ Compatible with scripted usage of Mail gem outside a web framework.
⚙️ Compatible with sendgrid-actionmailer's support for personalizations, and will override email addresses there according to the configuration.
⚙️ If this gem is not compatible with your use case, and you'd like it to be, I'd like to hear about it!

It was a slog getting (very nearly) the entire compatibility matrix working with Github Actions, appraisal, and combustion, and I'm very interested in hearing about ways to improve it!

🛞 DVCS

This project does not trust any one version control system, so it abides the principles of "Distributed Version Control Systems"

Find this project on:

Any	Of	These	DVCS
🐙hub	🧊berg	🛖hut	🧪lab

[comment]: <> ( DVCS LINKS )

	Project	bundle add sanitize_email
1️⃣	name, license, docs, standards
2️⃣	version & activity
3️⃣	maintenance & linting
4️⃣	coverage & security
5️⃣	resources
6️⃣	`...` 💖	💻 🌏

Summary

It's particularly helpful when you want to prevent the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.

compatible without Rails! Can work with just the mail gem.
compatible with Rails >= 3.0. See gem versions 1.x for older versions of Rails.
compatible with Ruby >= 2.3. See gem versions 1.x for older versions of Ruby.
compatible with any Ruby app with a mail handler that uses the register_interceptor API (a la ActionMailer and mail gems)
configure it and forget it
little configuration required
solves common problems in ruby web applications that use email
provides test helpers and spec matchers to assist with testing email content delivery

Working Locally with Production Data

Have a production site with live data
Dump the live data and securely transfer it to another machine (e.g. rync -e ssh)
Import it into a development database
Test features which send out email (registration/signup, order placement, etc.)
Emails get sent (in real-life!) but to sanitized email recipients
Verify what they look like when sent
Iterate on email content design
No risk of emailing production addresses

Re-routing Email on a Staging or QA Server

Another very important use case for me is to transparently re-route email generated from a staging or QA server to an appropriate person. For example, it's common for us to set up a staging server for a client to use to view our progress and test out new features. It's important for any email that is generated from our web application be delivered to the client's inbox so that they can review the content and ensure that it's acceptable. dotenv or direnv allows each developer to configure the local behavior specifically for them via ENV vars.

Testing Email from a Hot Production Server

If you install this gem on a production server (which I don't always do), you can load up script/console and override the to/cc/bcc on all emails for the duration of your console session. This allows you to poke and prod a live production instance, and route all email to your own inbox for inspection. The best part is that this can all be accomplished without changing a single line of your application code.

Monitoring all email sent by server to a backup account

You may want to add a BCC automatically (e.g. to [email protected]) to every email sent by your system, for customer service purposes, and this gem allows that. Note that this may not be a good idea for all systems, for many reasons, e.g security!

Using with a test suite as an alternative to the heavy email_spec

email_spec is a great gem, with awesome rspec matchers and helpers, but it has an undeclared dependency on ActionMailer. Sad face.

SanitizeEmail comes with some lightweight RspecMatchers covering most of what email_spec can do. It will help you test email functionality. It is useful when you are creating a gem to handle email features, or are writing a simple Ruby script, and don't want to pull in le Rails. SanitizeEmail has two dependencies, mail gem, and version_gem. Your Mail system just needs to conform to mail gem's register_interceptor API.

Install Like a Boss

In Gemfile:

   gem 'sanitize_email'

Then:

   bundle install

Setup with Ruby

keep scrolling for Rails, but read this for a better understanding of Magic

There are three ways SanitizeEmail can be turned on; in order of precedence they are:

Only useful for local context. Inside a method where you will be sending an email, set SanitizeEmail.force_sanitize = true just prior to delivering it. Also useful in the console.
```
SanitizeEmail.force_sanitize = true # by default it is nil
```
If SanitizeEmail seems to not be sanitizing you have probably not registered the interceptor. SanitizeEmail tries to do this for you. Note: If you are working in an environment that has a Mail or Mailer class that uses the register_interceptor API, the interceptor will already have been registered by SanitizeEmail:
```
# The gem will probably have already done this for you, but some really old versions of Rails may need you to do this manually:
Mail.register_interceptor(SanitizeEmail::Bleach)
```

Once registered, SanitizeEmail needs to be engaged:

    # in config/initializers/sanitize_email.rb
    SanitizeEmail::Config.configure { |config| config[:engage] = true }

If you don't need to compute anything, then don't use this option, go with the previous option.

SanitizeEmail::Config.configure { |config| config[:activation_proc] = proc { true } } # by default :activation_proc is false

Examples

Only allow email to a specific domain

This works by ensuring that all recipients have the "allowed" domain. In other words, none of the recipients have a domain other than the allowed domain.

    allowed_domain = "example.com"
    # NOTE: you may need to check CC and BCC also, depending on your use case...
    SanitizeEmail::Config.configure do |config|
      config[:activation_proc] =
        ->(message) do
          !Array(message.to).any? { |recipient| Mail::Address.new(recipient).domain != allowed_domain }
        end
    end

Notes

Number 1, above, is the method used by the SanitizeEmail.sanitary block. If installed but not configured, sanitize_email DOES NOTHING. Until configured the defaults leave it turned off.

Troubleshooting

IMPORTANT: You may need to setup your own register_interceptor. If sanitize_email doesn't seem to be working for you find your Mailer/Mail class and try this:

    # in config/initializers/sanitize_email.rb
    Mail.register_interceptor(SanitizeEmail::Bleach)
    SanitizeEmail::Config.configure { |config| config[:engage] = true }

If that causes an error you will know why sanitize_email doesn't work. Otherwise it will start working according to the rest of the configuration.

Setup With Rails

Create an initializer, if you are using rails, or otherwise configure:

    SanitizeEmail::Config.configure do |config|
      config[:sanitized_to] = "to@sanitize_email.org"
      config[:sanitized_cc] = "cc@sanitize_email.org"
      config[:sanitized_bcc] = "bcc@sanitize_email.org"
      # run/call whatever logic should turn sanitize_email on and off in this Proc:
      config[:activation_proc] = proc { %w(development test).include?(Rails.env) }
      config[:use_actual_email_prepended_to_subject] = true         # or false
      config[:use_actual_environment_prepended_to_subject] = true   # or false
      config[:use_actual_email_as_sanitized_user_name] = true       # or false
    end

Keep in mind, this is ruby (and possibly rails), so you can add conditionals or utilize different environment.rb files to customize these settings on a per-environment basis.

Override the override

But wait there's more:

Let's say you have a method in your model that you can call to test the signup email. You want to be able to test sending it to any user at any time... but you don't want the user to ACTUALLY get the email, even in production. A dilemma, yes? Not anymore!

To override the environment based switch use force_sanitize, which is normally nil, and ignored by default. When set to true or false it will turn sanitization on or off:

   SanitizeEmail.force_sanitize = true

When testing your email in a console, you can manipulate how email will be handled in this way.

There are also two methods that take a block and turn SanitizeEmail on or off (see section on Thread Safety below):

Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.

   SanitizeEmail.unsanitary do
     Mail.deliver do
       from "[email protected]"
       to "[email protected]" # Will actually be sent to the specified address, not sanitized
       reply_to "[email protected]"
       subject "subject"
     end
   end

Regardless of the Config settings of SanitizeEmail you can do a local override to send sanitary email in any environment. You have access to all the same configuration options in the parameter hash as you can set in the actual SanitizeEmail.configure block.

    SanitizeEmail.sanitary(sanitized_to: "[email protected]") do # these config options are merged with the globals
      Mail.deliver do
        from "[email protected]"
        to "[email protected]" # Will actually be sent to the override addresses, in this case: [email protected]
        reply_to "[email protected]"
        subject "subject"
      end
    end

Configuration Options

As used in the "Description" column below, engaged means: SanitizeEmail.activate?(message) # => true. This happens in a few different ways, and two of them are in the config below (engage and activation_proc).

Option	Type (Yard format)	Description
sanitized_to	[String, Array[String]]	(when engaged) Override CC field with these addresses
sanitized_cc	[String, Array[String]]	(when engaged) Override CC field with these addresses
sanitized_bcc	[String, Array[String]]	(when engaged) Override BCC field with these addresses
good_list	[Array[String]]	(when engaged) Email addresses to allow to pass-through without overriding
bad_list	[Array[String]]	(when engaged) Email addresses to be removed from message's TO, CC, & BCC
environment	[String, #to_s, Proc, Lambda, #call]	(when engaged) The environment value to use wherever it is added to message (e.g. in the subject line)
use_actual_email_as_sanitized_user_name	[Boolean]	(when engaged) Use "real" email address as username for sanitized email address (e.g. `"real at example.com <[email protected]>"`)
use_actual_email_prepended_to_subject	[Boolean]	(when engaged) Use "real" email address prepended to subject (e.g. `"real at example.com Original Subject"`)
use_actual_environment_prepended_to_subject	[Boolean]	(when engaged) Use `environment` prepended to subject (e.g. `"[[ STAGING ]] Original Subject"`)
engage	[Boolean, nil]	Boolean will turn engage or disengage this gem, while `nil` ignores this setting and instead checks `activation_proc`
activation_proc	[Proc, Lambda, #call]	When checked, due to `engage: nil`, the result will either engage or disengage this gem

Thread Safety

So long as you don't change the config after initializing it at runtime, you'll be fine. Like many Ruby tools' config objects, it is a single config object, shared by all threads. The helpers like sanitary, unsanitary, janitor, and force_sanitize are intended to be used in single threaded environments, like a test suite, or a console session.

I doubt I'll ever have a need for runtime reconfiguration of the config, so I doubt I'll ever have a reason to make it "more" thread safe than it is now, but PRs are welcome!

Use sanitize_email in your test suite!

rspec

In your spec_helper.rb:

   require "sanitize_email"
   # rspec matchers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
   require "sanitize_email/rspec_matchers"

   SanitizeEmail::Config.configure do |config|
     config[:sanitized_to] = "[email protected]"
     config[:sanitized_cc] = "[email protected]"
     config[:sanitized_bcc] = "[email protected]"
     # run/call whatever logic should turn sanitize_email on and off in this Proc.
     # config[:activation_proc] =      Proc.new { true }
     # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
     # Thus instead of using the Proc (slower) we just engage it always:
     config[:engage] = true
     config[:use_actual_email_prepended_to_subject] = true         # or false
     config[:use_actual_environment_prepended_to_subject] = true   # or false
     config[:use_actual_email_as_sanitized_user_name] = true       # or false
   end

   # If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail)
   # then you will need to do the equivalent for whatever Mail system you are using.

   RSpec.configure do |config|
     # ...
     # From sanitize_email gem
     config.include(SanitizeEmail::RspecMatchers)
   end

   context "an email test" do
     subject { Mail.deliver(@message_hash) }
     it { should have_to("[email protected]") }
   end

have_* matchers

These will look for an email address in any of the following mail attributes:

   [:from, :to, :cc, :bcc, :subject, :reply_to]

Example:

   context "the subject line must have the email address [email protected]" do
     subject { Mail.deliver(@message_hash) }
     it { should have_subject("[email protected]") }
   end

be_* matchers

These will look for a matching string in any of the following attributes:

   [:from, :to, :cc, :bcc, :subject, :reply_to]

Example:

   context "the subject line must have the string 'foobarbaz'" do
     subject { Mail.deliver(@message_hash) }
     it { should be_subject("foobarbaz") }
   end

have_to_username matcher

The username in the :to field is when the :to field is formatted like this:

"Peter Boling" <[email protected]>

Example:

   context "the to field must have the username 'Peter Boling'" do
     subject { Mail.deliver(@message_hash) }
     it { should have_to_username("Peter Boling") }
   end

have_sanitized_to_header matcher

Matches any part of the value of the first sanitized to header ("X-Sanitize-Email-To"), which could be formatted like this:

"Peter Boling" <[email protected]>

NOTE: It won't match subsequent headers like "X-Sanitize-Email-To-2", or "X-Sanitize-Email-To-3".

Example:

   context "the first 'X-Sanitize-Email-To' header must have the username 'Peter Boling'" do
     subject { Mail.deliver(@message_hash) }
     it { should have_sanitized_to_header("Peter Boling") }
   end

have_cc_username matcher

The username in the :cc field is when the :c field is formatted like this:

"Peter Boling" <[email protected]>

Example:

   context "the cc field must have the username 'Peter Boling'" do
     subject { Mail.deliver(@message_hash) }
     it { should have_cc_username("Peter Boling") }
   end

have_sanitized_cc_header matcher

Matches any part of the value of the first sanitized cc header ("X-Sanitize-Email-Cc"), which could be formatted like this:

"Peter Boling" <[email protected]>

NOTE: It won't match subsequent headers like "X-Sanitize-Email-Cc-2", or "X-Sanitize-Email-Cc-3".

Example:

   context "the first 'X-Sanitize-Email-Cc' header must have the username 'Peter Boling'" do
     subject { Mail.deliver(@message_hash) }
     it { should have_sanitized_cc_header("Peter Boling") }
   end

non-rspec (Test::Unit, mini-test, etc)

In your setup file:

   require "sanitize_email"
   # test helpers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
   require "sanitize_email/test_helpers"

   SanitizeEmail::Config.configure do |config|
     config[:sanitized_to] = "[email protected]"
     config[:sanitized_cc] = "[email protected]"
     config[:sanitized_bcc] = "[email protected]"
     # run/call whatever logic should turn sanitize_email on and off in this Proc.
     # config[:activation_proc] =      Proc.new { true }
     # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
     # Thus instead of using the Proc (slower) we just engage it always:
     config[:engage] = true
     config[:use_actual_email_prepended_to_subject] = true         # or false
     config[:use_actual_environment_prepended_to_subject] = true   # or false
     config[:use_actual_email_as_sanitized_user_name] = true       # or false
   end

   # If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail)
   # then you will need to do the equivalent for whatever Mail system you are using.

   # You need to know what to do here... somehow get the methods into rhw scope of your tests.
   # Something like this maybe?
   include SanitizeEmail::TestHelpers
   # Look here to see what it gives you:
   # https://github.com/pboling/sanitize_email/blob/master/lib/sanitize_email/test_helpers.rb

Deprecations

Sometimes things get deprecated (meaning they still work, but are noisy about it). If this happens to you, and you like your head in the sand, call this number:

   SanitizeEmail::Deprecation.deprecate_in_silence = true

Authors

Peter Boling is the original author of the code, and current maintainer.

Thanks to John Trupiano for turning Peter's original Rails plugin into the initial cut of this gem!

🤝 Contributing

See CONTRIBUTING.md

You can help!

Take a look at the reek list which is the file called REEK and start fixing things.

To refresh the reek list:

bundle exec reek > REEK

Then follow these instructions:

Fork the repository
Create your feature branch (git checkout -b my-new-feature)
Make some fixes.
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Create new Pull Request.

🌈 Contributors

Contributor tiles (GitHub only) made with contributors-img.

Learn more about, or become one of, our 🎖 contributors on:

Any	Of	These	DVCS
🐙hub contributors	🧊berg contributors	🛖hut contributors	🧪lab contributors

[comment]: <> ( DVCS CONTRIB LINKS )

Star History

Running Specs

The basic compatibility matrix:

   appraisal install
   appraisal rake test

NOTE: appraisal install uses the standard Gemfile, and thus adds a bunch of gems we do not need in each of our appraisal gemfiles.

Instead we can do one of:

   BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal generate
   BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal update

NOTE: This results in bad paths to the gemspec from each of the appraisal gemfiles/rails_*_*.gemfile files. gemspec path: "../../" needs to be replaced with gemspec path: "../" in each Appraisal gemfile.

It is unlikely to be possible to install all of the supported Rubies & Railsies in a single container... See the various github action workflows for more inspiration on running certain oldies.

Code Coverage

🪇 Code of Conduct

Everyone interacting in this project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

📌 Versioning

This Library adheres to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

"Major Version Numbers are Not Sacred"

As a result of this policy, you can (and should) specify a dependency on these libraries using the Pessimistic Version Constraint with two digits of precision.

For example:

   spec.add_dependency("sanitize_email", "~> 2.0")

[comment]: <> ( 📌 VERSIONING LINKS )

References

📄 License

The gem is available as open source under the terms of the MIT License . See LICENSE.txt for the official Copyright Notice.

[comment]: <> ( 📄 LEGAL LINKS )

© Copyright

🤑 One more thing

You made it to the bottom of the page, so perhaps you'll indulge me for another 20 seconds. I maintain many dozens of gems, including this one, because I want Ruby to be a great place for people to solve problems, big and small. Please consider supporting my efforts via the giant yellow link below, or one of the others at the head of this README.