sendgrid 6.7.1

Twilio SendGrid library for Python

This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Python.

NEW:

The default branch name for this repository has been changed to `main` as of 07/27/2020.

• Subscribe to email notifications for releases and breaking changes.

• Version 6.X release is a BREAKING CHANGE from version 5.X, please see the release notes for details.

• Send SMS messages with Twilio.

This library provides full support for all Twilio SendGrid Web API v3 endpoints, including v3 /mail/send.

We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or simply upvote or comment on existing issues or pull requests.

Please browse the rest of this README for further detail.

We appreciate your continued support, thank you!

Table of Contents

• Installation

• Quick Start

• Common Use Cases

• General Usage

• Processing Inbound Email

• Announcements

• How to Contribute

• Troubleshooting

• About

• License

Installation

Prerequisites

• Python version 2.7 and 3.5+

• For email, you will need a Twilio SendGrid account, starting at the free level

• For SMS messages, you will need a free Twilio account

Setup Environment Variables

Mac

Update the development environment with your SENDGRID_API_KEY (more info here), for example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Twilio SendGrid also supports local environment file .env. Copy or rename .env_sample into .env and update SENDGRID_API_KEY with your key.

Windows

Temporarily set the environment variable (accessible only during the current CLI session):

set SENDGRID_API_KEY=YOUR_API_KEY

Permanently set the environment variable (accessible in all subsequent CLI sessions):

setx SENDGRID_API_KEY "YOUR_API_KEY"

Install Package

pip install sendgrid

Dependencies

• Python-HTTP-Client

• ECDSA-Python

Quick Start

Hello Email

The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):

With Mail Helper Class

import os
from sendgrid import SendGridAPIClient
from sendgrid.helpers.mail import Mail

message = Mail(
    from_email='[e-mail]',
    to_emails='[e-mail]',
    subject='Sending with Twilio SendGrid is Fun',
    html_content='<strong>and easy to do anywhere, even with Python</strong>')
try:
    sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
    response = sg.send(message)
    print(response.status_code)
    print(response.body)
    print(response.headers)
except Exception as e:
    print(str(e))

The Mail constructor creates a personalization object for you. Here is an example of how to add it.

Without Mail Helper Class

The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):

import os
from sendgrid import SendGridAPIClient

message = {
    'personalizations': [
        {
            'to': [
                {
                    'email': '[e-mail]'
                }
            ],
            'subject': 'Sending with Twilio SendGrid is Fun'
        }
    ],
    'from': {
        'email': '[e-mail]'
    },
    'content': [
        {
            'type': 'text/plain',
            'value': 'and easy to do anywhere, even with Python'
        }
    ]
}
try:
    sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
    response = sg.send(message)
    print(response.status_code)
    print(response.body)
    print(response.headers)
except Exception as e:
    print(str(e))

General v3 Web API Usage (With Fluent Interface)

import os
from sendgrid import SendGridAPIClient

sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
response = sg.client.suppression.bounces.get()
print(response.status_code)
print(response.body)
print(response.headers)

General v3 Web API Usage (Without Fluent Interface)

import os
from sendgrid import SendGridAPIClient

sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
response = sg.client._('suppression/bounces').get()
print(response.status_code)
print(response.body)
print(response.headers)

Processing Inbound Email

Please see our helper for utilizing our Inbound Parse webhook.

Usage

• Twilio SendGrid Documentation

• Library Usage Documentation

• Example Code

• How-to: Migration from v2 to v3

• v3 Web API Mail Send Helper - build a request object payload for a v3 /mail/send API call.

• Processing Inbound Email

Use Cases

Examples of common API use cases, such as how to send an email with a transactional template or add an attachment or send an SMS message.

Announcements

All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email release notifications for releases and breaking changes.

How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

Quick links:

• Feature Request

• Bug Reports

• Improvements to the Codebase

• Review Pull Requests

Troubleshooting

Please see our troubleshooting guide for common library issues.

About

sendgrid-python is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-python are trademarks of Twilio SendGrid, Inc.

License

The MIT License (MIT)