Commit 3c7ba701 authored by Guido van Rossum's avatar Guido van Rossum

Mention seekable parameter (AMK).

Added pointer to mailbox module.
parent 29c3d653
...@@ -8,9 +8,14 @@ collection of ``email headers'' as defined by the Internet standard ...@@ -8,9 +8,14 @@ collection of ``email headers'' as defined by the Internet standard
RFC 822. It is used in various contexts, usually to read such headers RFC 822. It is used in various contexts, usually to read such headers
from a file. from a file.
(Note that there's a separate, currently undocumented, module to read
Unix style mailbox files: \code{mailbox}.)
A \code{Message} instance is instantiated with an open file object as A \code{Message} instance is instantiated with an open file object as
parameter. Instantiation reads headers from the file up to a blank parameter. The optional \code{seekable} parameter indicates if the
line and stores them in the instance; after instantiation, the file is file object is seekable; the default value is 1 for true.
Instantiation reads headers from the file up to a blank line and
stores them in the instance; after instantiation, the file is
positioned directly after the blank line that terminates the headers. positioned directly after the blank line that terminates the headers.
Input lines as read from the file may either be terminated by CR-LF or Input lines as read from the file may either be terminated by CR-LF or
......
...@@ -8,9 +8,14 @@ collection of ``email headers'' as defined by the Internet standard ...@@ -8,9 +8,14 @@ collection of ``email headers'' as defined by the Internet standard
RFC 822. It is used in various contexts, usually to read such headers RFC 822. It is used in various contexts, usually to read such headers
from a file. from a file.
(Note that there's a separate, currently undocumented, module to read
Unix style mailbox files: \code{mailbox}.)
A \code{Message} instance is instantiated with an open file object as A \code{Message} instance is instantiated with an open file object as
parameter. Instantiation reads headers from the file up to a blank parameter. The optional \code{seekable} parameter indicates if the
line and stores them in the instance; after instantiation, the file is file object is seekable; the default value is 1 for true.
Instantiation reads headers from the file up to a blank line and
stores them in the instance; after instantiation, the file is
positioned directly after the blank line that terminates the headers. positioned directly after the blank line that terminates the headers.
Input lines as read from the file may either be terminated by CR-LF or Input lines as read from the file may either be terminated by CR-LF or
......
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