sendgrid-actionmailer

SendGrid ActionMailer

An ActionMailer adapter to send email using SendGrid's HTTPS Web API (instead of SMTP). Compatible with Rails 5 and Sendgrid API v3.

Installation

Add this line to your application's Gemfile:

gem 'sendgrid-actionmailer'

Usage

Create a SendGrid API Key for your application. Then edit config/application.rb or config/environments/$ENVIRONMENT.rb and add/change the following to the ActionMailer configuration:

config.action_mailer.delivery_method = :sendgrid_actionmailer
config.action_mailer.sendgrid_actionmailer_settings = {
  api_key: ENV['SENDGRID_API_KEY'],
  raise_delivery_errors: true
}

Normal ActionMailer usage will now transparently be sent using SendGrid's Web API.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body')

Mail Settings

Mail settings, such as sandbox_mode, may be applied globally through the sendgrid_actionmailer_settings configuration.

config.action_mailer.delivery_method = :sendgrid_actionmailer
config.action_mailer.sendgrid_actionmailer_settings = {
  api_key: ENV['SENDGRID_API_KEY'],
  mail_settings: { sandbox_mode: { enable: true }}
}

Dynamic API Key

If you need to send mail for a number of Sendgrid accounts, you can set the API key for these as follows:

mail(to: '[e-mail]',
  subject: 'email subject',
  body: 'email body',
  delivery_method_options: {
    api_key: 'SENDGRID_API_KEY'
  }
)

SendGrid Mail Extensions

The Mail functionality is extended to include additional attributes provided by the Sendgrid API.

Sendgrid v3 API Documentation

template_id (string)

The id of a template that you would like to use. If you use a template that contains a subject, you do not need to specify a subject at the personalizations nor message level. However, because of the way ActionMailer works, a body is required, even if the template contains one. If all your emails use templates with a body, you can add default body: "not used" to the top of your mailer.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', template_id: 'template_1')

sections (object)

An object of key/value pairs that define block sections of code to be used as substitutions.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', sections: {'%header%' => "<h1>Header</h1>"})

headers (object)

An object containing key/value pairs of header names and the value to substitute for them. You must ensure these are properly encoded if they contain unicode characters. Must not be one of the reserved headers.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', headers: {'X-CUSTOM-HEADER' => "foo"})

categories (array)

An array of category names for this message. Each category name may not exceed 255 characters.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', categories: ['marketing', 'sales'])

custom_args (object)

Values that are specific to the entire send that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This parameter is overridden by personalizations[x].custom_args if that parameter has been defined. Total custom args size may not exceed 10,000 bytes.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', custom_args: {campaign: 'welcome'})

send_at (integer)

A unix timestamp allowing you to specify when you want your email to be delivered. This may be overridden by the personalizations[x].send_at parameter. You can't schedule more than 72 hours in advance. If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail.

batch_id (string)

This ID represents a batch of emails to be sent at the same time. Including a batch_id in your request allows you include this email in that batch, and also enables you to cancel or pause the delivery of that batch. For more information, see cancel_schedule_send

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', send_at: 1443636842, batch_id: 'batch1')

asm (object)

An object allowing you to specify how to handle unsubscribes.

group_id (integer) *required

The unsubscribe group to associate with this email.

groups_to_display (array[integer])

An array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', asm: { group_id: 99, groups_to_display: [4,5,6,7,8] })

ip_pool_name (string)

The IP Pool that you would like to send this email from.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', ip_pool_name: 'marketing_ips')

mail_settings (object)

A collection of different mail settings that you can use to specify how you would like this email to be handled.

bcc (object)

This allows you to have a blind carbon copy automatically sent to the specified email address for every email that is sent.

enable (boolean)

Indicates if this setting is enabled.

email (string)

The email address that you would like to receive the BCC.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', mail_settings: { bcc: { enable: true, email: '[e-mail] }})

bypass_list_management (object)

Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email.

enable (boolean)

Indicates if this setting is enabled.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', mail_settings: { bypass_list_management: { enable: true }})

footer (object)

The default footer that you would like included on every email.

enable (boolean)

Indicates if this setting is enabled.

text (string)

The plain text content of your footer.

html (string)

The HTML content of your footer.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', mail_settings: { footer: { enable: true, text: 'FOOTER', html: '<h1>FOOTER</h1>' }})

sandbox_mode (object)

This allows you to send a test email to ensure that your request body is valid and formatted correctly.

enable (boolean)

Indicates if this setting is enabled.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', mail_settings: { sandbox_mode: { enable: true }})

spam_check (object)

This allows you to test the content of your email for spam.

enable (boolean)

Indicates if this setting is enabled.

threshold (integer)

