email.Parser
index
/usr/local/lib/python2.3/email/Parser.py

A parser of RFC 2822 and MIME email messages.

 
Modules
       
email.Errors
email.Message
re

 
Classes
       
Parser
HeaderParser

 
class HeaderParser(Parser)
    A subclass of Parser, this one only meaningfully parses message headers.
 
This class can be used if all you're interested in is the headers of a
message.  While it consumes the message body, it does not parse it, but
simply makes it available as a string payload.
 
Parsing with this subclass can be considerably faster if all you're
interested in is the message headers.
 
  Methods inherited from Parser:
__init__(self, _class=<class email.Message.Message>, strict=False)
Parser of RFC 2822 and MIME email messages.
 
Creates an in-memory object tree representing the email message, which
can then be manipulated and turned over to a Generator to return the
textual representation of the message.
 
The string must be formatted as a block of RFC 2822 headers and header
continuation lines, optionally preceeded by a `Unix-from' header.  The
header block is terminated either by the end of the string or by a
blank line.
 
_class is the class to instantiate for new message objects when they
must be created.  This class must have a constructor that can take
zero arguments.  Default is Message.Message.
 
Optional strict tells the parser to be strictly RFC compliant or to be
more forgiving in parsing of ill-formatted MIME documents.  When
non-strict mode is used, the parser will try to make up for missing or
erroneous boundaries and other peculiarities seen in the wild.
Default is non-strict parsing.
parse(self, fp, headersonly=False)
Create a message structure from the data in a file.
 
Reads all the data from the file and returns the root of the message
structure.  Optional headersonly is a flag specifying whether to stop
parsing after reading the headers or not.  The default is False,
meaning it parses the entire contents of the file.
parsestr(self, text, headersonly=False)
Create a message structure from a string.
 
Returns the root of the message structure.  Optional headersonly is a
flag specifying whether to stop parsing after reading the headers or
not.  The default is False, meaning it parses the entire contents of
the file.

 
class Parser
     Methods defined here:
__init__(self, _class=<class email.Message.Message>, strict=False)
Parser of RFC 2822 and MIME email messages.
 
Creates an in-memory object tree representing the email message, which
can then be manipulated and turned over to a Generator to return the
textual representation of the message.
 
The string must be formatted as a block of RFC 2822 headers and header
continuation lines, optionally preceeded by a `Unix-from' header.  The
header block is terminated either by the end of the string or by a
blank line.
 
_class is the class to instantiate for new message objects when they
must be created.  This class must have a constructor that can take
zero arguments.  Default is Message.Message.
 
Optional strict tells the parser to be strictly RFC compliant or to be
more forgiving in parsing of ill-formatted MIME documents.  When
non-strict mode is used, the parser will try to make up for missing or
erroneous boundaries and other peculiarities seen in the wild.
Default is non-strict parsing.
parse(self, fp, headersonly=False)
Create a message structure from the data in a file.
 
Reads all the data from the file and returns the root of the message
structure.  Optional headersonly is a flag specifying whether to stop
parsing after reading the headers or not.  The default is False,
meaning it parses the entire contents of the file.
parsestr(self, text, headersonly=False)
Create a message structure from a string.
 
Returns the root of the message structure.  Optional headersonly is a
flag specifying whether to stop parsing after reading the headers or
not.  The default is False, meaning it parses the entire contents of
the file.

 
Functions
       
StringIO(...)
StringIO([s]) -- Return a StringIO-like stream for reading or writing

 
Data
        EMPTYSTRING = ''
NL = '\n'
NLCRE = <_sre.SRE_Pattern object>