SendGrid library for Python
Project description
This library allows you to quickly and easily send emails through SendGrid using Python.
Warning
If you upgrade to version 1.2.x, the add_to method behaves differently. In the past this method defaulted to using the SMTPAPI header. Now you must explicitly call the smtpapi.add_to method. More on the SMTPAPI section.
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 2.0.0. You are encouraged to set raise_errors to True for forwards compatibility.
SendGridError is a base-class for all SendGrid-related exceptions.
Usage
To begin using this library create a new instance of SendGridClient with your SendGrid credentials or a SendGrid API Key. API Key is the preferred method. API Keys are in beta. To configure API keys, visit https://app.sendgrid.com/settings/api_keys.
sg = sendgrid.SendGridClient('sendgrid_username', 'sendgrid_password')
# or
sg = sendgrid.SendGridClient('sendgrid_apikey')Methods
There are multiple ways to add recipients:
add_to
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'])add_to_name
message = sendgrid.Mail()
message.add_to('example@email.com')
message.add_to_name('Example Dude')add_cc
message = sendgrid.Mail()
message.add_cc('example@email.com')
message.add_cc(['example@email.com', 'john@email.com'])add_bcc
message = sendgrid.Mail()
message.add_bcc('example@email.com')
# or
message.add_bcc(['Example Dude <example@email.com>', 'john@email.com'])set_from
message = sendgrid.Mail()
message.set_from('example@email.com')set_from_name
message = sendgrid.Mail()
message.set_from('example@email.com')
message.set_from_name('Example Dude')set_replyto
message.sendgrid.Mail()
message.set_replyto('example@email.com')set_subject
message = sendgrid.Mail()
message.set_subject('Example')set_text
message = sendgrid.Mail()
message.set_text('Body')set_html
message = sendgrid.Mail()
message.set_html('<html><body>Stuff, you know?</body></html>')set_date
message = sendgrid.Mail()
message.set_date('Wed, 17 Dec 2014 19:21:16 +0000')set_headers
message = sendgrid.Mail()
message.set_headers({'X-Sent-Using': 'SendGrid-API', 'X-Transport': 'web'});Set File Attachments
There are multiple ways to work with attachments:
add_attachment
message = sendgrid.Mail()
message.add_attachment('stuff.txt', './stuff.txt')
# or
message.add_attachment('stuff.txt', open('./stuff.txt', 'rb'))add_attachment_stream
message = sendgrid.Mail()
message.add_attachment_stream('filename', 'somerandomcontentyouwant')
# strings, unicode, or BytesIO streamsadd_content_id
message = sendgrid.Mail()
message.add_attachment('image.png', open('./image.png', 'rb'))
message.add_content_id('image.png', 'ID_IN_HTML')
message.set_html('<html><body>TEXT BEFORE IMAGE<img src="cid:ID_IN_HTML"></img>AFTER IMAGE</body></html>')SendGrid’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.
Recipients
message = sendgrid.Mail()
message.smtpapi.add_to('example@email.com')Substitution
message = sendgrid.Mail()
message.smtpapi.add_substitution('key', 'value')add_substitution
message = sendgrid.Mail()
message.add_substitution('key', 'value')set_substitutions
message = sendgrid.Mail()
message.set_substitutions({'key1': ['value1', 'value2'], 'key2': ['value3', 'value4']})Section
message = sendgrid.Mail()
message.smtpapi.add_section('section', 'value')add_section
message = sendgrid.Mail()
message.add_section('section', 'value')set_sections
message = sendgrid.Mail()
message.set_sections({'section1': 'value1', 'section2': 'value2'})Category
message = sendgrid.Mail()
message.smtpapi.add_category('category')add_category
message = sendgrid.Mail()
message.add_category('category')set_categories
message = sendgrid.Mail()
message.set_categories(['category1', 'category2'])Unique Arguments
message = sendgrid.Mail()
message.smtpapi.add_unique_arg('key', 'value')add_unique_arg
message = sendgrid.Mail()
message.add_unique_arg('key', 'value')set_unique_args
message = sendgrid.Mail()
message.set_unique_args({'key1': 'value1', 'key2': 'value2'})Filter
message = sendgrid.Mail()
message.smtpapi.add_filter('filter', 'setting', 'value')add_filter
message = sendgrid.Mail()
message.add_filter('filter', 'setting', 'value')ASM Group
message = sendgrid.Mail()
message.smtpapi.set_asm_group_id(value)set_asm_group_id
message = sendgrid.Mail()
message.set_asm_group_id(value)Using Templates from the Template Engine
message.add_filter('templates', 'enable', '1')
message.add_filter('templates', 'template_id', 'TEMPLATE-ALPHA-NUMERIC-ID')Tests
virtualenv venv
source venv/bin/activate
python setup.py install
python test/__init__.pyDeploying
Confirm tests pass
Bump the version in README.rst, sendgrid/version.py
Update CHANGELOG.md
Confirm tests pass
Commit Version bump vX.X.X
python setup.py sdist bdist_wininst upload
Push changes to GitHub
Release tag on GitHub vX.X.X
MIT 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
Hashes for sendgrid-1.4.2.macosx-10.10-intel.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e4a574057d94d97536d462bc8425dbf9c55a0baa37f68e4768987d59fc523665 |
|
| MD5 | ee76155a8357e6a7efa529f68a46d46c |
|
| BLAKE2b-256 | 8b8dffb0b1bb99961b1b471944137540d39c64d3f9ee6a7fd01b8c0d06b7cb5d |
