Docs: clarify ESP templates not yet implemented

This commit is contained in:
Mike Edmunds
2016-04-26 09:39:41 -07:00
parent 1e4abada8c
commit ca7dbdcec6

View File

@@ -16,12 +16,6 @@ to rewrite your email templates if you switch ESPs.
better, portable and maintainable option. better, portable and maintainable option.
.. note::
Normalized merge variables and template identification
are coming to Anymail soon.
.. currentmodule:: anymail.message .. currentmodule:: anymail.message
.. _esp-templates: .. _esp-templates:
@@ -29,6 +23,15 @@ better, portable and maintainable option.
ESP templates ESP templates
------------- -------------
.. warning::
These normalized ESP-template attributes aren't implemented yet.
but are planned for a future Anymail update. If you are using
your ESP's transactional templates,
`your input <https://github.com/anymail/django-anymail/issues/5>`_
would be appreciated.
.. To use a *Mandrill* (MailChimp) template stored in your Mandrill account, .. To use a *Mandrill* (MailChimp) template stored in your Mandrill account,
.. set a :attr:`template_name` and (optionally) :attr:`template_content` .. set a :attr:`template_name` and (optionally) :attr:`template_content`
.. on your :class:`~django.core.mail.EmailMessage` object:: .. on your :class:`~django.core.mail.EmailMessage` object::
@@ -58,11 +61,14 @@ ESP templates
.. can be used with templates. .. can be used with templates.
.. attribute:: AnymailMessage.template_name .. attribute:: AnymailMessage.template_id
(not yet implemented)
.. attribute:: AnymailMessage.global_merge_vars .. attribute:: AnymailMessage.global_merge_vars
(not yet implemented)
.. ``dict``: merge variables to use for all recipients (most useful with :ref:`mandrill-templates`). :: .. ``dict``: merge variables to use for all recipients (most useful with :ref:`mandrill-templates`). ::
.. ..
.. message.global_merge_vars = {'company': "ACME", 'offer': "10% off"} .. message.global_merge_vars = {'company': "ACME", 'offer': "10% off"}
@@ -72,6 +78,8 @@ ESP templates
.. attribute:: AnymailMessage.merge_vars .. attribute:: AnymailMessage.merge_vars
(not yet implemented)
.. ``dict``: per-recipient merge variables (most useful with :ref:`mandrill-templates`). The keys .. ``dict``: per-recipient merge variables (most useful with :ref:`mandrill-templates`). The keys
.. in the dict are the recipient email addresses, and the values are dicts of merge vars for .. in the dict are the recipient email addresses, and the values are dicts of merge vars for
.. each recipient:: .. each recipient::