summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libmailbox.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-02-20 05:04:59 (GMT)
committerFred Drake <fdrake@acm.org>1999-02-20 05:04:59 (GMT)
commit199b79c37b03e776e9fa5ef956f3675ccfa36f9c (patch)
treeee19d4a3b4966e66c3a97be8adaa5f826c5d6a6d /Doc/lib/libmailbox.tex
parent67d229ea76754db032f546010c7834c9f408c663 (diff)
downloadcpython-199b79c37b03e776e9fa5ef956f3675ccfa36f9c.zip
cpython-199b79c37b03e776e9fa5ef956f3675ccfa36f9c.tar.gz
cpython-199b79c37b03e776e9fa5ef956f3675ccfa36f9c.tar.bz2
Added descriptions for BabylMailbox and Maildir (Qmail) mailbox
objects.
Diffstat (limited to 'Doc/lib/libmailbox.tex')
-rw-r--r--Doc/lib/libmailbox.tex20
1 files changed, 15 insertions, 5 deletions
diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex
index 8110291..3eeffb9 100644
--- a/Doc/lib/libmailbox.tex
+++ b/Doc/lib/libmailbox.tex
@@ -1,11 +1,10 @@
\section{\module{mailbox} ---
- Read various mailbox formats.}
-\declaremodule{standard}{mailbox}
+ Read various mailbox formats}
+\declaremodule{standard}{mailbox}
\modulesynopsis{Read various mailbox formats.}
-
This module defines a number of classes that allow easy and uniform
access to mail messages in a (\UNIX{}) mailbox.
@@ -27,8 +26,19 @@ file with a numeric name.
The name of the mailbox directory is passed in \var{dirname}.
\end{classdesc}
-\subsection{Mailbox Objects}
-\label{mailbox-objects}
+\begin{classdesc}{Maildir}{dirname}
+Access a Qmail mail directory. All new and current mail for the
+mailbox specified by \var{dirname} is made available.
+\end{classdesc}
+
+\begin{classdesc}{BabylMailbox}{fp}
+Access a Babyl mailbox, which is similar to an MMDF mailbox. Mail
+messages start with \code{'*** EOOH ***\n'} and end with
+\code{'\037\014\n'}.
+\end{classdesc}
+
+
+\subsection{Mailbox Objects \label{mailbox-objects}}
All implementations of Mailbox objects have one externally visible
method: