Recoil
Recoil makes sure your Amazon SES reputation is preserved by blacklisting emails with a bad reputation. Recoil does this with two simple tools:
- An HTTP endpoint to receive bounce notifications and save them to the database.
- An ActionMailer interceptor which is able to filter emails with high bounce rates.
Getting started
Recoil works with Rails 4.0 onward. You can add it to you Gemfile with:
gem 'recoil'
Run the bundle command to install it. After you've installed Recoil you need to copy the migrations and migrate the database:
rake recoil:install:migrations
rake db:migrate
Add the endpoint to your routes.rb
:
mount Recoil::Engine => '/ses'
Add an initializer: config/initializers/recoil.rb
to initialize the interceptor:
ActionMailer::Base.register_interceptor(Recoil::Interceptor)
You're now ready to subscribe to SNS-notifications:
- Go to the SES dashboard and navigate to Topics > Create new topic.
- Enter a name and save.
- Create a new http/https subscription for this topic with the Recoil URL as endpoint. Make sure Recoil is mounted to this URL, as SNS will send a verification request as soon as you add the subscription.
- After the subscription is added and verified, you're able to let SES send notifications to the SNS topic. This is configurable in the SES dashboard.
Configuration
There is just a single configuration option for recoil: blacklist_threshold
. This is a lambda with an ActiveRecord scope as argument. The default configuration is to blacklist all email with 10+ bounces in the last two weeks. This is a very loose policy, but it's easy to change:
# config/initializers/recoil.rb
Recoil.blacklist_threshold = ->(scope) { scope.where('created_at > ?', 1.week.ago).count > 10 }
##RDocs
You can view the Recoil documentation in RDoc format here:
http://rubydoc.info/github/brightin/recoil
Contributing
- Fork it ( https://github.com/brightin/recoil/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request