[Python-checkins] CVS: python/dist/src/Doc/lib libsmtplib.tex,1.17,1.18

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv23874/lib

Modified Files:
	libsmtplib.tex 
Log Message:
Documentation for the new login() method of the smtplib.SMTP class,
contributed by Gerhard Häring.
This is part of SF patch #460112.                                             

Index: libsmtplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsmtplib.tex,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** libsmtplib.tex	2001/05/20 12:26:04	1.17
--- libsmtplib.tex	2001/09/11 16:58:00	1.18
***************
*** 161,164 ****
--- 161,182 ----
  \end{methoddesc}
  
+ \begin{methoddesc}{login}{user, password}
+ Log in on an SMTP server that requires authentication.
+ The arguments are the username and the password to authenticate with.
+ If there has been no previous \samp{EHLO} or \samp{HELO} command this
+ session, this method tries ESMTP \samp{EHLO} first.
+ This method will return normally if the authentication was successful,
+ or may raise the following exceptions:
+ 
+ \begin{description}
+   \item[\exception{SMTPHeloError}]
+     The server didn't reply properly to the \samp{HELO} greeting.
+   \item[\exception{SMTPAuthenticationError}]
+     The server didn't accept the username/password combination.
+   \item[\exception{SMTPError}]
+     No suitable authentication method was found.
+ \end{description}
+ \end{methoddesc}
+ 
  \begin{methoddesc}{sendmail}{from_addr, to_addrs, msg\optional{,
                               mail_options, rcpt_options}}