SendGrid library for Python
Project description
SendGrid-Python
===============
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
-------
.. code:: python
pip install sendgrid
# or
easy_install sendgrid
Example
-------
.. code:: python
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.
.. code:: python
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.
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://sendgrid.com/beta/settings/api_key.
.. code:: python
sg = sendgrid.SendGridClient('sendgrid_username', 'sendgrid_password')
# or
sg = sendgrid.SendGridClient('sendgrid_apikey')
Methods
~~~~~~~
There are multiple ways to add recipients:
add_to
^^^^^^
.. code:: python
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
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_to('example@email.com')
message.add_to_name('Example Dude')
add_cc
^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_cc('example@email.com')
message.add_cc(['example@email.com', 'john@email.com'])
add_bcc
^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_bcc('example@email.com')
# or
message.add_bcc(['Example Dude <example@email.com>', 'john@email.com'])
set_from
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_from('example@email.com')
set_from_name
^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_from('example@email.com')
message.set_from_name('Example Dude')
set_replyto
^^^^^^^^^^^
.. code:: python
message.sendgrid.Mail()
message.set_replyto('example@email.com')
set_subject
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_subject('Example')
set_text
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_text('Body')
set_html
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_html('<html><body>Stuff, you know?</body></html>')
set_date
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_date('Wed, 17 Dec 2014 19:21:16 +0000')
set_headers
^^^^^^^^^^^
.. code:: python
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
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_attachment('stuff.txt', './stuff.txt')
# or
message.add_attachment('stuff.txt', open('./stuff.txt', 'rb'))
add_attachment_stream
^^^^^^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_attachment_stream('filename', 'somerandomcontentyouwant')
# strings, unicode, or BytesIO streams
add_content_id
^^^^^^^^^^^^^^
.. code:: python
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`_
~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_to('example@email.com')
`Substitution`_
~~~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_substitution('key', 'value')
add_substitution
^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_substitution('key', 'value')
set_substitutions
^^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_substitutions({'key1': ['value1', 'value2'], 'key2': ['value3', 'value4']})
`Section`_
~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_section('section', 'value')
add_section
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_section('section', 'value')
set_sections
^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_sections({'section1': 'value1', 'section2': 'value2'})
`Category`_
~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_category('category')
add_category
^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_category('category')
set_categories
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_categories(['category1', 'category2'])
`Unique Arguments`_
~~~~~~~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_unique_arg('key', 'value')
add_unique_arg
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_unique_arg('key', 'value')
set_unique_args
^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_unique_args({'key1': 'value1', 'key2': 'value2'})
`Filter`_
~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_filter('filter', 'setting', 'value')
add_filter
^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_filter('filter', 'setting', 'value')
`ASM Group`_
~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.set_asm_group_id(value)
set_asm_group_id
^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_asm_group_id(value)
Using Templates from the Template Engine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
message.add_filter('templates', 'enable', '1')
message.add_filter('templates', 'template_id', 'TEMPLATE-ALPHA-NUMERIC-ID')
Tests
~~~~~
.. code:: python
python test/__init__.py
MIT License
-----------
.. _X-SMTPAPI: http://sendgrid.com/docs/API_Reference/SMTP_API/
.. _SMTPAPI Python library: https://github.com/sendgrid/smtpapi-python
.. _Substitution: http://sendgrid.com/docs/API_Reference/SMTP_API/substitution_tags.html
.. _Section: http://sendgrid.com/docs/API_Reference/SMTP_API/section_tags.html
.. _Category: http://sendgrid.com/docs/Delivery_Metrics/categories.html
.. _Unique Arguments: http://sendgrid.com/docs/API_Reference/SMTP_API/unique_arguments.html
.. _Filter: http://sendgrid.com/docs/API_Reference/SMTP_API/apps.html
===============
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
-------
.. code:: python
pip install sendgrid
# or
easy_install sendgrid
Example
-------
.. code:: python
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.
.. code:: python
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.
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://sendgrid.com/beta/settings/api_key.
.. code:: python
sg = sendgrid.SendGridClient('sendgrid_username', 'sendgrid_password')
# or
sg = sendgrid.SendGridClient('sendgrid_apikey')
Methods
~~~~~~~
There are multiple ways to add recipients:
add_to
^^^^^^
.. code:: python
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
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_to('example@email.com')
message.add_to_name('Example Dude')
add_cc
^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_cc('example@email.com')
message.add_cc(['example@email.com', 'john@email.com'])
add_bcc
^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_bcc('example@email.com')
# or
message.add_bcc(['Example Dude <example@email.com>', 'john@email.com'])
set_from
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_from('example@email.com')
set_from_name
^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_from('example@email.com')
message.set_from_name('Example Dude')
set_replyto
^^^^^^^^^^^
.. code:: python
message.sendgrid.Mail()
message.set_replyto('example@email.com')
set_subject
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_subject('Example')
set_text
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_text('Body')
set_html
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_html('<html><body>Stuff, you know?</body></html>')
set_date
^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_date('Wed, 17 Dec 2014 19:21:16 +0000')
set_headers
^^^^^^^^^^^
.. code:: python
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
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_attachment('stuff.txt', './stuff.txt')
# or
message.add_attachment('stuff.txt', open('./stuff.txt', 'rb'))
add_attachment_stream
^^^^^^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_attachment_stream('filename', 'somerandomcontentyouwant')
# strings, unicode, or BytesIO streams
add_content_id
^^^^^^^^^^^^^^
.. code:: python
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`_
~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_to('example@email.com')
`Substitution`_
~~~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_substitution('key', 'value')
add_substitution
^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_substitution('key', 'value')
set_substitutions
^^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_substitutions({'key1': ['value1', 'value2'], 'key2': ['value3', 'value4']})
`Section`_
~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_section('section', 'value')
add_section
^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_section('section', 'value')
set_sections
^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_sections({'section1': 'value1', 'section2': 'value2'})
`Category`_
~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_category('category')
add_category
^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_category('category')
set_categories
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_categories(['category1', 'category2'])
`Unique Arguments`_
~~~~~~~~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_unique_arg('key', 'value')
add_unique_arg
^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_unique_arg('key', 'value')
set_unique_args
^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_unique_args({'key1': 'value1', 'key2': 'value2'})
`Filter`_
~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.add_filter('filter', 'setting', 'value')
add_filter
^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.add_filter('filter', 'setting', 'value')
`ASM Group`_
~~~~~~~~~~~~
.. code:: python
message = sendgrid.Mail()
message.smtpapi.set_asm_group_id(value)
set_asm_group_id
^^^^^^^^^^^^^^^^
.. code:: python
message = sendgrid.Mail()
message.set_asm_group_id(value)
Using Templates from the Template Engine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
message.add_filter('templates', 'enable', '1')
message.add_filter('templates', 'template_id', 'TEMPLATE-ALPHA-NUMERIC-ID')
Tests
~~~~~
.. code:: python
python test/__init__.py
MIT License
-----------
.. _X-SMTPAPI: http://sendgrid.com/docs/API_Reference/SMTP_API/
.. _SMTPAPI Python library: https://github.com/sendgrid/smtpapi-python
.. _Substitution: http://sendgrid.com/docs/API_Reference/SMTP_API/substitution_tags.html
.. _Section: http://sendgrid.com/docs/API_Reference/SMTP_API/section_tags.html
.. _Category: http://sendgrid.com/docs/Delivery_Metrics/categories.html
.. _Unique Arguments: http://sendgrid.com/docs/API_Reference/SMTP_API/unique_arguments.html
.. _Filter: http://sendgrid.com/docs/API_Reference/SMTP_API/apps.html
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
sendgrid-1.4.0.tar.gz
(7.7 kB
view hashes)
Built Distribution
Close
Hashes for sendgrid-1.4.0.macosx-10.10-x86_64.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd439559403fda8f17576f89be9f11074029b4698e2dceecd7ec4a5ab10694c3 |
|
| MD5 | a64fed2e221fc3e80767820164011970 |
|
| BLAKE2b-256 | 6ebbf3869bbf50a127fd550c71f3134ab8752f275f41013fbfda371bb31f035d |
