Skip to content

Loading…

Update default debug setting documentation and how debug level is handled #31

Merged
merged 1 commit into from

2 participants

@davidjb

Update documentation to include a note on how the debug level is treated, given how the underlying smtplib treats the value. Also update doco on default debug level setting as it is 0 rather than False.

@tseaver tseaver merged commit d947830 into Pylons:master
@tseaver
Pylons Project member

Thanks for the clarification!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Showing with 8 additions and 1 deletion.
  1. +8 −1 docs/index.rst
View
9 docs/index.rst
@@ -170,7 +170,7 @@ Setting Default Description
**mail.certfile** **None** SSL certificate file
**mail.queue_path** **None** Location of maildir
**mail.default_sender** **None** Default from address
-**mail.debug** **False** SMTP debug level
+**mail.debug** **0** SMTP debug level
========================= =============== =====================
**Note:** SSL will only work with **pyramid_mailer** if you are using Python
@@ -179,6 +179,13 @@ Setting Default Description
Python 2.5 or lower, **pyramid_mailer** does not support this out of the
box.
+**Note:** the ``mail.debug`` option will be passed to the underlying
+``smtplib`` connection. Any values for this option that Python would consider
+``> 0`` will result in debug messages for all messages sent and received from
+the server. Thus, specifying ``mail.debug`` with any value will result in debug
+messages as ``pyramid_mailer`` will not attempt to coerce this value from its
+original string.
+
Transactions
------------
Something went wrong with that request. Please try again.