[Python-checkins] cpython (2.7): Closes #12667: Corrected documentation for SMTPHandler secure argument.

[vinay.sajip]

http://hg.python.org/cpython/rev/42f40f53fd73
changeset:   71660:42f40f53fd73
branch:      2.7
parent:      71657:84021f563007
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Mon Aug 01 11:28:02 2011 +0100
summary:
  Closes #12667: Corrected documentation for SMTPHandler secure argument.

files:
  Doc/library/logging.handlers.rst |  10 ++++++++--
  1 files changed, 8 insertions(+), 2 deletions(-)


diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -613,8 +613,14 @@
    port, use the (host, port) tuple format for the *mailhost* argument. If you
    use a string, the standard SMTP port is used. If your SMTP server requires
    authentication, you can specify a (username, password) tuple for the
-   *credentials* argument. If *secure* is True, then the handler will attempt
-   to use TLS for the email transmission.
+   *credentials* argument.
+
+   To specify the use of a secure protocol (TLS), pass in a tuple to the
+   *secure* argument. This will only be used when authentication credentials are
+   supplied. The tuple should be either an empty tuple, or a single-value tuple
+   with the name of a keyfile, or a 2-value tuple with the names of the keyfile
+   and certificate file. (This tuple is passed to the
+   :meth:`smtplib.SMTP.starttls` method.)
 
    .. versionchanged:: 2.6
       *credentials* was added.

-- 
Repository URL: http://hg.python.org/cpython