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

Basic message object for the email package object model.

 
Modules
            
email.Errors
email.Utils
base64
quopri
re
 
Classes
            
Message
 
class Message
      Basic message object for use inside the object tree.
 
A message object is defined as something that has a bunch of RFC 2822
headers and a payload.  If the body of the message is a multipart, then
the payload is a list of Messages, otherwise it is a string.
 
These objects implement part of the `mapping' interface, which assumes
there is exactly one occurrance of the header per message.  Some headers
do in fact appear multiple times (e.g. Received:) and for those headers,
you must use the explicit API to set or get all the headers.  Not all of
the mapping methods are implemented.
 
   Methods defined here:
__contains__(self, key)
__delitem__(self, name)
Delete all occurrences of a header, if present.
 
Does not raise an exception if the header is missing.
__getitem__(self, name)
Get a header value.
 
Return None if the header is missing instead of raising an exception.
 
Note that if the header appeared multiple times, exactly which
occurrance gets returned is undefined.  Use getall() to get all
the values matching a header field name.
__init__(self)
__len__(self)
Return the total number of headers, including duplicates.
__setitem__(self, name, val)
Set the value of a header.
 
Note: this does not overwrite an existing header with the same field
name.  Use __delitem__() first to delete any existing headers.
__str__(self)
Return the entire formatted message as a string.
This includes the headers, body, and `unixfrom' line.
_get_params_preserve(self, failobj, header)
add_header(self, _name, _value, **_params)
Extended header setting.
 
name is the header field to add.  keyword arguments can be used to set
additional parameters for the header field, with underscores converted
to dashes.  Normally the parameter will be added as key="value" unless
value is None, in which case only the key will be added.
 
Example:
 
msg.add_header('content-disposition', 'attachment', filename='bud.gif')
add_payload(self, payload)
Add the given payload to the current payload.
 
If the current payload is empty, then the current payload will be made
a scalar, set to the given value.
as_string(self, unixfrom=0)
Return the entire formatted message as a string.
Optional `unixfrom' when true, means include the Unix From_ envelope
header.
attach = add_payload(self, payload)
get(self, name, failobj=None)
Get a header value.
 
Like __getitem__() but return failobj instead of None when the field
is missing.
get_all(self, name, failobj=None)
Return a list of all the values for the named field.
 
These will be sorted in the order they appeared in the original
message, and may contain duplicates.  Any fields deleted and
re-inserted are always appended to the header list.
 
If no such fields exist, failobj is returned (defaults to None).
get_boundary(self, failobj=None)
Return the boundary associated with the payload if present.
 
The boundary is extracted from the Content-Type: header's `boundary'
parameter, and it is unquoted.
get_charsets(self, failobj=None)
Return a list containing the charset(s) used in this message.
 
The returned list of items describes the Content-Type: headers'
charset parameter for this message and all the subparts in its
payload.
 
Each item will either be a string (the value of the charset parameter
in the Content-Type: header of that part) or the value of the
'failobj' parameter (defaults to None), if the part does not have a
main MIME type of "text", or the charset is not defined.
 
The list will contain one string for each part of the message, plus
one for the container message (i.e. self), so that a non-multipart
message will still return a list of length 1.
get_filename(self, failobj=None)
Return the filename associated with the payload if present.
 
The filename is extracted from the Content-Disposition: header's
`filename' parameter, and it is unquoted.
get_main_type(self, failobj=None)
Return the message's main content type if present.
get_param(self, param, failobj=None, header='content-type')
Return the parameter value if found in the Content-Type: header.
 
Optional failobj is the object to return if there is no Content-Type:
header.  Optional header is the header to search instead of
Content-Type:
 
Parameter keys are always compared case insensitively.  Values are
always unquoted.
get_params(self, failobj=None, header='content-type')
Return the message's Content-Type: parameters, as a list.
 
The elements of the returned list are 2-tuples of key/value pairs, as
split on the `=' sign.  The left hand side of the `=' is the key,
while the right hand side is the value.  If there is no `=' sign in
the parameter the value is the empty string.  The value is always
unquoted.
 
Optional failobj is the object to return if there is no Content-Type:
header.  Optional header is the header to search instead of
Content-Type:
get_payload(self, i=None, decode=0)
Return the current payload exactly as is.
 
Optional i returns that index into the payload.
 
Optional decode is a flag indicating whether the payload should be
decoded or not, according to the Content-Transfer-Encoding: header.
When true and the message is not a multipart, the payload will be
decoded if this header's value is `quoted-printable' or `base64'.  If
some other encoding is used, or the header is missing, the payload is
returned as-is (undecoded).  If the message is a multipart and the
decode flag is true, then None is returned.
get_subtype(self, failobj=None)
Return the message's content subtype if present.
get_type(self, failobj=None)
Returns the message's content type.
 
The returned string is coerced to lowercase and returned as a single
string of the form `maintype/subtype'.  If there was no Content-Type:
header in the message, failobj is returned (defaults to None).
get_unixfrom(self)
has_key(self, name)
Return true if the message contains the header.
is_multipart(self)
Return true if the message consists of multiple parts.
items(self)
Get all the message's header fields and values.
 
These will be sorted in the order they appeared in the original
message, and may contain duplicates.  Any fields deleted and
re-inserted are always appended to the header list.
keys(self)
Return a list of all the message's header field names.
 
These will be sorted in the order they appeared in the original
message, and may contain duplicates.  Any fields deleted and
re-inserted are always appended to the header list.
set_boundary(self, boundary)
Set the boundary parameter in Content-Type: to 'boundary'.
 
This is subtly different than deleting the Content-Type: header and
adding a new one with a new boundary parameter via add_header().  The
main difference is that using the set_boundary() method preserves the
order of the Content-Type: header in the original message.
 
HeaderParseError is raised if the message has no Content-Type: header.
set_payload(self, payload)
Set the payload to the given value.
set_unixfrom(self, unixfrom)
# Unix From_ line
values(self)
Return a list of all the message's header values.
 
These will be sorted in the order they appeared in the original
message, and may contain duplicates.  Any fields deleted and
re-inserted are always appended to the header list.
walk(self)
Walk over the message tree, yielding each subpart.
 
The walk is performed in depth-first order.  This method is a
generator.

Data and non-method functions defined here:
__doc__ = 'Basic message object for use inside the object ... the mapping methods are implemented.\n\n '
__module__ = 'email.Message'
 
Functions
            
StringIO(...)
StringIO([s]) -- Return a StringIO-like stream for reading or writing
 
Data
             SEMISPACE = '; '
__file__ = '/usr/lib/python2.2/email/Message.pyc'
__name__ = 'email.Message'
generators = _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 4096)
paramre = <_sre.SRE_Pattern object>