summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2004-05-10 23:12:52 (GMT)
committerBarry Warsaw <barry@python.org>2004-05-10 23:12:52 (GMT)
commitdd69b0ab6c8ba25b6cdff65df30524411dee3cc8 (patch)
tree6d1e01c8c38cd0814b0cfe71297cea105f635b92
parentfb85739494ffdd12a674bfe0d83f93da7ba75aa1 (diff)
downloadcpython-dd69b0ab6c8ba25b6cdff65df30524411dee3cc8.zip
cpython-dd69b0ab6c8ba25b6cdff65df30524411dee3cc8.tar.gz
cpython-dd69b0ab6c8ba25b6cdff65df30524411dee3cc8.tar.bz2
Added a note describing how fp should be opened in binary mode, especially on
Windows. Closes SF # 586899.
-rw-r--r--Doc/lib/libmailbox.tex4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex
index 947c2d3..767b678 100644
--- a/Doc/lib/libmailbox.tex
+++ b/Doc/lib/libmailbox.tex
@@ -18,6 +18,10 @@ 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 -- and the note below).
+\note{For reasons of this module's internal implementation, you will probably
+want to open the \var{fp} object in binary mode. This is especially important
+on Windows.}
+
For maximum portability, messages in a \UNIX-style mailbox are
separated by any line that begins exactly with the string \code{'From
'} (note the trailing space) if preceded by exactly two newlines.