From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Mon, 1 Aug 2011 10:28:02 +0000 (+0100)
Subject: Closes #12667: Corrected documentation for SMTPHandler secure argument.
X-Git-Tag: v2.7.3rc1~549
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5d09ba46c95852c783c5a3c619f8a093d370100a;p=python

Closes #12667: Corrected documentation for SMTPHandler secure argument.
---

diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 9db262acbf..1a14499180 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -613,8 +613,14 @@ supports sending logging messages to an email address via SMTP.
    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.