v5.5.0

Added

• PR #588: Updates the Readme to include environment variable setup in windows. Big thanks to Bhargav Chandaka for the PR!
• PR #599: Updates the Readme to include additional API Key instruction. Big thanks to Anshul Singhal for the PR!
• PR #600: Add CodeTriage Badge. Big thanks to Anshul Singhal for the PR!
• PR #601: Readability improvements to CONTRIBUTING.md. Big thanks to Anshul Singhal for the PR!
• PR #604: Readability improvements to CONTRIBUTING.md. Big thanks to agnesjang98 for the PR!

Fixed

• PR #595: Change type of category in Mail.add_category from string to Category. Big thanks to Phawin Khongkhasawan for the PR!
• PR #596: Fix Docker build. Big thanks to Phawin Khongkhasawan for the PR!
• PR #598: Fix python3 print example in TROUBLESHOOTING.md. Big thanks to Ryan Jarvis for the PR!
• PR #603: Update TROUBLESHOOTING.md to link to correct use cases page. Big thanks to James Purpura for the PR!

v5.4.1

Fixed

• PR #585: Fix typo in mail_example.py. Big thanks to Anurag Anand for the PR!
• PR #583: Fix Personalization.substitutions setter. Trying to set substitutions directly rather than with add_substitution was causing an infinite regress. Big thanks to Richard Nias for the PR!

v5.4.0

Added

• PR #384: Adds how to set up domain whitelabel and how to view email statistics. Big thanks to Aditya Tandon for the PR!
• PR #427: Increase config.py coverage. Big thanks to Jeferson Daniel for the PR!
• PR #423: Update config.py with better file handling. Big thanks to Ajitesh Rai for the PR!
• PR #449: Add a .env_sample file and Update README.md. Big thanks to trangttt for the PR!
• PR #463: Add code climate.
• PR #455: Use with context manager and a few PEP8 changes. Big thanks to Tim for the PR!
• PR #470: Modularize lengthy method. Big thanks to Suprith Kumar Suvarneshwar for the PR!
• PR #425: Add tests for sendgrid.py apikey and api_key setters. Big thanks to Krista LaFentres for the PR!
• PR #446: Added PULL_REQUEST_TEMPLATE. Big thanks to Aleksandr Sobolev for the PR!
• PR #472: Moved mail helper classes into separate files. Big thanks to Milos Pejanovic for the PR!
• PR #481: Documented the new error handling functionality from python-http-client. Big thanks to Manjiri Tapaswi for the PR!
• PR #418: Add test for apps.py. Big thanks to Sinan Comert for the PR!
• PR #438: Update docstrings/pydoc/help. Big thanks to Gabriel Krell for the PR!
• PR #413: Error-checking in Mail helper/ASM. Big thanks to Gabriel Krell for the PR!
• PR #518: Announcement about Data Platform Engineer posting. Big thanks to Marghodk for the PR!
• PR #479: Add Project tests. Big thanks to Peter Hampton for the PR!
• PR #480: Test to check year in LICENSE.txt. Big thanks to Navin Pai for the PR!
• PR #476: Add tests for Send.py. Big thanks to Artiem K. for the PR!
• PR #366: Add AWS app tutorial to USE_CASES.md. Big thanks to Mike Vanbuskirk for the PR!
• PR #365: Write tutorial to deploy simple Django app on Heroku. Big thanks to Kan Ouivirach for the PR!
• PR #526: Include code reviews section. Big thanks to Jared Scott for the PR!
• PR #414: Provide utf-8 as encoding explicitly when opening text files. Big thanks to Ruslan Shestopalyuk for the PR!
• PR #537: Add unittesting support to .codeclimate.yml. Big thanks to Prashu Chaudhary for the PR!
• PR #554: Ensure params are applied independently. Big thanks to Nino Milenovic for the PR!
• PR #557: Client cleanup. Big thanks to Slam for the PR!
• PR #569: Make Mail helper parameters truly optional. Big thanks to Ian Beck for the PR!

Fixed

