[Python-checkins] python/dist/src/Doc/lib libimaplib.tex,1.21,1.22

[pierslauder@users.sourceforge.net]

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

Modified Files:
	libimaplib.tex 
Log Message:
added details of new IMAP4_stream class; emphasised meaning of data part of command results; added proxyauth command description

Index: libimaplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libimaplib.tex,v
retrieving revision 1.21
retrieving revision 1.22
diff -C2 -d -r1.21 -r1.22
*** libimaplib.tex	20 Jul 2002 00:46:12 -0000	1.21
--- libimaplib.tex	22 Nov 2002 05:47:39 -0000	1.22
***************
*** 4,19 ****
  \declaremodule{standard}{imaplib}
  \modulesynopsis{IMAP4 protocol client (requires sockets).}
! \moduleauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
! \sectionauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
  
! % Based on HTML documentation by Piers Lauder <piers@staff.cs.usyd.edu.au>;
  % converted by Fred L. Drake, Jr. <fdrake@acm.org>.
  % Revised by ESR, January 2000.
  % Changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002 
  
  \indexii{IMAP4}{protocol}
  \indexii{IMAP4_SSL}{protocol}
  
! This module defines two classes, \class{IMAP4} and \class{IMAP4_SSL}, which encapsulate a
  connection to an IMAP4 server and implement a large subset of the
  IMAP4rev1 client protocol as defined in \rfc{2060}. It is backward
--- 4,21 ----
  \declaremodule{standard}{imaplib}
  \modulesynopsis{IMAP4 protocol client (requires sockets).}
! \moduleauthor{Piers Lauder}{piers@communitysolutions.com.au}
! \sectionauthor{Piers Lauder}{piers@communitysolutions.com.au}
  
! % Based on HTML documentation by Piers Lauder <piers@communitysolutions.com.au>;
  % converted by Fred L. Drake, Jr. <fdrake@acm.org>.
  % Revised by ESR, January 2000.
  % Changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002 
+ % Changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>, November 2002 
  
  \indexii{IMAP4}{protocol}
  \indexii{IMAP4_SSL}{protocol}
+ \indexii{IMAP4_stream}{protocol}
  
! This module defines three classes, \class{IMAP4}, \class{IMAP4_SSL} and \class{IMAP4_stream}, which encapsulate a
  connection to an IMAP4 server and implement a large subset of the
  IMAP4rev1 client protocol as defined in \rfc{2060}. It is backward
***************
*** 21,25 ****
  \samp{STATUS} command is not supported in IMAP4.
  
! Two classes are provided by the \module{imaplib} module, \class{IMAP4} is the base class:
  
  \begin{classdesc}{IMAP4}{\optional{host\optional{, port}}}
--- 23,27 ----
  \samp{STATUS} command is not supported in IMAP4.
  
! Three classes are provided by the \module{imaplib} module, \class{IMAP4} is the base class:
  
  \begin{classdesc}{IMAP4}{\optional{host\optional{, port}}}
***************
*** 31,35 ****
  \end{classdesc}
  
! Two exceptions are defined as attributes of the \class{IMAP4} class:
  
  \begin{excdesc}{IMAP4.error}
--- 33,37 ----
  \end{classdesc}
  
! Three exceptions are defined as attributes of the \class{IMAP4} class:
  
  \begin{excdesc}{IMAP4.error}
***************
*** 62,65 ****
--- 64,74 ----
  \end{classdesc}
  
+ The second subclass allows for connections created by a child process:
+ 
+ \begin{classdesc}{IMAP4_stream}{command}
+ This is a subclass derived from \class{IMAP4} that connects
+ to the \code{stdin/stdout} file descriptors created by passing \var{command} to \code{os.popen2()}.
+ \end{classdesc}
+ 
  The following utility functions are defined:
  
***************
*** 120,124 ****
  ...])} where \var{type} is usually \code{'OK'} or \code{'NO'},
  and \var{data} is either the text from the command response, or
! mandated results from the command.
  
  An \class{IMAP4} instance has the following methods:
--- 129,136 ----
  ...])} where \var{type} is usually \code{'OK'} or \code{'NO'},
  and \var{data} is either the text from the command response, or
! mandated results from the command. Each \var{data}
! is either a string, or a tuple. If a tuple, then the first part
! is the header of the response, and the second part contains
! the data (ie: 'literal' value).
  
  An \class{IMAP4} instance has the following methods:
***************
*** 199,202 ****
--- 211,219 ----
  \end{methoddesc}
  
+ \begin{methoddesc}{login_cram_md5}{user, password}
+   Force use of \samp{CRAM-MD5} authentication when identifying the client to protect the password.
+   Will only work if the server \samp{CAPABILITY} response includes the phrase \samp{AUTH=CRAM-MD5}.
+ \end{methoddesc}
+ 
  \begin{methoddesc}{logout}{}
    Shutdown connection to server. Returns server \samp{BYE} response.
***************
*** 224,227 ****
--- 241,249 ----
    Fetch truncated part of a message.
    Returned data is a tuple of message part envelope and data.
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{proxyauth}{user}
+   Assume authentication as \var{user}.
+   Allows an authorised administrator to proxy into any user's mailbox.
  \end{methoddesc}