MailAllowlist is a class you can provide as an interceptor to your Rails app. It ensures only some people are able to receive mails from your app and provides a fallback in case nobody would receive the mail. This can be useful to make sure no accidental emails are sent from your staging environment, but your mails can still be checked.
One way to use it is to set an environment variable MAIL_ALLOWLIST, check
for its existence and use it to instantiate a MailAllowlist so that within
this environment only those emailaddresses can have mail sent to them.
See below for a code exapmle.
Add this line to your application's Gemfile:
gem 'mail_allowlist'And then execute:
$ bundle
Or install it yourself as:
$ gem install mail_allowlist
Specify your allowlist as an array of email addresses and register them in an initializer in your Rails app. Optionally specify a fallback address as second argument.
Example Rails app initializer using ENV variables:
require 'mail_allowlist'
if ENV.key?('MAIL_ALLOWLIST')
allowlist = ENV['MAIL_ALLOWLIST'].split(',')
fallback = ENV['MAIL_ALLOWLIST_FALLBACK']
ActionMailer::Base.register_interceptor(MailAllowlist.new(allowlist, fallback))
endAfter checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/brightin/mail_allowlist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.