From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Tue, 1 May 2007 10:21:45 +0000 (+0000)
Subject: Added documentation for new optional credentials argument to SMTPHandler.__init__().
X-Git-Tag: v2.6a1~1787
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c0a293c692febd6125f95bce7d4bec7657e0ee9e;p=python

Added documentation for new optional credentials argument to SMTPHandler.__init__().
---

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex
index dabab53b60..58595f7c15 100644
--- a/Doc/lib/liblogging.tex
+++ b/Doc/lib/liblogging.tex
@@ -1296,13 +1296,16 @@ The \class{SMTPHandler} class, located in the
 \module{logging.handlers} module, supports sending logging messages to
 an email address via SMTP.
 
-\begin{classdesc}{SMTPHandler}{mailhost, fromaddr, toaddrs, subject}
+\begin{classdesc}{SMTPHandler}{mailhost, fromaddr, toaddrs, subject\optional{,
+                               credentials}}
 Returns a new instance of the \class{SMTPHandler} class. The
 instance is initialized with the from and to addresses and subject
 line of the email. The \var{toaddrs} should be a list of strings. To specify a
 non-standard SMTP port, use the (host, port) tuple format for the
 \var{mailhost} argument. If you use a string, the standard SMTP port
-is used.
+is used. If your SMTP server requires authentication, you can specify a
+(username, password) tuple for the \var{credentials} argument.
+\versionchanged[\var{credentials} was added]{2.6}
 \end{classdesc}
 
 \begin{methoddesc}{emit}{record}