Commit 02694fad authored by Barry Warsaw's avatar Barry Warsaw

Added some additional documentation describing how BabylMailbox

actually works (it returns a message containing the visible headers,
not the original headers).  Doc change approved by Fred; closes SF bug
#412230.
parent 06a3cd2b
...@@ -69,10 +69,18 @@ mailbox specified by \var{dirname} is made available. ...@@ -69,10 +69,18 @@ mailbox specified by \var{dirname} is made available.
\end{classdesc} \end{classdesc}
\begin{classdesc}{BabylMailbox}{fp\optional{, factory}} \begin{classdesc}{BabylMailbox}{fp\optional{, factory}}
Access a Babyl mailbox, which is similar to an MMDF mailbox. Mail Access a Babyl mailbox, which is similar to an MMDF mailbox. In
messages start with a line containing only \code{'*** EOOH ***'} and Babyl format, each message has two sets of headers, the
end with a line containing only \code{'\e{}037\e{}014'}. \emph{original} headers and the \emph{visible} headers. The original
\var{factory} is as with the \class{UnixMailbox} class. headers appear before a a line containing only \code{'*** EOOH ***'}
(End-Of-Original-Headers) and the visible headers appear after the
\code{EOOH} line. Babyl-compliant mail readers will show you only the
visible headers, and \class{BabylMailbox} objects will return messages
containing only the visible headers. You'll have to do your own
parsing of the mailbox file to get at the original headers. Mail
messages start with the EOOH line and end with a line containing only
\code{'\e{}037\e{}014'}. \var{factory} is as with the
\class{UnixMailbox} class.
\end{classdesc} \end{classdesc}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment