This library allows you to quickly and easily use the SendGrid Web API v3 via Python.
Version 3.X.X+ of this library provides full support for all SendGrid Web API v3 endpoints, including the new v3 /mail/send.
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and 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.
If you need help using SendGrid, please check the Twilio SendGrid Support Help Center.
Please browse the rest of this README for further detail.
- Installation
- Quick Start
- Processing Inbound Email
- Usage
- Use Cases
- Announcements
- How to Contribute
- Troubleshooting
- About
- Support
- License
- Python version 2.7+
- The SendGrid service, starting at the free level
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
SendGrid also supports local environment file .env. Copy or rename .env_sample into .env and update SENDGRID_API_KEY with your key.
Temporarily set the environment variable(accessible only during the current cli session):
set SENDGRID_API_KEY=YOUR_API_KEYPermanently set the environment variable(accessible in all subsequent cli sessions):
setx SENDGRID_API_KEY "YOUR_API_KEY"pip install sendgrid
The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):
import sendgrid import os from sendgrid.helpers.mail import * sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY')) from_email = Email("[email protected]") to_email = To("[email protected]") subject = "Sending with SendGrid is Fun" content = Content("text/plain", "and easy to do anywhere, even with Python") mail = Mail(from_email, to_email, subject, content) response = sg.client.mail.send.post(request_body=mail.get()) print(response.status_code) print(response.body) print(response.headers)
The Mail constructor creates a personalization object for you. Here is an example of how to add it.
The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):
import sendgrid import os sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY')) data = { "personalizations": [ { "to": [ { "email": "[email protected]" } ], "subject": "Sending with SendGrid is Fun" } ], "from": { "email": "[email protected]" }, "content": [ { "type": "text/plain", "value": "and easy to do anywhere, even with Python" } ] } response = sg.client.mail.send.post(request_body=data) print(response.status_code) print(response.body) print(response.headers)
General v3 Web API Usage (With Fluent Interface)
import sendgrid import os sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY')) response = sg.client.suppression.bounces.get() print(response.status_code) print(response.body) print(response.headers)
import sendgrid import os sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY')) response = sg.client._("suppression/bounces").get() print(response.status_code) print(response.body) print(response.headers)
Please see our helper for utilizing our Inbound Parse webhook.
- 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
Examples of common API use cases, such as how to send an email with a transactional template.
All updates to this library are documented in our CHANGELOG and releases.
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Quick links:
Please see our troubleshooting guide for common library issues.
sendgrid-python is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-python are trademarks of Twilio SendGrid, Inc.
If you need support, please check the Twilio SendGrid Support Help Center.