[Python-checkins] python/dist/src/Doc/lib libimaplib.tex,1.29,1.30
fdrake at users.sourceforge.net
fdrake at users.sourceforge.net
Fri Jul 30 21:12:40 CEST 2004
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7327/lib
Modified Files:
libimaplib.tex
Log Message:
re-wrap paragraphs containing long lines
Index: libimaplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libimaplib.tex,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** libimaplib.tex 30 Jul 2004 16:09:19 -0000 1.29
--- libimaplib.tex 30 Jul 2004 19:12:38 -0000 1.30
***************
*** 7,15 ****
\sectionauthor{Piers Lauder}{piers at communitysolutions.com.au}
! % Based on HTML documentation by Piers Lauder <piers at communitysolutions.com.au>;
% converted by Fred L. Drake, Jr. <fdrake at acm.org>.
% Revised by ESR, January 2000.
% Changes for IMAP4_SSL by Tino Lange <Tino.Lange at isg.de>, March 2002
! % Changes for IMAP4_stream by Piers Lauder <piers at communitysolutions.com.au>, November 2002
\indexii{IMAP4}{protocol}
--- 7,17 ----
\sectionauthor{Piers Lauder}{piers at communitysolutions.com.au}
! % Based on HTML documentation by Piers Lauder
! % <piers at communitysolutions.com.au>;
% converted by Fred L. Drake, Jr. <fdrake at acm.org>.
% Revised by ESR, January 2000.
% Changes for IMAP4_SSL by Tino Lange <Tino.Lange at isg.de>, March 2002
! % Changes for IMAP4_stream by Piers Lauder
! % <piers at communitysolutions.com.au>, November 2002
\indexii{IMAP4}{protocol}
***************
*** 17,21 ****
\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
--- 19,24 ----
\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
***************
*** 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}}}
--- 26,31 ----
\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}}}
***************
*** 48,65 ****
\begin{excdesc}{IMAP4.readonly}
! This exception is raised when a writable mailbox has its status changed by the server. This is a
! sub-class of \exception{IMAP4.error}. Some other client now has write permission,
! and the mailbox will need to be re-opened to re-obtain write permission.
\end{excdesc}
There's also a subclass for secure connections:
! \begin{classdesc}{IMAP4_SSL}{\optional{host\optional{, port\optional{, keyfile\optional{, certfile}}}}}
! This is a subclass derived from \class{IMAP4} that connects over an SSL encrypted socket
! (to use this class you need a socket module that was compiled with SSL support).
! If \var{host} is not specified, \code{''} (the local host) is used.
! If \var{port} is omitted, the standard IMAP4-over-SSL port (993) 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.
\end{classdesc}
--- 52,73 ----
\begin{excdesc}{IMAP4.readonly}
! This exception is raised when a writable mailbox has its status
! changed by the server. This is a sub-class of
! \exception{IMAP4.error}. Some other client now has write permission,
! and the mailbox will need to be re-opened to re-obtain write
! permission.
\end{excdesc}
There's also a subclass for secure connections:
! \begin{classdesc}{IMAP4_SSL}{\optional{host\optional{, port\optional{,
! keyfile\optional{, certfile}}}}}
! This is a subclass derived from \class{IMAP4} that connects over an
! SSL encrypted socket (to use this class you need a socket module that
! was compiled with SSL support). If \var{host} is not specified,
! \code{''} (the local host) is used. If \var{port} is omitted, the
! standard IMAP4-over-SSL port (993) 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.
\end{classdesc}
***************
*** 68,72 ****
\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()}.
\versionadded{2.3}
\end{classdesc}
--- 76,81 ----
\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()}.
\versionadded{2.3}
\end{classdesc}
***************
*** 145,151 ****
Authenticate command --- requires response processing.
! \var{mechanism} specifies which authentication mechanism is to
! be used - it should appear in the instance variable \code{capabilities} in the
! form \code{AUTH=mechanism}.
\var{authobject} must be a callable object:
--- 154,160 ----
Authenticate command --- requires response processing.
! \var{mechanism} specifies which authentication mechanism is to be
! used - it should appear in the instance variable \code{capabilities}
! in the form \code{AUTH=mechanism}.
\var{authobject} must be a callable object:
***************
*** 232,237 ****
\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}.
\versionadded{2.3}
\end{methoddesc}
--- 241,247 ----
\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}.
\versionadded{2.3}
\end{methoddesc}
***************
*** 265,269 ****
Opens socket to \var{port} at \var{host}.
The connection objects established by this method
! will be used in the \code{read}, \code{readline}, \code{send}, and \code{shutdown} methods.
You may override this method.
\end{methoddesc}
--- 275,280 ----
Opens socket to \var{port} at \var{host}.
The connection objects established by this method
! will be used in the \code{read}, \code{readline}, \code{send}, and
! \code{shutdown} methods.
You may override this method.
\end{methoddesc}
***************
*** 356,369 ****
\begin{methoddesc}{sort}{sort_criteria, charset, search_criterion\optional{, ...}}
! The \code{sort} command is a variant of \code{search} with sorting semantics for
! the results. Returned data contains a space
! separated list of matching message numbers.
Sort has two arguments before the \var{search_criterion}
! argument(s); a parenthesized list of \var{sort_criteria}, and the searching \var{charset}.
! Note that unlike \code{search}, the searching \var{charset} argument is mandatory.
! There is also a \code{uid sort} command which corresponds to \code{sort} the way
! that \code{uid search} corresponds to \code{search}.
! The \code{sort} command first searches the mailbox for messages that
match the given searching criteria using the charset argument for
the interpretation of strings in the searching criteria. It then
--- 367,381 ----
\begin{methoddesc}{sort}{sort_criteria, charset, search_criterion\optional{, ...}}
! The \code{sort} command is a variant of \code{search} with sorting
! semantics for the results. Returned data contains a space separated
! list of matching message numbers.
Sort has two arguments before the \var{search_criterion}
! argument(s); a parenthesized list of \var{sort_criteria}, and the
! searching \var{charset}. Note that unlike \code{search}, the
! searching \var{charset} argument is mandatory. There is also a
! \code{uid sort} command which corresponds to \code{sort} the way
! that \code{uid search} corresponds to \code{search}. The
! \code{sort} command first searches the mailbox for messages that
match the given searching criteria using the charset argument for
the interpretation of strings in the searching criteria. It then
***************
*** 385,406 ****
\end{methoddesc}
! \begin{methoddesc}{thread}{threading_algorithm, charset, search_criterion\optional{, ...}}
! The \code{thread} command is a variant of \code{search} with threading semantics for
! the results. Returned data contains a space
separated list of thread members.
! Thread members consist of zero or more messages numbers, delimited by spaces,
! indicating successive parent and child.
Thread has two arguments before the \var{search_criterion}
! argument(s); a \var{threading_algorithm}, and the searching \var{charset}.
! Note that unlike \code{search}, the searching \var{charset} argument is mandatory.
! There is also a \code{uid thread} command which corresponds to \code{thread} the way
! that \code{uid search} corresponds to \code{search}.
! The \code{thread} command first searches the mailbox for messages that
! match the given searching criteria using the charset argument for
! the interpretation of strings in the searching criteria. It thren
! returns the matching messages threaded according to the specified
! threading algorithm.
This is an \samp{IMAP4rev1} extension command. \versionadded{2.4}
--- 397,419 ----
\end{methoddesc}
! \begin{methoddesc}{thread}{threading_algorithm, charset,
! search_criterion\optional{, ...}}
! The \code{thread} command is a variant of \code{search} with
! threading semantics for the results. Returned data contains a space
separated list of thread members.
! Thread members consist of zero or more messages numbers, delimited
! by spaces, indicating successive parent and child.
Thread has two arguments before the \var{search_criterion}
! argument(s); a \var{threading_algorithm}, and the searching
! \var{charset}. Note that unlike \code{search}, the searching
! \var{charset} argument is mandatory. There is also a \code{uid
! thread} command which corresponds to \code{thread} the way that
! \code{uid search} corresponds to \code{search}. The \code{thread}
! command first searches the mailbox for messages that match the given
! searching criteria using the charset argument for the interpretation
! of strings in the searching criteria. It thren returns the matching
! messages threaded according to the specified threading algorithm.
This is an \samp{IMAP4rev1} extension command. \versionadded{2.4}
More information about the Python-checkins
mailing list