Skip to content

lucassimon/sendgrid-django

 
 

Repository files navigation

SendGrid-django

Travis CI

codecov.io

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"
)

# Custom args
# Dictionary values must be a string

msg.custom_args = [
    {'invoice_code': '{}'.format(invoice.pk)},
    {'content_type': '{}'.format(ct.pk)},
    {'code': '{}'.format(invoice.code)},
]

mail.send()

License

MIT

Enjoy :)

About

Simple django backend to send email through SendGrid

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.3%
  • Makefile 0.7%