The threshold used to determine if your content qualifies as spam on a scale from 1 to 10, with 10 being most strict, or most likely to be considered as spam.

post_to_url (string)

An Inbound Parse URL that you would like a copy of your email along with the spam report to be sent to.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', mail_settings: { spam_check: { enable: true, threshold: 1, post_to_url: 'https://spamcatcher.sendgrid.com' }})

tracking_settings(json)

Settings to determine how you would like to track the metrics of how your recipients interact with your email.

click_tracking(object)

Allows you to track whether a recipient clicked a link in your email.

enable (boolean)

Indicates if this setting is enabled.

enable_text (boolean)

Indicates if this setting should be included in the text/plain portion of your email.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', tracking_settings: { click_tracking: { enable: false, enable_text: false }})

open_tracking (object)

Allows you to track whether the email was opened or not, but including a single pixel image in the body of the content. When the pixel is loaded, we can log that the email was opened.

enable (boolean)

Indicates if this setting is enabled.

substitution_tag (string)

Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', tracking_settings: { open_tracking: { enable: true, substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})

subscription_tracking (object)

Allows you to insert a subscription management link at the bottom of the text and html bodies of your email. If you would like to specify the location of the link within your email, you may use the substitution_tag.

enable (boolean)

Indicates if this setting is enabled.

text (string)

Text to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag <% %>

html (string)

HTML to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag <% %>

substitution_tag (string)

A tag that will be replaced with the unsubscribe URL. for example: [unsubscribe_url]. If this parameter is used, it will override both the text and html parameters. The URL of the link will be placed at the substitution tag’s location, with no additional formatting.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', tracking_settings: { subscription_tracking: { enable: true, text: 'text to insert into the text/plain portion of the message', html: 'html to insert into the text/html portion of the message', substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})

ganalytics (object)

Allows you to enable tracking provided by Google Analytics.

enable (boolean)

Indicates if this setting is enabled.

utm_source (string)

Name of the referrer source. (e.g. Google, SomeDomain.com, or Marketing Email)

utm_medium (string)

Name of the marketing medium. (e.g. Email)

utm_term (string)

Used to identify any paid keywords.

utm_content (string)

Used to differentiate your campaign from advertisements.

utm_campaign (string)

The name of the campaign.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', tracking_settings: { ganalytics: { enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign' }})

dynamic_template_data (json)

Data to provide for feeding the new dynamic templates in Sendgrid with valueable data. This also disables the following Unsubscribe links because of deprecation of substitutions in the new template implementaiton. Variables are available within templates using {{handlebar syntax}}.

mail(to: '[e-mail]', subject: 'email subject', body: 'email body', dynamic_template_data: { variable_1: 'foo', variable_2: 'bar' })

personalizations (json)

Allows providing a customized personalizations array for the v3 Mail Send endpoint. This allows customizing how an email is sent and also allows sending multiple different emails to different recipients with a single API call.

The personalizations object supports:

• "to", "cc", "bcc" - The recipients of your email.
• "subject" - The subject of your email.
• "headers" - Any headers you would like to include in your email.
• "substitutions" - Any substitutions you would like to be made for your email.
• "custom_args" - Any custom arguments you would like to include in your email.
• "send_at" - A specific time that you would like your email to be sent.
• "dynamic_template_data" - data for dynamic templates.

The following should be noted about these personalization attributes:

• to, cc, or bcc: if either to, cc, or bcc is also set when calling mail, those addresses provided to mail will be inserted as a separate personalization from the ones you provide. However, when using personalizations, you are not required to specify to when calling the mail function.
• dynamic_template_data specified in the mail function will be merged with any dynamic_template_data specified in the personalizations object (with the personalizations object keys having priority).
• Other fields set in the personalizations object will override any global parameters defined outside of personalizations.

Also note that substitutions will not work with dynamic templates.

Example usage:

mail(subject: 'default subject', 'email body', personalizations: [
  { to: [{ email: '[e-mail]' }]},
  { to: [{ email: '[e-mail]' }]}
])

Unsubscribe Links

Sendgrid unfortunately uses <% %> for their default substitution syntax, which makes it incompatible with Rails templates. Their proposed solution is to use Personalization Substitutions with the v3 Mail Send Endpoint. This gem makes that modification to make the following Rails friendly unsubscribe urls.

• <a href="%asm_group_unsubscribe_raw_url%">Unsubscribe</a>
• <a href="%asm_global_unsubscribe_raw_url%">Unsubscribe from List</a>
• <a href="%asm_preferences_raw_url%">Manage Email Preferences</a>

Note: This feature, and substitutions in general, do not work in combination with dynamic templates.

Testing

The setting perform_send_request is available to disable sending for testing purposes. Setting perform_send_request false and return_response true enables the testing of the JSON API payload.