Added descriptions for BabylMailbox and Maildir (Qmail) mailbox

objects.
This commit is contained in:
Fred Drake 1999-02-20 05:04:59 +00:00
parent 67d229ea76
commit 199b79c37b
1 changed files with 15 additions and 5 deletions

View File

@ -1,11 +1,10 @@
\section{\module{mailbox} ---
Read various mailbox formats.}
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: