_ClassType Message

Return the entire formatted message as a string. This includes the headers, body, and envelope header.

Return the entire formatted message as a string. Optional `unixfrom' when True, means include the Unix From_ envelope header.

This is a convenience method and may not generate the message exactly as you intend because by default it mangles lines that begin with "From ". For more flexibility, use the flatten() method of a Generator instance.

Add the given payload to the current payload.

The current payload will always be a list of objects after this method is called. If you want to set the payload to a scalar object, use set_payload() instead.

Return a reference to the payload.

The payload will either be a list object or a string. If you mutate the list object, you modify the message's payload in place. 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 (default is False).

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, or if the payload has bogus data (i.e. bogus base64 or uuencoded data), the payload is returned as-is.

If the message is a multipart and the decode flag is True, then None is returned.

Set the payload to the given value.

Optional charset sets the message's default character set. See set_charset() for details.

Set the charset of the payload to a given character set.

charset can be a Charset instance, a string naming a character set, or None. If it is a string it will be converted to a Charset instance. If charset is None, the charset parameter will be removed from the Content-Type field. Anything else will generate a TypeError.

The message will be assumed to be of type text/* encoded with charset.input_charset. It will be converted to charset.output_charset and encoded properly, if needed, when generating the plain text representation of the message. MIME headers (MIME-Version, Content-Type, Content-Transfer-Encoding) will be added as needed.

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 get_all() to get all the values matching a header field name.

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.

Delete all occurrences of a header, if present.

Does not raise an exception if the header is missing.

Return a list of all the message's header field names.

These will be sorted in the order they appeared in the original message, or were added to the message, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

Return a list of all the message's header values.

These will be sorted in the order they appeared in the original message, or were added to the message, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

Get all the message's header fields and values.

These will be sorted in the order they appeared in the original message, or were added to the message, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

Get a header value.

Like __getitem__() but return failobj instead of None when the field is missing.

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).

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')

Replace a header.

Replace the first matching header found in the message, retaining header order and case. If no matching header was found, a KeyError is raised.

Return the message's content type.

The returned string is coerced to lower case of the form `maintype/subtype'. If there was no Content-Type header in the message, the default type as given by get_default_type() will be returned. Since according to RFC 2045, messages always have a default type this will always return a value.

RFC 2045 defines a message's default type to be text/plain unless it appears inside a multipart/digest container, in which case it would be message/rfc822.

Return the message's main content type.

This is the `maintype' part of the string returned by get_content_type().

Returns the message's sub-content type.

This is the `subtype' part of the string returned by get_content_type().

Return the `default' content type.

Most messages have a default content type of text/plain, except for messages that are subparts of multipart/digest containers. Such subparts have a default content type of message/rfc822.

Set the `default' content type.

ctype should be either "text/plain" or "message/rfc822", although this is not enforced. The default content type is not stored in the Content-Type header.

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 as described in the get_param() method.

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. If unquote is True, the value is unquoted.

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, or the Content-Type header has no such parameter.  Optional
header is the header to search instead of Content-Type.

Parameter keys are always compared case insensitively.  The return
value can either be a string, or a 3-tuple if the parameter was RFC
2231 encoded.  When it's a 3-tuple, the elements of the value are of
the form (CHARSET, LANGUAGE, VALUE).  Note that both CHARSET and
LANGUAGE can be None, in which case you should consider VALUE to be
encoded in the us-ascii charset.  You can usually ignore LANGUAGE.

Your application should be prepared to deal with 3-tuple return
values, and can convert the parameter to a Unicode string like so:

    param = msg.get_param('foo')
    if isinstance(param, tuple):
        param = unicode(param[2], param[0] or 'us-ascii')

In any case, the parameter value (either the returned string, or the
VALUE item in the 3-tuple) is always unquoted, unless unquote is set
to False.

Set a parameter in the Content-Type header.

If the parameter already exists in the header, its value will be
replaced with the new value.

If header is Content-Type and has not yet been defined for this
message, it will be set to "text/plain" and the new parameter and
value will be appended as per RFC 2045.

An alternate header can specified in the header argument, and all
parameters will be quoted as necessary unless requote is False.

If charset is specified, the parameter will be encoded according to RFC
2231.  Optional language specifies the RFC 2231 language, defaulting
to the empty string.  Both charset and language should be strings.

Remove the given parameter completely from the Content-Type header.

The header will be re-written in place without the parameter or its value. All values will be quoted as necessary unless requote is False. Optional header specifies an alternative to the Content-Type header.

Set the main type and subtype for the Content-Type header.

type must be a string in the form "maintype/subtype", otherwise a ValueError is raised.

This method replaces the Content-Type header, keeping all the parameters in place. If requote is False, this leaves the existing header's quoting as is. Otherwise, the parameters will be quoted (the default).

An alternative header can be specified in the header argument. When the Content-Type header is set, we'll always also add a MIME-Version header.

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. If that header is missing the `filename' parameter, this method falls back to looking for the `name' parameter.

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.

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.

Return the charset parameter of the Content-Type header.

The returned string is always coerced to lower case. If there is no Content-Type header, or if that header has no charset parameter, failobj is returned.

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.