https://github.com/django-fluent/fluentcms-emailtemplates

An email template system, that uses django-fluent-contents blocks to define the e-mail templates.
https://github.com/django-fluent/fluentcms-emailtemplates

django-fluent email-template

Last synced: 7 months ago
JSON representation

An email template system, that uses django-fluent-contents blocks to define the e-mail templates.

• Host: GitHub
• URL: https://github.com/django-fluent/fluentcms-emailtemplates
• Owner: django-fluent
• License: apache-2.0
• Created: 2015-09-08T14:54:37.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-01-22T21:44:53.000Z (almost 8 years ago)
• Last Synced: 2024-04-29T22:07:51.177Z (over 1 year ago)
• Topics: django-fluent, email-template
• Language: Python
• Size: 74.2 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
fluentcms-emailtemplates

========================

.. image:: https://img.shields.io/travis/django-fluent/fluentcms-emailtemplates/master.svg?branch=master

    :target: http://travis-ci.org/django-fluent/fluentcms-emailtemplates

.. image:: https://img.shields.io/pypi/v/fluentcms-emailtemplates.svg

    :target: https://pypi.python.org/pypi/fluentcms-emailtemplates/

.. image:: https://img.shields.io/badge/wheel-yes-green.svg

    :target: https://pypi.python.org/pypi/fluentcms-emailtemplates/

.. image:: https://img.shields.io/pypi/l/fluentcms-emailtemplates.svg

    :target: https://pypi.python.org/pypi/fluentcms-emailtemplates/

.. image:: https://img.shields.io/codecov/c/github/django-fluent/fluentcms-emailtemplates/master.svg

    :target: https://codecov.io/github/django-fluent/fluentcms-emailtemplates?branch=master

An email template system, that uses django-fluent-contents_ blocks to define the e-mail templates.

Features:

* Multilingual content.

* Multisite support.

* Custom layouts (=Django templates).

* Custom context variables

Installation

============

First install the module, preferably in a virtual environment. It can be installed from PyPI:

.. code-block:: bash

    pip install fluentcms-emailtemplates

First make sure the project is configured for django-fluent-contents_.

Then add the following settings:

.. code-block:: python

    INSTALLED_APPS += (

        'fluentcms_emailtemplates',

        'fluentcms_emailtemplates.plugins.emailtext',

    )

    FLUENTCMS_EMAILTEMPLATES_PLUGINS = ( 

        'EmailTextPlugin',

    )

The database tables can be created afterwards:

.. code-block:: bash

    ./manage.py migrate

Configuration

-------------

The following settings are defined by default:

.. code-block:: python

    FLUENTCMS_EMAILTEMPLATES_LAYOUTS = (

        # A layout points to a template named:

        # fluentcms_emailtemplates/emails/{slug}/{layout}.html

        # fluentcms_emailtemplates/emails/{layout}.html

        ('default', _("Default")),

    )

    # Possible plugins to use in the email template.

    # By default, that is FLUENT_CONTENTS_PLACEHOLDER_CONFIG['email_templates']

    FLUENTCMS_EMAILTEMPLATES_PLUGINS = ( 

        'EmailTextPlugin',

    )

    # Add extras context data for an e-mail preview.

    FLUENTCMS_EMAILTEMPLATES_PREVIEW_CONTEXT = {}

    # Optionally allow developers to share email templates between all sites in a multisite setup.

    FLUENTCMS_EMAILTEMPLATES_ENABLE_CROSS_SITE = False

    # Enable multisite support by default

    FLUENTCMS_EMAILTEMPLATES_FILTER_SITE_ID = True

Usage

=====

Create email templates in the admin.

Use the following code to create an email:

.. code-block:: python

    from email.utils import formataddr

    from fluentcms_emailtemplates.models import *

    template = EmailTemplate.objects.get_for_slug('order-confirmation')

    email = template.get_email_message(

        base_url='http://example.org/',

        context={

            'order_number': "123-xy"

        },

        to=[

            formataddr(('You', 'you@example.org')),

        ],

    )

    email.send()

Tip: when creating a separate template for the plain-text email, start the template with ``{% autoescape off %}``.

This avoids creating HTML entities inside the plain-text email.

Contributing

------------

If you like this module, forked it, or would like to improve it, please let us know!

Pull requests are welcome too. :-)

.. _django-fluent-contents: https://github.com/edoburu/django-fluent-contents