From 5d09ba46c95852c783c5a3c619f8a093d370100a Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Mon, 1 Aug 2011 11:28:02 +0100 Subject: [PATCH] Closes #12667: Corrected documentation for SMTPHandler secure argument. --- Doc/library/logging.handlers.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) 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. -- 2.50.1