Skip to main content

A Django email backend for the SendGrid API

Project description

A Django email backend for the SendGrid API

https://travis-ci.org/jtstio/django-sgapi.svg?branch=master https://codecov.io/gh/jtstio/django-sgapi/branch/master/graph/badge.svg https://badge.fury.io/py/django-sgapi.svg

Installation

Install the backend from PyPI:

pip install django-sgapi

Add the following to your project’s settings.py:

EMAIL_BACKEND = "sgbackend.SendGridBackend"
SENDGRID_API_KEY = "Your SendGrid API Key"

Done!

Example

from django.core.mail import send_mail
from django.core.mail import EmailMultiAlternatives

# Send a simple message
send_mail('Hello there!', 'Emails are the future!',
  'Jay Hale <jay@jtst.io>', ['hello@sink.sendgrid.net'])

# Send a more complex message
mail = EmailMultiAlternatives(
  subject='Hello there again!',
  body='Who knew you could do so many things with email?!?',
  from_email='Jay Hale <jay@jtst.io>',
  to=['hello@sink.sendgrid.net'],
)
mail.reply_to = 'No Reply <no-reply@sink.sendgrid.net>'
mail.template_id = 'marketing_template_5'
mail.substitutions = {'%organization%': 'jtstio'}
with open('flyer.pdf', 'rb') as file:
    mail.attachments = [
        ('flyer.pdf', file.read(), 'application/pdf')
    ]
mail.attach_alternative(
    "<p>Who knew you could do <strong>so many things</strong> with email?!?</p>",
    "text/html"
)
mail.send()

Attribution

sendgrid-django-v5: An alternative implementation you should check out

sendgrid-django: Basis for this implementation

sendgrid-python: Python SendGrid connector

License

MIT

Enjoy :)

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

django-sgapi-2.0.0.tar.gz (4.3 kB view details)

Uploaded Source

File details

Details for the file django-sgapi-2.0.0.tar.gz.

File metadata

  • Download URL: django-sgapi-2.0.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-sgapi-2.0.0.tar.gz
Algorithm Hash digest
SHA256 7f37918857de3e53a190aab5fe6cc80f1aefb57d0baa5c94f39267fd485335b0
MD5 e238c626ba84c2c6f5b33ba42de4e542
BLAKE2b-256 b36e8cb59f968a0f117163d3c61b8bd806c56c3f13379610068302334f5904d7

See more details on using hashes here.

Supported by

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