summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libimaplib.tex
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2001-01-11 04:19:52 (GMT)
committerEric S. Raymond <esr@thyrsus.com>2001-01-11 04:19:52 (GMT)
commit5ac97957f72d42d5bc3ec658b4321cc207cb038e (patch)
tree05257025e7786efdf0d2ad5dad1e1c21950d6fcc /Doc/lib/libimaplib.tex
parenteec72a7fd9721b33971fddbc6c05c1e5551f794c (diff)
downloadcpython-5ac97957f72d42d5bc3ec658b4321cc207cb038e.zip
cpython-5ac97957f72d42d5bc3ec658b4321cc207cb038e.tar.gz
cpython-5ac97957f72d42d5bc3ec658b4321cc207cb038e.tar.bz2
Corrections and additions to the documentation for POP3 and IMAP library
support, based on my fetchmail experience.
Diffstat (limited to 'Doc/lib/libimaplib.tex')
-rw-r--r--Doc/lib/libimaplib.tex15
1 files changed, 9 insertions, 6 deletions
diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex
index 8fdc359..4f11fb0 100644
--- a/Doc/lib/libimaplib.tex
+++ b/Doc/lib/libimaplib.tex
@@ -8,14 +8,15 @@
% 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.
\indexii{IMAP4}{protocol}
This module defines a class, \class{IMAP4}, which encapsulates a
-connection to an IMAP4 server and implements the IMAP4rev1 client
-protocol as defined in \rfc{2060}. It is backward compatible with
-IMAP4 (\rfc{1730}) servers, but note that the \samp{STATUS} command is
-not supported in IMAP4.
+connection to an IMAP4 server and implements a large subset of the
+IMAP4rev1 client protocol as defined in \rfc{2060}. It is backward
+compatible with IMAP4 (\rfc{1730}) servers, but note that the
+\samp{STATUS} command is not supported in IMAP4.
A single class is provided by the \module{imaplib} module:
@@ -71,8 +72,10 @@ The following utility functions are defined:
\end{funcdesc}
-Note that IMAP4 message numbers change as the mailbox changes, so it
-is highly advisable to use UIDs instead, with the UID command.
+Note that IMAP4 message numbers change as the mailbox changes; in
+particular, after an \samp{EXPUNGE} command performs deletions the
+remaining messages are renumbered. So it is highly advisable to use
+UIDs instead, with the UID command.
At the end of the module, there is a test section that contains a more
extensive example of usage.