Creating e-mail messages, with multiple layouts and multilingual content.
Project description
fluentcms-emailtemplates
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:
pip install fluentcms-emailtemplates
First make sure the project is configured for django-fluent-contents.
Then add the following settings:
INSTALLED_APPS += ( 'fluentcms_emailtemplates', 'fluentcms_emailtemplates.plugins.emailtext', ) FLUENTCMS_EMAILTEMPLATES_PLUGINS = ( 'EmailTextPlugin', )
The database tables can be created afterwards:
./manage.py migrate
Configuration
The following settings are defined by default:
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:
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()
Contributing
If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)
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
Built Distribution
Hashes for fluentcms-emailtemplates-1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c280c5bb40696190541849c2bfb80ce4fde46ac4fee258348ebfb36b8b46edcd |
|
MD5 | 5e17ac022cb29e7fdac95813d9647785 |
|
BLAKE2b-256 | 276b4f0f7c90b05912433a8d163c85d8215a5ebdc57f356334f1f4fba4611cf8 |
Hashes for fluentcms_emailtemplates-1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3938123d4b29b1b1290742d406c076a5a81dfb62bad33633233ee4bdc032ee7a |
|
MD5 | efcb76c0d5016435aa709f40849d6dba |
|
BLAKE2b-256 | 74058fd2259f6e546ef972e3a5e6b6dde88340b8f99cf3cbc87576156623985f |