[Python-checkins] python/dist/src/Doc/lib libpoplib.tex,1.15,1.16

[loewis at users.sourceforge.net]

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

Modified Files:
	libpoplib.tex 
Log Message:
Patch #: Add POP3 over SSL support.


Index: libpoplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpoplib.tex,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** libpoplib.tex	18 Oct 2002 16:50:17 -0000	1.15
--- libpoplib.tex	31 Oct 2003 12:52:34 -0000	1.16
***************
*** 14,20 ****
  
  This module defines a class, \class{POP3}, which encapsulates a
! connection to an POP3 server and implements the protocol as defined in
  \rfc{1725}.  The \class{POP3} class supports both the minimal and
! optional command sets.
  
  Note that POP3, though widely supported, is obsolescent.  The
--- 14,23 ----
  
  This module defines a class, \class{POP3}, which encapsulates a
! connection to a POP3 server and implements the protocol as defined in
  \rfc{1725}.  The \class{POP3} class supports both the minimal and
! optional command sets. Additionally, this module provides a class
! \class{POP3_SSL}, which provides support for connecting to POP3
! servers that use SSL as an underlying protocol layer.
! 
  
  Note that POP3, though widely supported, is obsolescent.  The
***************
*** 32,35 ****
--- 35,48 ----
  \end{classdesc}
  
+ \begin{classdesc}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}}
+ This is a subclass of \class{POP3} that connects to the server over an
+ SSL encrypted socket.  If \var{port} is not specified, 995, the
+ standard POP3-over-SSL port is used.  \var{keyfile} and \var{certfile}
+ are also optional - they can contain a PEM formatted private key and
+ certificate chain file for the SSL connection.
+ 
+ \versionadded{2.4}
+ \end{classdesc}
+ 
  One exception is defined as an attribute of the \module{poplib} module:
  
***************
*** 143,146 ****
--- 156,162 ----
  \var{octets})}.
  \end{methoddesc}
+ 
+ Instances of \class{POP3_SSL} have no additional methods. The
+ interface of this subclass is identical to its parent.