email.Generator
index
/usr/lib/python2.2/email/Generator.py

Classes to generate plain text from a message object tree.

 
Modules
            
email.Errors
email.Message
random
re
time
 
Classes
            
Generator
DecodedGenerator
 
class DecodedGenerator(Generator)
      Generator a text representation of a message.
 
Like the Generator base class, except that non-text parts are substituted
with a format string representing the part.
 
   Methods defined here:
__init__(self, outfp, mangle_from_=1, maxheaderlen=78, fmt=None)
Like Generator.__init__() except that an additional optional
argument is allowed.
 
Walks through all subparts of a message.  If the subpart is of main
type `text', then it prints the decoded payload of the subpart.
 
Otherwise, fmt is a format string that is used instead of the message
payload.  fmt is expanded with the following keywords (in
%(keyword)s format):
 
type       : Full MIME type of the non-text part
maintype   : Main MIME type of the non-text part
subtype    : Sub-MIME type of the non-text part
filename   : Filename of the non-text part
description: Description associated with the non-text part
encoding   : Content transfer encoding of the non-text part
 
The default value for fmt is None, meaning
 
[Non-text (%(type)s) part of message omitted, filename %(filename)s]
_dispatch(self, msg)

Data and non-method functions defined here:
__doc__ = 'Generator a text representation of a message.\n...ith a format string representing the part.\n '
__module__ = 'email.Generator'

Methods inherited from Generator:
__call__(self, msg, unixfrom=0)
Print the message object tree rooted at msg to the output file
specified when the Generator instance was created.
 
unixfrom is a flag that forces the printing of a Unix From_ delimiter
before the first object in the message tree.  If the original message
has no From_ delimiter, a `standard' one is crafted.  By default, this
is 0 to inhibit the printing of any From_ delimiter.
 
Note that for subobjects, no From_ line is printed.
_handle_message(self, msg)
_handle_message_delivery_status(self, msg)
_handle_multipart(self, msg, isdigest=0)
_handle_multipart_digest(self, msg)
_handle_text(self, msg)
_split_header(self, text)
_write(self, msg)
_writeBody = _handle_text(self, msg)
_write_headers(self, msg)
write(self, s)
 
class Generator
      Generates output from a Message object tree.
 
This basic generator writes the message to the given file object as plain
text.
 
   Methods defined here:
__call__(self, msg, unixfrom=0)
Print the message object tree rooted at msg to the output file
specified when the Generator instance was created.
 
unixfrom is a flag that forces the printing of a Unix From_ delimiter
before the first object in the message tree.  If the original message
has no From_ delimiter, a `standard' one is crafted.  By default, this
is 0 to inhibit the printing of any From_ delimiter.
 
Note that for subobjects, no From_ line is printed.
__init__(self, outfp, mangle_from_=1, maxheaderlen=78)
Create the generator for message flattening.
 
outfp is the output file-like object for writing the message to.  It
must have a write() method.
 
Optional mangle_from_ is a flag that, when true, escapes From_ lines
in the body of the message by putting a `>' in front of them.
 
Optional maxheaderlen specifies the longest length for a non-continued
header.  When a header line is longer (in characters, with tabs
expanded to 8 spaces), than maxheaderlen, the header will be broken on
semicolons and continued as per RFC 2822.  If no semicolon is found,
then the header is left alone.  Set to zero to disable wrapping
headers.  Default is 78, as recommended (but not required by RFC
2822.
_dispatch(self, msg)
_handle_message(self, msg)
_handle_message_delivery_status(self, msg)
_handle_multipart(self, msg, isdigest=0)
_handle_multipart_digest(self, msg)
_handle_text(self, msg)
_split_header(self, text)
_write(self, msg)
_writeBody = _handle_text(self, msg)
_write_headers(self, msg)
write(self, s)

Data and non-method functions defined here:
__doc__ = 'Generates output from a Message object tree.\n\... the given file object as plain\n text.\n '
__module__ = 'email.Generator'
 
Functions
            
StringIO(...)
StringIO([s]) -- Return a StringIO-like stream for reading or writing
_make_boundary(self, text=None)
# Helper
 
Data
             BAR = '|'
EMPTYSTRING = ''
NL = '\n'
NLTAB = '\n\t'
SEMINLTAB = ';\n\t'
SEMISPACE = '; '
SPACE8 = ' '
UNDERSCORE = '_'
__file__ = '/usr/lib/python2.2/email/Generator.pyc'
__name__ = 'email.Generator'
fcre = <_sre.SRE_Pattern object>