Skip to main content

django-email-utils

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)

Metadata

Release files for django-email-utils 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-email-utils 1.0.0
File Size Uploaded Provenance
django-email-utils-1.0.0.tar.gz 4.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for django-email-utils 1.0.0
File Interpreter ABI Platform
django_email_utils-1.0.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 10.2 kB

Release files / django-email-utils-1.0.0.tar.gz

Download URL django-email-utils-1.0.0.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
449c07ea11f5fc0e882d20a82c408a79064c55355cc81ae1ac3278752e891d5f
BLAKE2b-256 checksum
How to use checksums
a06540a60d55aa2cc93dd5a806bcad5486bd8fe672a96c0a6b599dd772ed4f83
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / django_email_utils-1.0.0-py2.py3-none-any.whl

Download URL django_email_utils-1.0.0-py2.py3-none-any.whl
Size 5.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
cc5b5627c25acd02898bafb25c9ed98e61d4755c45952cda4caeff4d1900068c
BLAKE2b-256 checksum
How to use checksums
ea5187c302a8b33802be62d156f39ee4e20af23aa48c9bb21fbca2f8acbb4be4
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for django-email-utils 1.0.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.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page