Skip to main content

Flask extension for sendgrid. It has same interface with Flask-Mail.

Project description

Flask extension for sendgrid. It has same interface with Flask-Mail.

Flask-Mail-SendGrid is friendly with another extention such as Flask-Security.

Installing Flask-Mail-SendGrid

Install with pypi:

$ pip install flask-mail-sendgrid

or install latest version:

$ git clone https://github.com/hamano/flask-mail-sendgrid.git
$ cd flask-mail-sendgrid
$ python setup.py install

Configuring Flask-Mail-SendGrid

  • MAIL_SENDGRID_API_KEY: API Key for SendGrid

  • MAIL_DEFAULT_SENDER: default sender

from flask import Flask
from flask_mail_sendgrid import MailSendGrid

app = Flask(__name__)
app.config['MAIL_SENDGRID_API_KEY'] = 'XXXXXXXX'
mail = MailSendGrid(app)

Sending messages

To send a message first create a Message instance:

from flask_mail import Message

@app.route("/")
def index():
    msg = Message("Hello",
                  sender="from@example.com",
                  recipients=["to@example.com"])

The message can contain a body and/or HTML:

msg.body = "testing"
msg.html = "<b>testing</b>"

Or, if you are using Templates in Sendgrid, you may specify a Template ID and Data:

msg.template_id = 'my-template-id'
msg.dynamic_template_data = {'first_name': 'John', 'last_name': 'Doe'}

Finally, to send the message, you use the Mail instance configured with your Flask application:

mail.send(msg)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Mail-SendGrid-0.1.8.tar.gz (2.8 kB view details)

Uploaded Source

File details

Details for the file Flask-Mail-SendGrid-0.1.8.tar.gz.

File metadata

File hashes

Hashes for Flask-Mail-SendGrid-0.1.8.tar.gz
Algorithm Hash digest
SHA256 e46f4c512a15395af0c29e8b3e232ae22dde50db387b95367f55841702ee6697
MD5 af94bd6726821ff08bb318d20ebc364c
BLAKE2b-256 c8ab3c08d366b61e3948a09ab29b13c706df344344da31f1dd44cffe3c0eb6d6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page