SendGrid library for Python
Project description
This library allows you to quickly and easily send emails through SendGrid using Python.
Warning! This library was recently updated to bring it up to date with all of our other libraries. It behaves completely different from the previous release. Also, SMTP has been deprecated in support for the Web API.
Install
pip install sendgrid
# or
easy_install sendgridExample
import sendgrid
sg = sendgrid.SendGridClient('YOUR_SENDGRID_USERNAME', 'YOUR_SENDGRID_PASSWORD')
message = sendgrid.Mail()
message.add_to('John Doe <john@email.com>')
message.set_subject('Example')
message.set_html('Body')
message.set_text('Body')
message.set_from('Doe John <doe@email.com>')
status, msg = sg.send(message)
#or
message = sendgrid.Mail(to='john@email.com', subject='Example', html='Body', text='Body', from_email='doe@email.com')
status, msg = sg.send(message)Error handling
By default, .send method returns a tuple (http_status_code, message), however you can pass raise_errors=True to SendGridClient constructor, then .send method will raise SendGridClientError for 4xx errors, and SendGridServerError for 5xx errors.
from sendgrid import SendGridError, SendGridClientError, SendGridServerError
sg = sendgrid.SendGridClient(username, password, raise_errors=True)
try:
sg.send(message)
except SendGridClientError:
...
except SendGridServerError:
...This behavior is going to be default from version 1.0.0. You are encouraged to set raise_errors to True for forwards compatibility.
SendGridError is a base-class for all SendGrid-related exceptions.
Adding Recipients
message = sendgrid.Mail()
message.add_to('example@email.com')
# or
message.add_to('Example Dude <example@email.com>')
# or
message.add_to(['Example Dude <example@email.com>', 'john@email.com'])Adding BCC Recipients
message = sendgrid.Mail()
message.add_bcc('example@email.com')
# or
message.add_bcc(['Example Dude <example@email.com>', 'john@email.com'])Setting the Subject
message = sendgrid.Mail()
message.set_subject('Example')Set Text or HTML
message = sendgrid.Mail()
message.set_text('Body')
# or
message.set_html('<html><body>Stuff, you know?</body></html>')Set From
message = sendgrid.Mail()
message.set_from('example@email.com')Set ReplyTo
message.sendgrid.Mail()
message.set_replyto('example@email.com')Set File Attachments
message = sendgrid.Mail()
message.add_attachment('stuff.txt', './stuff.txt')
# or
message.add_attachment('stuff.txt', open('./stuff.txt', 'rb'))
# or
message.add_attachment_stream('filename', 'somerandomcontentyouwant')
# strings, unicode, or BytesIO streamsSendGrid’s X-SMTPAPI
If you wish to use the X-SMTPAPI on your own app, you can use the SMTPAPI Python library.
There are implementations for setter methods too.
Substitution
message = sendgrid.Mail()
message.add_substitution("key", "value")Section
message = sendgrid.Mail()
message.add_section("section", "value")Category
message = sendgrid.Mail()
message.add_category("category")Unique Arguments
message = sendgrid.Mail()
message.add_unique_arg("key", "value")Filter
message = sendgrid.Mail()
message.add_filter("filter", "setting", "value")TODO:
Add support for CID
Tests
python test/__init__.pyMIT License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sendgrid-1.1.0.tar.gz.
File metadata
- Download URL: sendgrid-1.1.0.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0dc31046dc049242026613abb8b62bfc015ae815ade91d06b98caefed2b1ab0
|
|
| MD5 |
baa12c9e42c4ca94df6c65c2a3dc9efb
|
|
| BLAKE2b-256 |
0e522906b66ec45bfa54e07f196405a4a2e6e923371e885a12de60cf3786d728
|
File details
Details for the file sendgrid-1.1.0.macosx-10.9-intel.exe.
File metadata
- Download URL: sendgrid-1.1.0.macosx-10.9-intel.exe
- Upload date:
- Size: 74.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc8c60f2c9d22e75c43bda714ff3bbac5026898c9a4f2c94d1b96215e2693e0a
|
|
| MD5 |
5c1ad28656695e59bd3dfe17c744f3e1
|
|
| BLAKE2b-256 |
9d8acfec8c844b26b73e00d34a3700204ffe8b97b7a34157a975e4d6377076f9
|
