sendgrid-actionmailer 0.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 279c424c1fb91a3d43959b079eb62ff18cc49f4b
-  data.tar.gz: 612acbbe466f59ef1cfe8fb43d3e50b905b480c7
+  metadata.gz: 20a38e557a4c77001c637d5d94407d99113b9661
+  data.tar.gz: 2dc48c9d94c830a664cb0105e8ad8d068eca449a
 SHA512:
-  metadata.gz: efa913396a27fca27aaa83f3aa4ee00f9c59a8e5706d881d097e43e7a2d246fb06283f6c58a41ebe468fd997a6b2b7e56fe43b444597c31fe465bfaca2ff007e
-  data.tar.gz: 22c1f0dc2f693e4788cd508ccb2a4a7997e4437423ceea8c6eeaf5372dd2905c52447660dd0590f548f1f17dc2faa07410f3efebe1732af47a587502b88702fc
+  metadata.gz: 059add8c5b4fe2d4232ec038c2686b79ec93c8dbeed984bd806b3f61d71e3afeb961ea05181f603b7105ba50eb34709ddb108c3cfc5997d5b66a66d5083c499a
+  data.tar.gz: c60cf2c4baeeb7468c03cdd6631eeb5b7516a287c88750a2ad7afcc882ae6c81ec59f0c501a811bff046d07c7e7f5b5ca915db223c2431ea9fe992eb06e3b3ae

data/.travis.yml

@@ -1,11 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-- 2.2.1
-- 2.0.0
-- 1.9.3
-before_script:
-- bundle install
+  - 2.5.1
+  - 2.4.4
+  - 2.3.4
+  - 2.3.7
+  - 2.2.10
+before_install:
+  - gem install bundler
 gemfile:
   - gemfiles/mail_2.5.gemfile
   - gemfiles/mail_2.6.gemfile

data/Appraisals

@@ -5,3 +5,7 @@ end
 appraise "mail-2.6" do
   gem "mail", "2.6.4"
 end
+
+appraise "mail-2.7" do
+  gem "mail", "2.7.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.0.0 - 2018-08-15
+
+### Changed
+
+- Compatibility with `sendgrid-ruby` v5.0.
+
 ## 0.2.1 - 2016-04-26
 
 ### Fixed

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sendgrid-actionmailer.gemspec
 gemspec
+
+if RUBY_VERSION < '2'
+  gem 'public_suffix', '~> 1.4.6'
+  gem 'mime-types', '~> 2.99'
+end

data/README.md

@@ -1,23 +1,12 @@
 # SendGrid ActionMailer
 
-An ActionMailer adapter to send email using SendGrid's HTTPS Web API (instead of SMTP).
-
-[![BuildStatus](https://travis-ci.org/eddiezane/sendgrid-actionmailer.svg?branch=master)](https://travis-ci.org/eddiezane/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'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sendgrid-actionmailer
-    
+    gem 'sendgrid-actionmailer', github: 'eddiezane/sendgrid-actionmailer'
 
 ## Usage
 
@@ -26,74 +15,196 @@ Create a [SendGrid API Key](https://app.sendgrid.com/settings/api_keys) for your
 ```ruby
 config.action_mailer.delivery_method = :sendgrid_actionmailer
 config.action_mailer.sendgrid_actionmailer_settings = {
-  api_key: ENV['SENDGRID_API_KEY']
+  api_key: ENV['SENDGRID_API_KEY'],
+  raise_delivery_errors: true
 }
 ```
 
 Normal ActionMailer usage will now transparently be sent using SendGrid's Web API.
 
-### X-SMTPAPI
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body')```
 
-You may optionally set SendGrid's [X-SMTPAPI](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html) header on messages to control SendGrid specific functionality. This header must be set to a JSON string.
+## SendGrid Mail Extensions
 
-```ruby
-class UserMailer < ApplicationMailer
-  def welcome_email(user)
-    headers['X-SMTPAPI'] = {
-      category: ['newuser']
-    }.to_json
-
-    mail(to: user.email, subject: 'Welcome to My Awesome Site')
-  end
-end
-```
+The Mail functionality is extended to include additional attributes provided by the Sendgrid API.
 
-The following `X-SMTPAPI` options are supported:
+[Sendgrid v3 API Documentation](https://sendgrid.com/docs/API_Reference/api_v3.html)
 
-- `filters`
-- `category`
-- `send_at`
-- `send_each_at`
-- `section`
-- `sub`
-- `asm_group_id`
-- `unique_args`
-- `ip_pool`
+### template_id (string)
+The id of a template that you would like to use. If you use a template that contains a subject and content (either text or html), you do not need to specify those at the personalizations nor message level.
 
-#### X-SMTPAPI Defaults
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', template_id: 'template_1')```
 
-Default values for the `X-SMTPAPI` header may be set at different levels using ActionMailer's normal options for setting default headers. However, since `X-SMTPAPI` is treated as a single string value, it's important to note that default values at different levels will not get merged together. So if you override the `X-SMTPAPI` header at any level, you may need to repeat any default values at more specific levels.
+### sections (object)
+An object of key/value pairs that define block sections of code to be used as substitutions.
 
-Global defaults can be set inside `config/application.rb`:
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', sections: {'%header%' => "<h1>Header</h1>"})```
 
-```ruby
-config.action_mailer.default_options = {
-  'X-SMTPAPI' => {
-    ip_pool: 'marketing_ip_pool'
-  }.to_json
-}
-```
+### 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.
 
-Per-mailer defaults can be set inside an ActionMailer class:
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', headers: {'X-CUSTOM-HEADER' => "foo"})```
 
-```ruby
-class NewsletterMailer < ApplicationMailer
-  default('X-SMTPAPI' => {
-    category: ['newsletter'],
-
-    # Assuming the above "config.action_mailer.default_options" global default
-    # example, the default "ip_pool" value must be repeated here if you want
-    # that default value to also apply to this specific mailer that's
-    # specifying it's own default X-SMTPAPI value.
-    ip_pool: 'marketing_ip_pool'
-  }.to_json)
-end
-```
+### categories (array)
+An array of category names for this message. Each category name may not exceed 255 characters.
+
+```mail(to: 'example@email.com', 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: 'example@email.com', 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](https://sendgrid.com/docs/API_Reference/Web_API_v3/cancel_schedule_send.html)
+
+```mail(to: 'example@email.com', 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: 'example@email.com', 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: 'example@email.com', 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: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: {bcc: {enable: true, email: 'bcc@example.com}})```
+
+#### 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: 'example@email.com', 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: 'example@email.com', 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: 'example@email.com', 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: 'example@email.com', 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: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ 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: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ 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: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ 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: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign' }})```
+
+### Unsubscribe Links
 
-## Contributing
+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.
 
-1. Fork it ( https://github.com/[my-github-username]/sendgrid-actionmailer/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+ * `<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>`

data/lib/sendgrid_actionmailer/version.rb

@@ -1,3 +1,3 @@
 module SendGridActionMailer
-  VERSION = '0.2.1'
+  VERSION = '2.0.0'.freeze
 end