Skip to main content

Django utility for sending email messages.

Project description

Travis CI Status Codecov PyPI GitHub License

A utility function to ease the process of sending templated emails with Django.

Requirements

  • Python version 3.5 or higher

  • Django version 2.2 or higher

Installation

Install from PyPI:

pip install django-email-utils

Usage

email_utils.send_email(template_name, context=None, **kwargs)

Send templated emails containing HTML, plain text, or both. The function is a thin wrapper around Django’s send_mail function that loads the email content from a template.

Example:

from email_utils import send_email


send_email(
    context={'foo': 'bar'},
    from_email='no-reply@myproject.com',
    recipient_list=['test@example.com'],
    subject='My Templated Email',
    template_name='myapp/template',
)

Parameters

template_name

The base name of the templates to use. The function then looks for the templates {template_name}.html and {template_name}.txt.

context

The context used to render the templates. Defaults to an empty dictionary.

**kwargs

Additional keyword arguments to pass to Django’s send_mail function.

Raises

email_utils.NoTemplatesException

If neither the HTML nor plain text templates are found.

Testing

Tests are run using pytest. To run the tests, install the requirements and then execute the tests:

pip install -r requirements/test.txt
pytest

License

This project is licensed under the MIT License.

Authors

Chathan Driehuys (chathan@driehuys.com)

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-email-utils-1.0.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

django_email_utils-1.0.0-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-email-utils-1.0.0.tar.gz.

File metadata

  • Download URL: django-email-utils-1.0.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

File hashes

Hashes for django-email-utils-1.0.0.tar.gz
Algorithm Hash digest
SHA256 449c07ea11f5fc0e882d20a82c408a79064c55355cc81ae1ac3278752e891d5f
MD5 020700a23d7473b734ec6003d4ef08e6
BLAKE2b-256 a06540a60d55aa2cc93dd5a806bcad5486bd8fe672a96c0a6b599dd772ed4f83

See more details on using hashes here.

File details

Details for the file django_email_utils-1.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: django_email_utils-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

File hashes

Hashes for django_email_utils-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cc5b5627c25acd02898bafb25c9ed98e61d4755c45952cda4caeff4d1900068c
MD5 7b93e682ea37950608fe92f29375c176
BLAKE2b-256 ea5187c302a8b33802be62d156f39ee4e20af23aa48c9bb21fbca2f8acbb4be4

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