Change Log

All notable changes to this project will be documented in this file.

[6.0.0] - 2019-06-04

BREAKING CHANGE

PR #284: The sinatra gem is no longer specified as a dependency of this gem. If you would like to use the inbound processing, please follow the upgrade guide. Big thanks to @jjb for the PR!

Added

PR #271: Add ability to impersonate a subuser. Big thanks to @danilospa for the PR!
PR #278: Make SendGrid permissions management easy. Big thanks to @sony-mathew for the PR!
PR #343 and PR #345: Update README.md with examples for dynamic templates and corrections to the old legacy template example. Big thanks to @kylearoberts for the PR!
PR #216: Get unassigned IPs example. Big thanks to @cristianossd for the PR!
PR #231: Add support for IO objects set as Attachment content. Big thanks to @awj for the PR!
PR #232: Add method to check email content for secret keys. Big thanks to @jaredsilver for the PR!
PR #236: Add an IpManagement helper. Big thanks to @brokenthumbs for the PR!
PR #264: Add Email Statistics helper example. Big thanks to @jeremyjung for the PR!
PR #246: Modified Mail Class calling examples with SendGrid::Mail. Big thanks to @rohan-techfreak for the PR!
PR #268: Added Code Review to CONTRIBUTING.md. Big thanks to @mptap for the PR!
PR #276: Codebase Improvement: Use attr_accessor instead of getters and setters. Big thanks to @rahul26goyal for the PR!
PR #365: Add our Developer Experience Engineer career opportunity to the README. Big thanks to @mptap for the PR!

Fixes

PR #262: Fix CONTRIBUTING.md formatting. Big thanks to @thepriefy for the PR!
PR #277: Fix travis warning. Big thanks to @rahul26goyal for the PR!
PR #303: Update readme tags and fix minor test failures. Big thanks to @af4ro for the PR!
PR #370: Remove references to "Whitelabel". Big thanks to @crweiner for the PR!
PR #383: Correct endpoint for single spam report requests. Big thanks to @bermannoah for the PR!

[5.3.0] - 2018-10-12

Added

PR #300: Support for Dynamic Templates. Big thanks to @nedcampion for the PR!
PR #178: Convert key/value arguments to CustomArgs to strings. Big thanks to @sitaramshelke for the PR!
PR #258: Added unittest to check for specific repo files. Big thanks to @mptap for the PR!
PR #255: Add a unittest to check the license.md file date range. Big thanks to @prashuchaudhary for the PR!
PR #181: Add Docker. Big thanks to @shrivara for the PR!
PR #248: Added .codeclimate.yml. Big thanks to @proton for the PR!
PR #260: Update ruby-http-client dependency to support v3.3.0. Big thanks to @mptap for the PR!
PR #304: Readability update for documentation. Big thanks to @af4ro for the PR!
PR #306: Update example to work in Rails console. Big thanks to @RogerPodacter for the PR!

Fixes

PR #252: Update LICENSE, set correct year. Big thanks to @pushkyn for the PR!
PR #257: README.md typo fix. Big thanks to @shucon for the PR!

[5.2.0] - 2017-10-30

Added

PR #234: Helpers for email statistics - global, category, subuser
Thanks to Awin Abi for the pull request!

[5.1.0] - 2017-9-1

Added

#173: Update ruby-http-client dependency
#12 Add a helper that returns the response body as a hash via the parsed_body method in the Response object.
Thanks to Diego Camargo for the pull request!

[5.0.0] - 2017-05-27

BREAKING CHANGE

#108 Fix unexpected Mail #categories, #categories= behavior
Fixed Issue #95 Refactor Mail Helper Array Assignments
personalization.to becomes personalization.add_to()
personalization.cc becomes personalization.add_cc()
personalization.bcc becomes personalization.add_bcc()
personalization.headers becomes personalization.add_header()
personalization.substitutions becomes personalization.add_substitution()
personalization.custom_args becomes personalization.add_custom_arg()
mail.personalizations becomes mail.add_personalization()
mail.contents becomes mail.add_content()
mail.attachments becomes mail.add_attachment()
mail.sections becomes mail.add_section()
mail.headers becomes mail.add_header()
mail.categories becomes mail.add_category()
mail.custom_args becomes mail.custom_args()
For a full example of usage, please see here.

