summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHannes Struss <x@hannesstruss.de>2012-11-19 18:57:40 +0100
committerHannes Struss <x@hannesstruss.de>2012-11-20 11:23:12 +0100
commitf9891f20872e2a468c4910a968c5e2fae75d0e51 (patch)
tree1bddda217aa8a319b57801f84f560a658324ee1d /docs
parent1f1f60d12f78ee68d59b577fdb6a31857b1d0f44 (diff)
Fixed #19325 - Made email backend of AdminEmailHandler configurable
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/logging.txt19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt
index d016b59969..c2503bbde4 100644
--- a/docs/topics/logging.txt
+++ b/docs/topics/logging.txt
@@ -440,7 +440,7 @@ Handlers
Django provides one log handler in addition to those provided by the
Python logging module.
-.. class:: AdminEmailHandler([include_html=False])
+.. class:: AdminEmailHandler(include_html=False, email_backend=None)
This handler sends an email to the site admins for each log
message it receives.
@@ -476,6 +476,23 @@ Python logging module.
sensitive information to be filtered out of error reports -- learn more on
:ref:`Filtering error reports<filtering-error-reports>`.
+ .. versionadded:: 1.5
+
+ By setting the ``email_backend`` argument of ``AdminEmailHandler``, the
+ :ref:`email backend <topic-email-backends>` that is being used by the
+ handler can be overridden, like this::
+
+ 'handlers': {
+ 'mail_admins': {
+ 'level': 'ERROR',
+ 'class': 'django.utils.log.AdminEmailHandler',
+ 'email_backend': 'django.core.mail.backends.filebased.EmailBackend',
+ }
+ },
+
+ By default, an instance of the email backend specified in
+ :setting:`EMAIL_BACKEND` will be used.
+
.. _Sentry: http://pypi.python.org/pypi/sentry