The default branch name for this repository has been changed to main as of 07/27/2020.
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.
Please browse the rest of this README for further detail.
We appreciate your continued support, thank you!
Table of Contents
- Installation
- Quick Start
- Processing Inbound Email
- Usage
- Use Cases
- Announcements
- How to Contribute
- Troubleshooting
- About
- License
Installation
Prerequisites
- Python version 2.7, 3.5, 3.6, 3.7, or 3.8
- The SendGrid service, starting at the free level
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
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
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 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.
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 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)
General v3 Web API Usage (Without 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)
Processing Inbound Email
Please see our helper for utilizing our Inbound Parse webhook.
Usage
- 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.
Announcements
Please see our announcement regarding breaking changes. Your support is appreciated!
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:
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.
If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
11 Jan 13, 2022
4 Feb 06, 2022
6 Dec 25, 2022
164 Oct 20, 2022
1 Feb 07, 2022
108 Apr 27, 2022
3 Jul 15, 2022
1 Dec 07, 2021
129 Dec 30, 2022
1 Jan 07, 2022
21 Mar 30, 2022
1 Nov 21, 2021
535 Jan 04, 2023
25 Dec 02, 2022
30 Dec 04, 2022
128 Dec 06, 2022
260 Jan 01, 2023
2 Mar 01, 2022
52 Nov 29, 2022
10 Oct 31, 2022