Usage Guide¶

Installation¶

To install django-templated-email-md, run the following command:

pip install django-templated-email-md

Configuration¶

1. Add to `INSTALLED_APPS`¶

Add templated_email_md to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    'templated_email_md',
    # ...
]

2. Update Settings¶

Assuming you have already installed and configured django-templated-email, update your Django settings as follows:

# settings.py

# Configure the templated email backend
TEMPLATED_EMAIL_BACKEND = 'templated_email_md.backend.MarkdownTemplateBackend'

# Specify the base HTML template for wrapping your content
TEMPLATED_EMAIL_BASE_HTML_TEMPLATE = 'templated_email/markdown_base.html'

# Set the directory where your email templates are stored
TEMPLATED_EMAIL_TEMPLATE_DIR = 'templated_email/'  # Ensure there's a trailing slash

# Define the file extension for your Markdown templates
TEMPLATED_EMAIL_FILE_EXTENSION = 'md'

# Optional: Specify Markdown extensions if needed
TEMPLATED_EMAIL_MARKDOWN_EXTENSIONS = [
    'markdown.extensions.extra',
    'markdown.extensions.meta',
    'markdown.extensions.tables',
]

3. Ensure Template Loaders Include `APP_DIRS`¶

Make sure that your TEMPLATES setting includes APP_DIRS set to True or includes the django.template.loaders.app_directories.Loader:

# settings.py

TEMPLATES = [
    {
        # ...
        'APP_DIRS': True,
        # ...
    },
]

Creating Markdown Templates¶

Place your Markdown email templates in the templated_email/ directory within your project’s templates directory or within an app’s templates directory.

Example Template: `templated_email/welcome.md`¶

Note: The subject and preheader can be provided as template blocks or as context arguments when sending email.

{% load i18n %}

{% block subject %}{% trans "Welcome to Our Service" %}{% endblock %}

{% block preheader %}{% trans "Thanks for signing up!" %}{% endblock %}

{% block content %}
# {% trans "Welcome" %}, {{ user.first_name }}!

{% trans "We're thrilled to have you join our service. Here are a few things you can do to get started:" %}

1. **{% trans "Complete your profile" %}**
2. **{% trans "Explore our features" %}**
3. **{% trans "Connect with other users" %}**

{% trans "If you have any questions, don't hesitate to reach out to our support team." %}

{% trans "Best regards," %}
{% trans "The Team" %}
{% endblock %}

Template Blocks¶

subject: Defines the email subject line.
preheader (optional): A short summary text that follows the subject line when viewing the email in an inbox.
content: The main content of your email.

Using Django Template Syntax¶

You can use Django’s template language within your Markdown templates to make each email dynamic.

Sending Emails¶

Use the send_templated_mail function from django-templated-email to send emails using your Markdown templates:

from templated_email import send_templated_mail

send_templated_mail(
    template_name='welcome',
    from_email='from@example.com',
    recipient_list=['to@example.com'],
    context={
        'user': user_instance,
        # Add other context variables as needed
    },
)

Remember to provide all necessary context variables when sending the email.

Important Notes¶

Context Variables: Ensure that all variables used in your templates are provided in the context dictionary.
Template Name: Do not include the file extension when specifying the template_name.

Advanced Usage¶

Custom Base Template¶

While we recommend you stick with the provided base template, you can create a custom base HTML template to wrap your Markdown content. This allows you to define the overall structure and style of your emails.

There are two ways to achieve this:

Template Overrides: Within the templates/ directory in your project’s base directory, create a templated_email/ directory. Then add a markdown_base.html file to serve as the base template. This will override the default base template from the package.
Custom Base Template: Place your custom base HTML template elsewhere and update the TEMPLATED_EMAIL_BASE_HTML_TEMPLATE setting to point to it.

Example: `templated_email/markdown_base.html`¶

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>{{ subject }}</title>
    <style>
        /* Include your CSS styles here */
    </style>
</head>
<body>
    {% spaceless %}
        {% block content %}{{ markdown_content|safe }}{% endblock %}
    {% endspaceless %}
</body>
</html>

