From 199b79c37b03e776e9fa5ef956f3675ccfa36f9c Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Sat, 20 Feb 1999 05:04:59 +0000 Subject: [PATCH] Added descriptions for BabylMailbox and Maildir (Qmail) mailbox objects. --- Doc/lib/libmailbox.tex | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex index 8110291fdc9..3eeffb9ebfa 100644 --- a/Doc/lib/libmailbox.tex +++ b/Doc/lib/libmailbox.tex @@ -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: