Staging
v0.5.1
v0.5.1
swh:1:snp:635f4099902912592851108bcac178ff574f7c5f
Tip revision: 4e02a97bd786bde6485210bd1c0f36fdc8ea8a56 authored by cvs2svn on 12 August 1998, 02:38:11 UTC
This commit was manufactured by cvs2svn to create tag 'r152a1'.
This commit was manufactured by cvs2svn to create tag 'r152a1'.
Tip revision: 4e02a97
libmailbox.tex
\section{\module{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.
\begin{classdesc}{UnixMailbox}{fp}
Access a classic \UNIX{}-style mailbox, where all messages are contained
in a single file and separated by ``From name time'' lines.
The file object \var{fp} points to the mailbox file.
\end{classdesc}
\begin{classdesc}{MmdfMailbox}{fp}
Access an MMDF-style mailbox, where all messages are contained
in a single file and separated by lines consisting of 4 control-A
characters. The file object \var{fp} points to the mailbox file.
\end{classdesc}
\begin{classdesc}{MHMailbox}{dirname}
Access an MH mailbox, a directory with each message in a separate
file with a numeric name.
The name of the mailbox directory is passed in \var{dirname}.
\end{classdesc}
\subsection{Mailbox Objects}
\label{mailbox-objects}
All implementations of Mailbox objects have one externally visible
method:
\begin{methoddesc}[mailbox]{next}{}
Return the next message in the mailbox, as a \class{rfc822.Message} object.
Depending on the mailbox implementation the \var{fp} attribute of this
object may be a true file object or a class instance simulating a file object,
taking care of things like message boundaries if multiple mail messages are
contained in a single file, etc.
\end{methoddesc}