diff options
author | Barry Warsaw <barry@python.org> | 2001-04-11 20:12:33 +0000 |
---|---|---|
committer | Barry Warsaw <barry@python.org> | 2001-04-11 20:12:33 +0000 |
commit | c3cbbaf51380bc31623af01226c4aac4b9da848c (patch) | |
tree | 5085f01a21c697da4dee3ae8cfb53acff5b6928a | |
parent | eedf985056b8837677c3d839e5858aa88ff9b92b (diff) | |
download | cpython-git-c3cbbaf51380bc31623af01226c4aac4b9da848c.tar.gz |
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.
-rw-r--r-- | Doc/lib/libmailbox.tex | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex index e74848bb82..9047a616c8 100644 --- a/Doc/lib/libmailbox.tex +++ b/Doc/lib/libmailbox.tex @@ -69,10 +69,18 @@ mailbox specified by \var{dirname} is made available. \end{classdesc} \begin{classdesc}{BabylMailbox}{fp\optional{, factory}} -Access a Babyl mailbox, which is similar to an MMDF mailbox. Mail -messages start with a line containing only \code{'*** EOOH ***'} and -end with a line containing only \code{'\e{}037\e{}014'}. -\var{factory} is as with the \class{UnixMailbox} class. +Access a Babyl mailbox, which is similar to an MMDF mailbox. In +Babyl format, each message has two sets of headers, the +\emph{original} headers and the \emph{visible} headers. The original +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} |