summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libimaplib.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-04-11 05:02:45 (GMT)
committerFred Drake <fdrake@acm.org>1998-04-11 05:02:45 (GMT)
commite5cf53ad894aec93fd47b2ac20cc7974d04a082d (patch)
tree5626d1314c78babf9a6166abc837a6aea0d14303 /Doc/lib/libimaplib.tex
parenteb4ed15be8165a7e4f38fb522cc3e8843ffd7b30 (diff)
downloadcpython-e5cf53ad894aec93fd47b2ac20cc7974d04a082d.zip
cpython-e5cf53ad894aec93fd47b2ac20cc7974d04a082d.tar.gz
cpython-e5cf53ad894aec93fd47b2ac20cc7974d04a082d.tar.bz2
Formatting nits.
An index entry.
Diffstat (limited to 'Doc/lib/libimaplib.tex')
-rw-r--r--Doc/lib/libimaplib.tex17
1 files changed, 11 insertions, 6 deletions
diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex
index 7cb4bb3..44f5fb7 100644
--- a/Doc/lib/libimaplib.tex
+++ b/Doc/lib/libimaplib.tex
@@ -6,6 +6,7 @@
\section{Standard Module \module{imaplib}}
\stmodindex{imaplib}
\label{module-imaplib}
+\indexii{IMAP4}{protocol}
This module defines a class, \class{IMAP4}, which encapsulates a
connection to an IMAP4 server and implements the IMAP4rev1 client
@@ -117,9 +118,11 @@ An \class{IMAP4} instance has the following methods:
envelope and data.
\end{methoddesc}
-\begin{methoddesc}{list}{directory='""', pattern='*'}
- List mailbox names in directory matching pattern. Returned data contains a
- list of \samp{LIST} responses.
+\begin{methoddesc}{list}{\optional{directory\optional{, pattern}}}
+ List mailbox names in \var{directory} matching
+ \var{pattern}. \var{directory} defaults to the top-level mail
+ folder, and \var{pattern} defaults to match anything. Returned data
+ contains a list of \samp{LIST} responses.
\end{methoddesc}
\begin{methoddesc}{login}{user, password}
@@ -130,9 +133,11 @@ An \class{IMAP4} instance has the following methods:
Shutdown connection to server. Returns server \samp{BYE} response.
\end{methoddesc}
-\begin{methoddesc}{lsub}{directory='""', pattern='*'}
- List subscribed mailbox names in directory matching
- pattern. Returned data are tuples of message part envelope and data.
+\begin{methoddesc}{lsub}{\optional{directory\optional{, pattern}}}
+ List subscribed mailbox names in directory matching pattern.
+ \var{directory} defaults to the top level directory and
+ \var{pattern} defaults to match any mailbox.
+ Returned data are tuples of message part envelope and data.
\end{methoddesc}
\begin{methoddesc}{recent}{}