From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Sun, 6 Dec 2009 17:57:11 +0000 (+0000)
Subject: logging: Added optional 'secure' parameter to SMTPHandler.
X-Git-Tag: v3.2a1~2077
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=540f21529460a7c289021fb5026b4b8ef5ce8976;p=python

logging: Added optional 'secure' parameter to SMTPHandler.
---

diff --git a/Lib/logging/handlers.py b/Lib/logging/handlers.py
index 2437c341af..d722e21cf1 100644
--- a/Lib/logging/handlers.py
+++ b/Lib/logging/handlers.py
@@ -803,7 +803,8 @@ class SMTPHandler(logging.Handler):
     """
     A handler class which sends an SMTP email for each logging event.
     """
-    def __init__(self, mailhost, fromaddr, toaddrs, subject, credentials=None):
+    def __init__(self, mailhost, fromaddr, toaddrs, subject,
+                 credentials=None, secure=False):
         """
         Initialize the handler.
 
@@ -811,7 +812,9 @@ class SMTPHandler(logging.Handler):
         line of the email. To specify a non-standard SMTP port, use the
         (host, port) tuple format for the mailhost argument. To specify
         authentication credentials, supply a (username, password) tuple
-        for the credentials argument.
+        for the credentials argument.  To specify the use of a secure
+        protocol (TLS), pass in True for the secure argument. This will
+        only be used when authentication credentials are supplied.
         """
         logging.Handler.__init__(self)
         if isinstance(mailhost, tuple):
@@ -827,6 +830,7 @@ class SMTPHandler(logging.Handler):
             toaddrs = [toaddrs]
         self.toaddrs = toaddrs
         self.subject = subject
+        self.secure = secure
 
     def getSubject(self, record):
         """
@@ -878,6 +882,10 @@ class SMTPHandler(logging.Handler):
                             self.getSubject(record),
                             formatdate(), msg)
             if self.username:
+                if self.secure:
+                    smtp.ehlo()
+                    smtp.starttls()
+                    smtp.ehlo()
                 smtp.login(self.username, self.password)
             smtp.sendmail(self.fromaddr, self.toaddrs, msg)
             smtp.quit()
diff --git a/Misc/NEWS b/Misc/NEWS
index 0f524a52ba..2f762389ff 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -154,6 +154,9 @@ C-API
 Library
 -------
 
+- logging: Added optional `secure` parameter to SMTPHandler, to enable use of
+  TLS with authentication credentials.
+
 - Issue #1923: Fixed the removal of meaningful spaces when PKG-INFO is 
   generated in Distutils. Patch by Stephen Emslie.