diff options
author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2007-05-01 10:21:45 (GMT) |
---|---|---|
committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2007-05-01 10:21:45 (GMT) |
commit | c0a293c692febd6125f95bce7d4bec7657e0ee9e (patch) | |
tree | 0babaffe491140374ed60f9af7f1ac9dd3269de8 /Doc/lib/liblogging.tex | |
parent | 70c8e8b8613c2af0025d5c950e0be8d1b6296294 (diff) | |
download | cpython-c0a293c692febd6125f95bce7d4bec7657e0ee9e.zip cpython-c0a293c692febd6125f95bce7d4bec7657e0ee9e.tar.gz cpython-c0a293c692febd6125f95bce7d4bec7657e0ee9e.tar.bz2 |
Added documentation for new optional credentials argument to SMTPHandler.__init__().
Diffstat (limited to 'Doc/lib/liblogging.tex')
-rw-r--r-- | Doc/lib/liblogging.tex | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex index dabab53..58595f7 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} |