Skip to main content

SendGrid Backend for Django

Project description

Simple django backend to send email using SendGrid’s Web API.

Installation

Install the backend from PyPI:

pip install sendgrid-django

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_mail("Your Subject", "This is a simple text email body.",
  "Yamil Asusta <hello@yamilasusta.com>", ["yamil@sendgrid.com"])

# or
mail = EmailMultiAlternatives(
  subject="Your Subject",
  body="This is a simple text email body.",
  from_email="Yamil Asusta <hello@yamilasusta.com>",
  to=["yamil@sendgrid.com"],
  headers={"Reply-To": "support@sendgrid.com"}
)
# Add template
mail.template_id = 'YOUR TEMPLATE ID FROM SENDGRID ADMIN'

# Replace substitutions in sendgrid template
mail.substitutions = {'%username%': 'elbuo8'}

# Attach file
with open('somefilename.pdf', 'rb') as file:
    mail.attachments = [
        ('somefilename.pdf', file.read(), 'application/pdf')
    ]

mail.attach_alternative(
    "<p>This is a simple HTML email body</p>", "text/html"
)

mail.send()

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

sendgrid-django-4.0.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file sendgrid-django-4.0.2.tar.gz.

File metadata

File hashes

Hashes for sendgrid-django-4.0.2.tar.gz
Algorithm Hash digest
SHA256 25a0375e450a120e7b8ab663b9a41b44db90823c7b698266c7d2e8b35c2debc6
MD5 8c4a09a07371285c5647a65ce3d98859
BLAKE2b-256 16ed8f9dcf01caaa8b8e2b99606c064b15457c34d26f11c0f5c30dd9d4334b34

See more details on using hashes here.

File details

Details for the file sendgrid-django-4.0.2.macosx-10.11-x86_64.tar.gz.

File metadata

File hashes

Hashes for sendgrid-django-4.0.2.macosx-10.11-x86_64.tar.gz
Algorithm Hash digest
SHA256 6241f3cf68f75b9ea8b98ee122c4e0428f855167cc5fbc84870415bfd2c03f98
MD5 1a33e2e07d9fd1e48959b77ee55ea180
BLAKE2b-256 48fe9c1bf892e207f1cc5914740e51cd0063727990e10d68b735f284562d367e

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