Skip to content

Commit

Permalink
Add settings section to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rangelfinal committed Sep 19, 2023
1 parent ca1729a commit 918afce
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,27 @@ Methods:
a celery's task for example or to handle errors.


Settings
=============

You can configure Django-Templated-Email by setting the following settings

.. code-block:: python
TEMPLATED_EMAIL_FROM_EMAIL # String containing the email to send the email from - fallback to DEFAULT_FROM_EMAIL
TEMPLATED_EMAIL_BACKEND # The backend that will send the email
TEMPLATED_EMAIL_TEMPLATE_DIR # The directory containing the templates, use '' if using the top level
TEMPLATED_EMAIL_FILE_EXTENSION # The file extension of the template files
TEMPLATED_EMAIL_AUTO_PLAIN # Disable the behavior of calculating the plain part from the html part of the email when `html2text <https://pypi.python.org/pypi/html2text>` is installed
TEMPLATED_EMAIL_PLAIN_FUNCTION # Specify a custom function that converts from HTML to the plain part
# vanilla_django
TEMPLATED_EMAIL_DJANGO_SUBJECTS # Deprecated, prefer to use **{% block subject %}**
# anymail
TEMPLATED_EMAIL_EMAIL_MESSAGE_CLASS # Replaces django.core.mail.EmailMessage
TEMPLATED_EMAIL_EMAIL_MULTIALTERNATIVES_CLASS # Replaces django.core.mail.EmailMultiAlternatives
Future Plans
=============

Expand Down

0 comments on commit 918afce

Please sign in to comment.