Update the TEMPLATED_EMAIL_BASE_HTML_TEMPLATE setting if you use a custom template in a different location:

TEMPLATED_EMAIL_BASE_HTML_TEMPLATE = 'templated_email/markdown_base.html'

Inline Styles¶

The MarkdownTemplateBackend uses Premailer to inline CSS styles for better email client compatibility.

Include <style> Tags: Place your CSS styles within <style> tags in your base HTML template.
External CSS Files: External CSS files are not recommended for emails due to limited support in email clients.

Plain Text Version¶

A plain text version of your email is automatically generated using html2text.

Customization: If you need to customize the plain text output, you can override the _generate_plain_text method in a subclass of MarkdownTemplateBackend.
Links and Formatting: By default, links are preserved, and markdown formatting is converted to plain text.

Template Inheritance¶

You can leverage Django’s template inheritance in your Markdown templates.

Base Template: `templated_email/base_email.md`¶

{% block subject %}Default Subject{% endblock %}

{% block preheader %}Default Preheader{% endblock %}

{% block content %}
Default content.
{% endblock %}

Child Template: `templated_email/custom_email.md`¶

{% extends "templated_email/base_email.md" %}

{% block subject %}Custom Email Subject{% endblock %}

{% block content %}
# Custom Content

This is a custom email.
{% endblock %}

Using Django Template Tags and Filters¶

Your Markdown templates can include Django’s template tags and filters.

Example with Logic and Filters¶

{% block content %}
{% if user.is_premium %}
# Welcome, Premium User!

Thank you for subscribing to our premium service.

{% else %}
# Welcome!

Consider upgrading to our premium service for more benefits.
{% endif %}

Your username is: **{{ user.username|lower }}**
{% endblock %}

Internationalization (i18n) and Translated Emails¶

To send emails in different languages using internationalization (i18n), you need to:

Use Translation Tags in Templates: Wrap translatable text in trans or blocktrans tags.
Set Up Translation Files: Generate and compile message files for each language.
Activate the Desired Language: Use translation.override(language_code) when sending the email.
Ensure Thread Safety with Celery: Activate the language within the task function if using asynchronous tasks.

1. Use Translation Tags in Your Templates¶

Include the {% load i18n %} tag and wrap text for translation.

{% load i18n %}

{% block subject %}{% trans "Welcome to Our Service" %}{% endblock %}

{% block preheader %}{% trans "Thanks for signing up!" %}{% endblock %}

{% block content %}
# {% trans "Welcome" %}, {{ user.first_name }}!

{% trans "We're thrilled to have you join our service. Here are a few things you can do to get started:" %}

1. **{% trans "Complete your profile" %}**
2. **{% trans "Explore our features" %}**
3. **{% trans "Connect with other users" %}**

{% trans "If you have any questions, don't hesitate to reach out to our support team." %}

{% trans "Best regards," %}
{% trans "The Team" %}
{% endblock %}

2. Set Up and Compile Translation Files¶

Use Django’s makemessages and compilemessages commands.

Note, to include the “.md” files, you may need to add the --extension md or -e md flag.

# For Spanish translations of Markdown files
django-admin makemessages -l es -e md
# After translating the strings in locale/es/LC_MESSAGES/django.po
django-admin compilemessages

3. Activate the Desired Language When Sending the Email¶

Use translation.override(language_code) to temporarily set the language.

from templated_email import send_templated_mail
from django.utils import translation

def send_translated_email(user):
    # Assume user.preferred_language contains the language code, e.g., 'es' for Spanish
    language_code = user.preferred_language

    # Activate the desired language
    with translation.override(language_code):
        send_templated_mail(
            template_name='welcome',
            from_email='from@example.com',
            recipient_list=[user.email],
            context={
                'user': user,
                # Add other context variables as needed
            },
        )

4. Using Celery for Asynchronous Email Sending¶

When sending emails asynchronously with Celery, activate the language within the task function to ensure thread safety.

from celery import shared_task
from templated_email import send_templated_mail
from django.utils import translation
from django.contrib.auth import get_user_model

User = get_user_model()

