libmailbox.tex 1.38 KB
Newer Older
1
\section{Standard Module \sectcode{mailbox}}
2
\label{module-mailbox}
3 4
\stmodindex{mailbox}

5
\setindexsubitem{(in module mailbox)}
6 7 8 9 10

This module defines a number of classes that allow easy and uniform
access to mail messages in a (unix) mailbox.

\begin{funcdesc}{UnixMailbox}{fp}
11
Access a classic \UNIX{}-style mailbox, where all messages are contained
12 13
in a single file and separated by ``From name time'' lines.
The file object \var{fp} points to the mailbox file.
14 15 16 17 18
\end{funcdesc}

\begin{funcdesc}{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
19
characters.  The file object \var{fp} points to the mailbox file.
20 21 22 23
\end{funcdesc}

\begin{funcdesc}{MHMailbox}{dirname}
Access an MH mailbox, a directory with each message in a separate
24 25
file with a numeric name.
The name of the mailbox directory is passed in \var{dirname}.
26 27 28 29 30 31 32 33
\end{funcdesc}

\subsection{Mailbox Objects}

All implementations of Mailbox objects have one externally visible
method:

\begin{funcdesc}{next}{}
34
Return the next message in the mailbox, as a \code{rfc822.Message} object.
35
Depending on the mailbox implementation the \var{fp} attribute of this
36 37
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
38 39
contained in a single file, etc.
\end{funcdesc}