[Python-checkins] r55042 - python/trunk/Doc/lib/liblogging.tex

[vinay.sajip]

Author: vinay.sajip
Date: Tue May  1 12:21:45 2007
New Revision: 55042

Modified:
   python/trunk/Doc/lib/liblogging.tex
Log:
Added documentation for new optional credentials argument to SMTPHandler.__init__().

Modified: python/trunk/Doc/lib/liblogging.tex
==============================================================================
--- python/trunk/Doc/lib/liblogging.tex	(original)
+++ python/trunk/Doc/lib/liblogging.tex	Tue May  1 12:21:45 2007
@@ -1296,13 +1296,16 @@
 \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}