]> granicus.if.org Git - python/commitdiff
Added documentation for new optional credentials argument to SMTPHandler.__init__().
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Tue, 1 May 2007 10:21:45 +0000 (10:21 +0000)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Tue, 1 May 2007 10:21:45 +0000 (10:21 +0000)
Doc/lib/liblogging.tex

index dabab53b60cebc492d8cbd1982d2d044a8f1de74..58595f7c1529f17c919a20c774c402eecca9808e 100644 (file)
@@ -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}