Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
.. image:: https://travis-ci.org/elbuo8/sendgrid-django.svg?branch=master :target: https://travis-ci.org/elbuo8/sendgrid-django :alt: Travis CI .. image:: https://codecov.io/github/elbuo8/sendgrid-django/coverage.svg?branch=master :target: https://codecov.io/github/elbuo8/sendgrid-django :alt: codecov.io
Simple django backend to send email using SendGrid's Web API.
Install the backend from PyPI:
.. code:: bash
pip install sendgrid-django
Add the following to your project's settings.py:
.. code:: python
EMAIL_BACKEND = "sgbackend.SendGridBackend"
SENDGRID_API_KEY = "Your SendGrid API Key"
Done!
.. code:: python
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
.. code::python
from sgbackend import SendGridBackend
from django.core.mail import send_mail
connection = SendGridBackend(api_key='your key')
send_mail(<subject etc>, connection=connection)
MIT
Enjoy :)
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 .
FAQs
SendGrid Backend for Django
We found that sendgrid-django demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.