Home

Awesome

ActionMailer delivery with Amazon Simple Email Service

Gem Version Build Status Github forks Github stars

This gem contains ActionMailer delivery method classes with Amazon SES and SESV2.

Installation

Add this gem to your Rails project's Gemfile:

gem 'aws-sdk-rails', '~> 5'
gem 'aws-actionmailer-ses', '~> 1'

Then run bundle install.

This gem also brings in the following AWS gems:

You will have to ensure that you provide credentials for the SDK to use. See the latest AWS SDK for Ruby Docs for details.

If you're running your Rails application on Amazon EC2, the AWS SDK will check Amazon EC2 instance metadata for credentials to load. Learn more: IAM Roles for Amazon EC2

Usage

To use these mailers as a delivery method, you need to set the delivery method and configure the delivery method with the appropriate settings. For example, to configure ActionMailer to use the Amazon SESV2 API in the us-west-2 region, you can add the following to an environment file in your Rails application:

# config/environments/production.rb

Rails.application.configure do |config|
  ...

  # Use the Amazon SESV2 API in the us-west-2 region
  config.action_mailer.delivery_method = :ses_v2
  config.action_mailer.ses_v2_settings = { region: 'us-west-2' }

  ...
end

Using ARNs with SES

This gem uses `Aws::SES::Client#send_raw_email` and `Aws::SESV2::Client#send_email` to send emails. These operations allows you to specify a cross-account identity for the email's Source, From, and Return-Path. To set these ARNs, use any of the following headers on your Mail::Message object returned by your Mailer class:

Example:

# in your Rails controller
message = MyMailer.send_email(options)
message['X-SES-FROM-ARN'] = 'arn:aws:ses:us-west-2:012345678910:identity/bigchungus@memes.com'
message.deliver