SendGrid-django
Simple django backend to send email using SendGrid’s Web API.
Installation
Install the backend from PyPI:
pip install sendgrid-djangoAdd 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')
]
# Add categories
mail.categories = [
'work',
'urgent',
]
mail.attach_alternative(
"<p>This is a simple HTML email body</p>", "text/html"
)
mail.send()To create an instance of a SendGridBackend with an API key other than that provided in settings, pass api_key to the constructor
License
MIT
Enjoy :)
Development
- Install dependencies::
pip install -r requirements-dev.txt
- Run the tests with coverage::
pytest –cov=sgbackend
- If you see the error “No module named sgbackend”, run::
pip install -e .
2 maintainers
Metadata
2 maintainers
Release files for sendgrid-django 4.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sendgrid-django-4.2.0.tar.gz | 5.0 kB | Without provenance | Details |
Release files / sendgrid-django-4.2.0.tar.gz
| Download URL | sendgrid-django-4.2.0.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fef60ba37d588e5e1c4dcbb3b8b7f8c16920e3e89432de357f6abd6157c4f5f4
|
|
BLAKE2b-256 checksum How to use checksums |
f5944749ff4acae2c2ca89c5acdf8449494ef4fbc4254a705866f07c6774ea8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sendgrid-django 4.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
