Skip to main content

Django Email Templates made easy

Project description

https://badge.fury.io/py/django-email.png https://travis-ci.org/swappsco/django-email.png?branch=master

Django Email Templates made easy

Current Version 0.1.9

Django email is a thin wrapper for django’s multialternative email sending. For this you will need to specify a plain text template (.txt) and an html version (.html). Django email takes your template and your context, renders it and sends the email, reducing the boilerplate required for sending an email.

We try to use defaults that make sense, but you can always adapt things to your needs. You can setup the subject, email from, email to and more.

Your templates must not have extension, but other than that we assume nothing.

Quickstart

Install Django Email:

pip install django-email

Then, add it to your installed apps:

INSTALLED_APPS += ('django_email',)

Then use it in a project:

from django_email import djemail

# Simple Usage
# Admin will receive a message
djemail.send_email(message="My Message", subject="The Subject")

# Send an email to a specific email
djemail.send_email(
        to="email@test.com",
        message="My Message",
        subject="The Subject")

# Advanced Usage
djemail.send_email(
    to="email@test.com",
    template_name="path/to/template", # .txt and/or .html
    context={'variable': 'Variable Content'},
    subject="My Subject"
)

Features

  • Send easy email to ADMINS.

  • Send TXT/HTML Email using a predefined template. (.txt template is mandatory)

  • Send Email using your own custom templates.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_test.txt
(myenv) $ python runtests.py

Credits

Tools used in rendering this package:

History

0.1.0 (2015-11-26)

  • First release.

0.1.1 (2016-07-01)

  • Fix issue with app loading on django 1.9.

0.1.2 (2016-07-20)

  • Implement method send_email().

0.1.3 (2016-07-22)

  • Deprecate email Template class

0.1.4 (2016-07-22)

  • Resolve issue with deprecated function

0.1.5 (2016-07-23)

  • Restructure project with Cookiecutter Django Package.

0.1.6 (2016-07-23)

  • Improve send_mail() method. Add Base templates and more modes to use.

0.1.7 (2016-08-01)

  • Bug fix for default Email template, updates example and tests.

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-0.1.9.tar.gz (10.4 kB view details)

Uploaded Source

File details

Details for the file django-email-0.1.9.tar.gz.

File metadata

File hashes

Hashes for django-email-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e4850e6e8088383b10ee871a8e412fb7026bdf35325a4fda6a8da7936d9c3111
MD5 db7c061f543037616467bc663f751616
BLAKE2b-256 0078fa5387f97fd5a054c68a47d1181d1cfa385223e2a6f37610bfa1252e46b1

See more details on using hashes here.

Provenance

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