Flask-SendGrid 0.5.0

Adds SendGrid support to Flask applications

flask-sendgrid
==============


<!-- [](https://pypi.python.org/pypi/Flask-SendGrid/) -->
<!-- [](https://pypi.python.org/pypi/Flask-SendGrid/) -->
[](https://pypi.python.org/pypi/Flask-SendGrid/)
[](https://travis-ci.org/frankV/flask-sendgrid)
[](https://coveralls.io/github/frankV/flask-sendgrid?branch=master)

Flask plugin to simplify sending emails through [SendGrid](https://sendgrid.com/). Adapted from [Flask-Mandrill](https://github.com/volker48/flask-mandrill)
to make migrating from Mandrill to SendGrid easier for developers.

Now updated to support SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint). Still maintains backwards compatibility with Flask-Mandrill `mail` function.

Existing `send_email` method does not support all functions of the newly updated SendGrid Mail (`sendgrid.helpers.mail.Mail`). Full support will be updated in a later release.


Installation
------------

pip install flask-sendgrid

Usage
-----
```python
from flask.ext.sendgrid import SendGrid

app = Flask(__name__)
app.config['SENDGRID_API_KEY'] = 'your api key'
app.config['SENDGRID_DEFAULT_FROM'] = '[e-mail]'
mail = SendGrid(app)

# send multiple recipients; backwards compatible with Flask-Mandrill
mail.send_email(
from_email='[e-mail]',
to_email=[{'email': '[e-mail]'}, {'email': '[e-mail]'}],
subject='Subject'
text='Body',
)

# send single recipient; single email as string
mail.send_email(
from_email='[e-mail]',
to_email='[e-mail]',
subject='Subject'
text='Body',
)

# send single recipient; single email as sendgrid.mail.helpers.Email object
mail.send_email(
from_email='[e-mail]',
to_email=Email('[e-mail]'),
subject='Subject'
text='Body',
)

# send multiple recipients; list of emails as sendgrid.mail.helpers.Email object
mail.send_email(
from_email='[e-mail]',
to_email=[Email('[e-mail]'), Email('[e-mail]')],
subject='Subject'
text='Body',
)
```

For additional information about mail parameters: [SendGrid Web API Mail](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html#-Request-Body-Parameters)


.. :changelog:

Release History
---------------

0.1.0 (2016-03-30)
++++++++++++++++++

- First release.