Markdown template based HTML and text emails for Django.
Project description
Django eMark↓
Markdown template based HTML and text emails for Django.
- simple email templates with markdown
- support for HTML and text emails
- i18n support
- built-in UTM tracking
- automatic CSS inliner via premailer
Setup
python3 -m pip install emark
# settings.py
INSTALLED_APPS = [
'emark',
# ...
]
python3 manage.py migrate
Usage
<!-- myapp/my_message.md -->
# Hello World
Hi {{ user.short_name }}!
# myapp/emails.py
from emark.message import MarkdownEmail
class MyMessage(MarkdownEmail):
subject = "Hello World"
template_name = "myapp/my_message.md"
# myapp/views.py
from . import emails
def my_view(request):
message = emails.MyMessage.to_user(request.user)
message.send()
Templates
You can use Django's template engine, just like you usually would. You can use translations, template tags, filters, blocks, etc.
You may also have a base template, that you inherit form in your individual emails to provide a consistent salutation and farewell.
<!-- base.md -->
{% load static i18n %}
{% block salutation %}Hi {{ user.short_name }}!{% endblock %}
{% block content %}{% endblock %}
{% block farewell %}
{% blocktrans trimmed %}
Best regards,
{{ site_admin }}
{% endblocktrans %}
{% endblock %}
{% block footer %}
Legal footer.
{% endblock %}
<!-- myapp/email.md -->
{% extends "base.md" %}
{% block content %}
This is the content of the email.
{% endblock %}
Context
The context is passed to the template as a dictionary. Furthermore, you may
override the get_context_data method to add additional context variables.
# myapp/emails.py
from emark.message import MarkdownEmail
class MyMessage(MarkdownEmail):
subject = "Hello World"
template_name = "myapp/email.md"
def get_context_data(self):
context = super().get_context_data()
context["my_variable"] = "Hello World"
return context
Tracking
Every MarkdownEmail subclass comes with automatic UTM tracking.
UTM parameters are added to all links in the email. Existing UTM params on link
that have been explicitly set, are not overridden. The default parameters are:
utm_source:websiteutm_medium:emailutm_campaign:{{ EMAIL_CLASS_NAME }}
The global UTM parameters can be overridden via the EMARK_UTM_PARAMS setting,
which is a dictionary of parameters:
# settings.py
EMARK_UTM_PARAMS = {
"utm_source": "website", # default
"utm_medium": "email", # default
}
You may also change the UTM parameters by overriding the get_utm_params
or passing a utm_params dictionary to class constructor.
# myapp/emails.py
from emark.message import MarkdownEmail
class MyMessage(MarkdownEmail):
subject = "Hello World"
template_name = "myapp/email.md"
# override the parameters for this email class
def get_utm_params(self):
return {
"utm_source": "myapp",
"utm_medium": "email",
"utm_campaign": "my-campaign",
}
# or alternatively during instantiation
MyMessage(utm_params={"utm_campaign": "my-other-campaign"}).send()
Credits
- Django eMark uses modified version of Responsive HTML Email Template as a base template
- For CSS inlining, Django eMark uses premailer
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file emark-1.0rc6.tar.gz.
File metadata
- Download URL: emark-1.0rc6.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 85ed00ce4dd7e8bbd5c31b73339cc182060766c9fa7bbce7fae9d0cd49520327 |
|
| MD5 | ceed2d35eb26a92812c4ca3bcb45730e |
|
| BLAKE2b-256 | 73f39416caf08613763b634947e4ed0a05b9a4f67ac86f48c82d54ec660953fb |
File details
Details for the file emark-1.0rc6-py3-none-any.whl.
File metadata
- Download URL: emark-1.0rc6-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 596256493d667bec70a67c3cf1569ab973a5c7dbe4968ca6407a1cc474d236db |
|
| MD5 | 6ed43ce1fdeceff619780d01b8cd4f7c |
|
| BLAKE2b-256 | 4dc68897823e2b8e1ec8a7d91b3089e6ffa713c7c3f31e7c357ed21a7c9ee914 |