@shared_task
def send_translated_email_task(user_id):
    user = User.objects.get(id=user_id)
    language_code = user.preferred_language

    with translation.override(language_code):
        send_templated_mail(
            template_name='welcome',
            from_email='from@example.com',
            recipient_list=[user.email],
            context={
                'user': user,
            },
        )

5. Handle Fallback Languages¶

Optionally, provide a default language if the user’s preferred language is not supported.

supported_languages = ['en', 'es', 'fr']  # List of supported language codes
language_code = user.preferred_language if user.preferred_language in supported_languages else 'en'

with translation.override(language_code):
    # Send email as before

Additional Considerations¶

Load the i18n Template Tag Library: Include {% load i18n %} at the top of your templates.
Use blocktrans for Blocks of Text: Use {% blocktrans %} when translating longer blocks that may include variables.
Keep Translations Updated: Whenever you change text in your templates or code, regenerate and recompile your message files.
Provide Translations for All Strings: Ensure all strings in templates and code are marked for translation.

Edge Cases and Considerations¶

Default Subject and Preheader¶

Providing Defaults: If the subject and preheader blocks are not defined in the template, the default values are used.
Customizing Defaults: You can set default values for the subject and preheader in the context when sending the email.

Settings¶

You can also set default values for the subject and preheader in your Django settings. These are used if a value is not provided in the template or context, or if you have set fail_silently to True and an error occurs.

TEMPLATED_EMAIL_DEFAULT_SUBJECT = 'Default Subject'
TEMPLATED_EMAIL_DEFAULT_PREHEADER = 'Default Preheader'

If not set, the default value for subject is 'Hello!' and for preheader is ''.

Subject Overriding¶

From Context: You can override the subject by providing a subject key in the context.
Priority: The subject in the context takes precedence over the one defined in the template.

Example¶

send_templated_mail(
    template_name='welcome',
    from_email='from@example.com',
    recipient_list=['to@example.com'],
    context={
        'user': user_instance,
        'subject': 'Custom Subject Line',
    },
)

URL Template Tags and Relative URLs¶

In order to include URLs in your emails, you can use Django’s URL template tags or pass the URL as a context variable.

In either case, to transform relative URLs into absolute URLs, you can set the TEMPLATED_EMAIL_BASE_URL setting in your Django settings, or for more flexibility, you can add a base_url argument to the send_templated_mail function. This will be used to prepend relative URLs in your email templates.

Example¶

send_templated_mail(
    template_name='welcome',
    from_email="from@example.com",
        recipient_list=["to@example.com"],
        context={
            "user": user_instance,
        },
        base_url="http://example.com",
    )

Code and code blocks¶

When working with templates that include code snippets that should be rendered verbatim in the resulting email combined with Django template tags, the Django template engine will attempt to interpret and render these tags, which can lead to errors or unintended behavior.

This section applies to all of the following examples:

    <code>{% url %}</code>

    <code>{{ url }}</code>

    `{% url %}`

    `{{ url }}`

    ```html
    {% url %}
    ```

    ```html
    {{ url }}
    ```

To prevent django-templated-email-md from processing the content inside code blocks, you can wrap the relevant content with Django’s built-in {% verbatim %} template tag.

Example¶

{% block content %}
    Here is some code:

    {% verbatim %}
    <code>{% url %}</code>
    {% endverbatim %}

    Another code snippet:

    {% verbatim %}
    `{{ url }}`
    {% endverbatim %}

    And a code block:

    {% verbatim %}
    ```python
    {{ url }
    ```
    {% endverbatim %}

    More content here.
{% endblock %}

Context Variables¶

Missing Variables: If a variable used in the template is missing from the context, the email rendering will fail unless fail_silently is set to True.
Providing All Variables: Ensure all variables and conditions in your templates are accounted for in the context.

Markdown Extensions¶

Default Extensions: The backend uses a set of default Markdown extensions.
Customization: You can customize the Markdown extensions via the TEMPLATED_EMAIL_MARKDOWN_EXTENSIONS setting.

Example¶

TEMPLATED_EMAIL_MARKDOWN_EXTENSIONS = [
    'markdown.extensions.extra',
    'markdown.extensions.codehilite',
]

Customizing Plain Text Generation¶

The MarkdownTemplateBackend uses html2text to automatically generate the plain text version of your emails from the HTML content. By default, certain configurations are set to produce a clean plain text output. However, you can override these settings to fit your specific needs.

Available `html2text` Settings¶

You can customize the behavior of html2text by specifying settings in your settings.py file using the TEMPLATED_EMAIL_HTML2TEXT_SETTINGS dictionary. Some common settings include:

ignore_links: If True, links will not be included in the plain text.
ignore_images: If True, image descriptions will be ignored.
body_width: Sets the maximum width of the text before wrapping.
ignore_emphasis: If True, emphasis markers (*, **) will be ignored.
mark_code: If True, code blocks will be wrapped with backticks.
wrap_links: If True, URLs will be wrapped in angle brackets (<, >).
use_automatic_links: If True, links will be converted to a simpler format.

For a full list of settings, refer to the html2text documentation. For any setting you want to configure, use the lowercase version of the setting name as the key in the TEMPLATED_EMAIL_HTML2TEXT_SETTINGS dictionary.

Example `html2text` Configuration¶

# settings.py

TEMPLATED_EMAIL_HTML2TEXT_SETTINGS = {
    'ignore_links': True,
    'ignore_images': False,
    'body_width': 80,
    'ignore_emphasis': False,
    'mark_code': True,
    'wrap_links': True,
}

Error Handling¶

fail_silently: Set this option to True to suppress exceptions during email rendering and send a fallback email instead.
Logging: Errors are logged using Django’s logging framework.

Example¶

# settings.py

TEMPLATED_EMAIL_BACKEND = 'templated_email_md.backend.MarkdownTemplateBackend'
TEMPLATED_EMAIL_FAIL_SILENTLY = True

Examples¶

Sending an Email with Attachments¶

from templated_email import send_templated_mail

send_templated_mail(
    template_name='invoice',
    from_email='billing@example.com',
    recipient_list=['customer@example.com'],
    context={
        'user': user_instance,
        'invoice': invoice_instance,
    },
    attachments=[
        ('invoice.pdf', invoice_pdf_content, 'application/pdf'),
    ],
)

Usage Guide¶

Installation¶

Configuration¶

1. Add to INSTALLED_APPS¶

2. Update Settings¶

3. Ensure Template Loaders Include APP_DIRS¶

Creating Markdown Templates¶

Example Template: templated_email/welcome.md¶

Template Blocks¶

Using Django Template Syntax¶

Sending Emails¶

Important Notes¶

Advanced Usage¶

Custom Base Template¶

Example: templated_email/markdown_base.html¶

Inline Styles¶

Plain Text Version¶

Template Inheritance¶

Base Template: templated_email/base_email.md¶

Child Template: templated_email/custom_email.md¶

Using Django Template Tags and Filters¶

Example with Logic and Filters¶

Internationalization (i18n) and Translated Emails¶

1. Use Translation Tags in Your Templates¶

2. Set Up and Compile Translation Files¶

3. Activate the Desired Language When Sending the Email¶

4. Using Celery for Asynchronous Email Sending¶

5. Handle Fallback Languages¶

Additional Considerations¶

Edge Cases and Considerations¶

Default Subject and Preheader¶

Settings¶

Subject Overriding¶

Example¶

URL Template Tags and Relative URLs¶

Example¶

Code and code blocks¶

Example¶

Context Variables¶

Markdown Extensions¶

Example¶

Customizing Plain Text Generation¶

Available html2text Settings¶

Example html2text Configuration¶

Error Handling¶

Example¶

Examples¶

Sending an Email with Attachments¶

1. Add to `INSTALLED_APPS`¶

3. Ensure Template Loaders Include `APP_DIRS`¶

Example Template: `templated_email/welcome.md`¶

Example: `templated_email/markdown_base.html`¶

Base Template: `templated_email/base_email.md`¶

Child Template: `templated_email/custom_email.md`¶

Available `html2text` Settings¶

Example `html2text` Configuration¶