% converted by Fred L. Drake, Jr. <fdrake@acm.org>.
\section{\module{imaplib} ---
- IMAP4 protocol client.}
+ IMAP4 protocol client}
+
\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}
-\modulesynopsis{IMAP4 protocol client (requires sockets).}
-
\indexii{IMAP4}{protocol}
This module defines a class, \class{IMAP4}, which encapsulates a
IMAP4 (\rfc{1730}) servers, but note that the \samp{STATUS} command is
not supported in IMAP4.
-A single class is provided by the \code{imaplib} module:
+A single class is provided by the \module{imaplib} module:
\begin{classdesc}{IMAP4}{\optional{host\optional{, port}}}
This class implements the actual IMAP4 protocol. The connection is
\begin{funcdesc}{Internaldate2tuple}{datestr}
Converts an IMAP4 INTERNALDATE string to Coordinated Universal
- Time. Returns a \module{time} module tuple.
+ Time. Returns a \refmodule{time} module tuple.
\end{funcdesc}
\begin{funcdesc}{Int2AP}{num}
\end{funcdesc}
\begin{funcdesc}{Time2Internaldate}{date_time}
- Converts a \module{time} module tuple to an IMAP4
+ Converts a \refmodule{time} module tuple to an IMAP4
\samp{INTERNALDATE} representation. Returns a string in the form:
\code{"DD-Mmm-YYYY HH:MM:SS +HHMM"} (including double-quotes).
\end{funcdesc}
All IMAP4rev1 commands are represented by methods of the same name,
either upper-case or lower-case.
-Each command returns a tuple: \code{(}\var{type}, \code{[}\var{data},
-...\code{])} where \var{type} is usually \code{'OK'} or \code{'NO'},
+Each command returns a tuple: \code{(\var{type}, [\var{data},
+...])} 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.
\begin{memberdesc}{PROTOCOL_VERSION}
-The most recent supported protocol in the \samp{CAPABILITY}
-response from the server.
+The most recent supported protocol in the
+\samp{CAPABILITY} response from the server.
\end{memberdesc}
\begin{memberdesc}{debug}