[4.3.3] - 2017-5-2

Update

#157: Specify required ruby version as '>= 2.2'
This library does not support Ruby 2.1 or below.
Thanks to Ryunosuke Sato for the pull request!

[4.3.2] - 2017-5-1

Fixes

#161: Fixed problematic Sinatra dependency
Brings back Rails 4 compatibility (and Rack 1.x applications, in general), also removes release candidate version constraint (both broken in #160). Moreover, ensures that tests are run against two major Sinatra versions, which should protect from compatibility issues in future, somewhat. Related issue: #159.
Thanks to Sebastian Skałacki for the pull request!

[4.3.1] - 2017-4-12

Fixes

#160: Updated sinatra version to 2.0
Fixes bundler dependency issues with rails >5.0 and rack 2.0. Solves #159
Thanks to gkats for the pull request!

[4.3.0] - 2017-4-12

Added

#70: Adds an account settings management helper object
See the helper README for details
Thanks to Kyle Kern for the pull request!

[4.2.1] - 2017-4-10

Fixed

#112: Fixes version ambiguity in gemspec
Thanks to Chris McKnight for the pull request!

[4.2.0] - 2017-4-10

Added

#148: Set api_key to empty string
This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
Thanks to Adam Beck for the pull request!

[4.1.1] - 2017-4-6

Fixed

#115 #134: Fix typos in initialize methods
Thanks to Ben Jackson for the pull request!

[4.1.0] - 2017-4-6

Add

#144: Add Inbound Email Parse Webhook support
Thanks to Wataru Sato for the pull request!

[4.0.8] - 2017-2-17

Add

Solves #147: Add User Agent string

[4.0.7] - 2017-1-25

Fixes

Pull Request #7
Fixes issue #6: TLS certificates not verified
Thanks to Koen Rouwhorst for the pull request!

[4.0.6] - 2016-10-18

Added

Pull #113: Fix Travis CI Prism functionality for non-SendGrid contributors, update deprecated File.exists

[4.0.5] - 2016-10-17

Added

Pull #110, fixed Issue #109
Automates StopLight.io Prism mock server locally & on Travis CI
Thanks to KY for the pull request!

[4.0.4] - 2016-09-15

Fixed

Pull #72: remove unnecessary ruby 2.2 requirement
Thanks to Billy Watson for the pull request!

[4.0.3] - 2016-08-24

Added

Table of Contents in the README
Added a USE_CASES.md section, with the first use case example for transactional templates

[4.0.2] - 2016-07-26

Fixed

Example and USAGE DELETE calls were missing example payloads

[4.0.1] - 2016-07-25

Added

Troubleshooting section

[4.0.0] - 2016-07-23

BREAKING CHANGE

Update dependency to ruby-http-client
Response headers now return a hash instead of a string
Thanks to Chris France for the pull request!

[3.0.7] - 2016-07-20

Added

README updates
Update introduction blurb to include information regarding our forward path
Update the v3 /mail/send example to include non-helper usage
Update the generic v3 example to include non-fluent interface usage

[3.0.6] - 2016-07-05

Added

Update docs, unit tests and examples to include Sender ID

[3.0.5] - 2016-07-05

Added

Accept: application/json header per https://sendgrid.com/docs/API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/requests.html

Updated

Content based on our updated Swagger/OAI doc

[3.0.4] - 2016-06-15

Added

Updated dependency on ruby-http-client

[3.0.3] - 2016-06-15

Fixing

Import structure

[3.0.2] - 2016-06-15

Added

Relative import for mail/helper

[3.0.1] - 2016-06-15

Added

Add mail/send helper to the $LOAD_PATH, updated http client dependency

[3.0.0] - 2016-06-13

Added

Breaking change to support the v3 Web API
New HTTP client
v3 Mail Send helper

[1.1.6] - 2015-11-26

Added

Support for cc_name and bcc_name via #31

Thanks Dylan!

[1.1.5] - 2015-10-28

Added

Support for Templates via #28

Thanks Jake!

[1.0.5] - 2015-10-21

Fixed

Remove puts from mail.rb #29

[1.0.4] - 2015-10-06

Added

Inline content support

[1.0.3] - 2015-10-01

Fixed

Payload 'to' attribute fix for smtpapi