traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Logical markup, using {classdesc} as appropriate.

This commit is contained in:
Fred Drake 1998-03-14 06:48:33 +00:00
parent be2b6d7f42
commit 2e495c93b0
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/lib/libmailbox.tex
View File

@ -2,36 +2,36 @@
\label{module-mailbox} \label{module-mailbox}
\stmodindex{mailbox} \stmodindex{mailbox}
\setindexsubitem{(in module mailbox)}
This module defines a number of classes that allow easy and uniform 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{funcdesc}{UnixMailbox}{fp} \begin{classdesc}{UnixMailbox}{fp}
Access a classic \UNIX{}-style mailbox, where all messages are contained Access a classic \UNIX{}-style mailbox, where all messages are contained
in a single file and separated by ``From name time'' lines. in a single file and separated by ``From name time'' lines.
The file object \var{fp} points to the mailbox file. The file object \var{fp} points to the mailbox file.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{MmdfMailbox}{fp} \begin{classdesc}{MmdfMailbox}{fp}
Access an MMDF-style mailbox, where all messages are contained Access an MMDF-style mailbox, where all messages are contained
in a single file and separated by lines consisting of 4 control-A in a single file and separated by lines consisting of 4 control-A
characters. The file object \var{fp} points to the mailbox file. characters. The file object \var{fp} points to the mailbox file.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{MHMailbox}{dirname} \begin{classdesc}{MHMailbox}{dirname}
Access an MH mailbox, a directory with each message in a separate Access an MH mailbox, a directory with each message in a separate
file with a numeric name. file with a numeric name.
The name of the mailbox directory is passed in \var{dirname}. The name of the mailbox directory is passed in \var{dirname}.
\end{funcdesc} \end{classdesc}
\subsection{Mailbox Objects} \subsection{Mailbox Objects}
\label{mailbox-objects}
All implementations of Mailbox objects have one externally visible All implementations of Mailbox objects have one externally visible
method: method:
\begin{funcdesc}{next}{} \begin{funcdesc}{next}{}
Return the next message in the mailbox, as a \code{rfc822.Message} object. Return the next message in the mailbox, as a \class{rfc822.Message} object.
Depending on the mailbox implementation the \var{fp} attribute of this 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, 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 taking care of things like message boundaries if multiple mail messages are

18
Doc/libmailbox.tex
View File

@ -2,36 +2,36 @@
\label{module-mailbox} \label{module-mailbox}
\stmodindex{mailbox} \stmodindex{mailbox}
\setindexsubitem{(in module mailbox)}
This module defines a number of classes that allow easy and uniform 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{funcdesc}{UnixMailbox}{fp} \begin{classdesc}{UnixMailbox}{fp}
Access a classic \UNIX{}-style mailbox, where all messages are contained Access a classic \UNIX{}-style mailbox, where all messages are contained
in a single file and separated by ``From name time'' lines. in a single file and separated by ``From name time'' lines.
The file object \var{fp} points to the mailbox file. The file object \var{fp} points to the mailbox file.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{MmdfMailbox}{fp} \begin{classdesc}{MmdfMailbox}{fp}
Access an MMDF-style mailbox, where all messages are contained Access an MMDF-style mailbox, where all messages are contained
in a single file and separated by lines consisting of 4 control-A in a single file and separated by lines consisting of 4 control-A
characters. The file object \var{fp} points to the mailbox file. characters. The file object \var{fp} points to the mailbox file.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{MHMailbox}{dirname} \begin{classdesc}{MHMailbox}{dirname}
Access an MH mailbox, a directory with each message in a separate Access an MH mailbox, a directory with each message in a separate
file with a numeric name. file with a numeric name.
The name of the mailbox directory is passed in \var{dirname}. The name of the mailbox directory is passed in \var{dirname}.
\end{funcdesc} \end{classdesc}
\subsection{Mailbox Objects} \subsection{Mailbox Objects}
\label{mailbox-objects}
All implementations of Mailbox objects have one externally visible All implementations of Mailbox objects have one externally visible
method: method:
\begin{funcdesc}{next}{} \begin{funcdesc}{next}{}
Return the next message in the mailbox, as a \code{rfc822.Message} object. Return the next message in the mailbox, as a \class{rfc822.Message} object.
Depending on the mailbox implementation the \var{fp} attribute of this 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, 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 taking care of things like message boundaries if multiple mail messages are