TROUBLESHOOTING.md

If you have a non-library SendGrid issue, please contact our support team.

If you can't find a solution below, please open an issue.

Table of Contents

• Environment Variables and Your SendGrid API Key
• Error Messages
• Version Convention

Environment Variables and Your SendGrid API Key

Initial Setup

• copy the .env_sample file to .env

cp .env_sample .env

• open and add the params into this file (.env)

• then source the file

source ./.env

All of our examples assume you are using environment variables to hold your SendGrid API key.

If you choose to add your SendGrid API key directly (not recommended):

apikey=os.environ.get('SENDGRID_API_KEY')

becomes

apikey='SENDGRID_API_KEY'

In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual SendGrid API Key.

Error Messages

To read the error message returned by SendGrid's API in Python 2.X:

import urllib2

try:
    response = sg.client.mail.send.post(request_body=mail.get())
except urllib2.HTTPError as e:
    print e.read()

To read the error message returned by SendGrid's API in Python 3.X:

import urllib
try:
    response = sg.client.mail.send.post(request_body=mail.get())
except urllib.error.HTTPError as e:
    print e.read()

Versioning Convention

We follow the MAJOR.MINOR.PATCH versioning scheme as described by SemVer.org. Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the CHANGELOG and releases section.