• PR #415: Typos. Big thanks to Mohd Huzaifa Faruqui for the PR!
• PR #421: Typos. Big thanks to Abhishek Bhatt for the PR!
• PR #432: Typos. Big thanks to Gaurav Arora for the PR!
• PR #431: Typos. Big thanks to Gaurav Arora for the PR!
• PR #430: Attempt to sync before executing shell command. Big thanks to Aditya Narayan for the PR!
• PR #429: Typos. Big thanks to daluntw for the PR!
• PR #492:
  Updated date-range in LICENSE file. Big thanks to Dhruv Srivastava for the PR!
• PR #482: Typos. Big thanks to Karan Samani for the PR!
• PR #504: Fix .codeclimate.yml. Big thanks to Matt Bernier for the PR!
• PR #505: Remove unnecessary github PR templates. Big thanks to Alex for the PR!
• PR #494: Remove unused import in register.py. Big thanks to Alexis Rivera De La Torre for the PR!
• PR #469:
  Removed the trailing white spaces. Big thanks to Siddaram Halli for the PR!
• PR #484: Python style fixes. Big thanks to Gabriel Krell for the PR!
• PR #508: Typos. Big thanks to Saksham Gupta for the PR!
• PR #353: Typos. Big thanks to Yothin M for the PR!
• PR #564: Typos. Big thanks to Chao for the PR!
• PR #424: Updating version 2.7.8 to 2.7.11 to match version in pyenv install instruction. Big thanks to Krista LaFentres for the PR!
• PR #454: Requests to send mail with both plain text and HTML content fail if the HTML content is specified first. Big thanks to Ryan D'souza for the PR!
• PR #466: Fixed PEP8 issues. Big thanks to Piotr Szwarc for the PR!
• PR #522: Typos. Big thanks to Abhishek J for the PR!
• PR #514: Fix method_complexity issue in sendgrid/helpers/mail/ganalytics.py. Big thanks to Chetan Kumar for the PR!
• PR #515: Typos. Big thanks to Mohd Ali Rizwi for the PR!
• PR #519: Typos. Big thanks to Aashish Gaba for the PR!
• PR #532: Typos. Big thanks to ~ for the PR!
• PR #533: Fix shadowed builtins, id -> id_. Big thanks to ~ for the PR!
• PR #581: Typos. Big thanks to Silvia Botros for the PR!
• PR #513: Typos. Big thanks to thepriefy for the PR!
• PR #538: Fix bug in get_mock_personalization_dict(). Big thanks to PierreMonico for the PR!
• PR #543: Typos. Big thanks to Matthieu Bonnefoy for the PR!

v5.3.0

Added

• Pull #348: Allows users to submit rfc822 formatted email addresses
• Big thanks to Matt Bernier for the pull request!

v5.2.1

Fixed

• Pull #364: Install prism with non superuser account
• We use prism to mock calls to the SendGrid v3 API for integration tests
• Big thanks to meahow for the pull request!

v5.2.0

Added

• Pull #335: Permit unicode string values with Substitution helper
• Big thanks to Mehron Kugler for the pull request!

v5.1.0

Added

• Pull #338: Allow the __str__ method for the Mail object return an String instead of a NoneType
• Solves #292: The __str__ method of the Mail class, doesn't actually return anything
• Big thanks to belfazt for the pull request!

v5.0.1

Fix

• Pull #337, fixes issue #366
• On install, some experienced: ValueError: ("Expected ',' or end-of-list in", 'python-http-client ==3.0.*', 'at', '*')

v5.0.0

BREAKING CHANGE

• The breaking change actually happened in version 4.2.1, where I mistakenly applied a patch version bump. See issues #328 and #321 for details.
• This version (5.0.0) replaces error handling via HTTPError from urllib in favor of custom error handling via the HTTPError class as was the case in version 4.2.0.

v4.2.1

Fixed

• Issue #321: Installing 4.2.0 installs the wrong version of python-http-client
• We now pin to 2.2.* of python-http-client to avoid the break caused by 2.3
• Big thanks to w- for the heads up!