mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 00:23:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Adjustments to the text of the UnixMailbox description. Added

Browse source 
PortableUnixMailbox as a separate class as well (this also generates
the right index entry).
This commit is contained in:
Fred Drake 2001-02-02 03:51:05 +00:00
parent 4c4fda0f57
commit 6270031f4e
1 changed files with 30 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

50
Doc/lib/libmailbox.tex
View file

@ -9,33 +9,43 @@ This module defines a number of classes that allow easy and uniform
access to mail messages in a (\UNIX{}) mailbox. access to mail messages in a (\UNIX{}) mailbox.
\begin{classdesc}{UnixMailbox}{fp\optional{, factory}} \begin{classdesc}{UnixMailbox}{fp\optional{, factory}}
Access to a classic \UNIX{}-style mailbox, where all messages are Access to a classic \UNIX-style mailbox, where all messages are
contained in a single file and separate by ``From '' (a.k.a ``From_'') contained in a single file and separated by \samp{From }
lines. The file object \var{fp} points to the mailbox file. Optional (a.k.a.\ \samp{From_}) lines. The file object \var{fp} points to the
\var{factory} is a callable that should create new message objects. mailbox file. The optional \var{factory} parameter is a callable that
It is called with one argument, \var{fp} by the \method{next()} should create new message objects. \var{factory} is called with one
method. The default is the \class{rfc822.Message} class (see the argument, \var{fp} by the \method{next()} method of the mailbox
object. The default is the \class{rfc822.Message} class (see the
\refmodule{rfc822} module). \refmodule{rfc822} module).
For maximum portability, messages in a \UNIX{}-style mailbox are For maximum portability, messages in a \UNIX-style mailbox are
separated by any line that begins exactly with the letters \emph{F}, separated by any line that begins exactly with the string \code{'From
\emph{r}, \emph{o}, \emph{m}, \emph{[space]} if preceded by exactly two '} (note the trailing space) if preceded by exactly two newlines.
newlines. Because of the wide-range of variations in practice, Because of the wide-range of variations in practice, nothing else on
nothing else on the From_ line should be considered. However, the the From_ line should be considered. However, the current
current implementation doesn't check for the leading two newlines. implementation doesn't check for the leading two newlines. This is
This is usually fine for most applications. usually fine for most applications.
The \class{UnixMailbox} class implements a more strict version of The \class{UnixMailbox} class implements a more strict version of
From_ line checking, using a regular expression that usually correctly From_ line checking, using a regular expression that usually correctly
matched From_ delimiters. It considers delimiter line to be separated matched From_ delimiters. It considers delimiter line to be separated
by ``From name time'' lines. For maximum portability, use the by \samp{From \var{name} \var{time}} lines. For maximum portability,
\class{PortableUnixMailbox} class instead. This use the \class{PortableUnixMailbox} class instead. This class is
class is completely identical to \class{UnixMailbox} except that identical to \class{UnixMailbox} except that individual messages are
individual messages are separated by only ``From '' lines. separated by only \samp{From } lines.
For more For more information, see
information see \citetitle[http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html]{Configuring
\url{http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html}. Netscape Mail on \UNIX: Why the Content-Length Format is Bad}.
\end{classdesc}
\begin{classdesc}{PortableUnixMailbox}{fp\optional{, factory}}
A less-strict version of \class{UnixMailbox}, which considers only the
\samp{From } at the beginning of the line separating messages. The
``\var{name} \var{time}'' portion of the From line is ignored, to
protect against some variations that are observed in practice. This
works since lines in the message which begin with \code{'From '} are
quoted by mail handling software well before delivery.
\end{classdesc} \end{classdesc}
\begin{classdesc}{MmdfMailbox}{fp\optional{, factory}} \begin{classdesc}{MmdfMailbox}{fp\optional{, factory}}