GNU Info

(python2.1-lib.info)MimeWriter Objects

---

Prev: MimeWriter Up: MimeWriter

---

Enter node , (file) or (file)node

MimeWriter Objects
------------------

`MimeWriter' instances have the following methods:

`addheader(key, value[, prefix])'
     Add a header line to the MIME message. The KEY is the name of the
     header, where the VALUE obviously provides the value of the
     header. The optional argument PREFIX determines where the header
     is inserted; `0' means append at the end, `1' is insert at the
     start. The default is to append.

`flushheaders()'
     Causes all headers accumulated so far to be written out (and
     forgotten). This is useful if you don't need a body part at all,
     e.g. for a subpart of type `message/rfc822' that's (mis)used to
     store some header-like information.

`startbody(ctype[, plist[, prefix]])'
     Returns a file-like object which can be used to write to the body
     of the message.  The content-type is set to the provided CTYPE,
     and the optional parameter PLIST provides additional parameters
     for the content-type declaration. PREFIX functions as in
     `addheader()' except that the default is to insert at the start.

`startmultipartbody(subtype[, boundary[, plist[, prefix]]])'
     Returns a file-like object which can be used to write to the body
     of the message.  Additionally, this method initializes the
     multi-part code, where SUBTYPE provides the multipart subtype,
     BOUNDARY may provide a user-defined boundary specification, and
     PLIST provides optional parameters for the subtype.  PREFIX
     functions as in `startbody()'.  Subparts should be created using
     `nextpart()'.

`nextpart()'
     Returns a new instance of `MimeWriter' which represents an
     individual part in a multipart message.  This may be used to write
     the part as well as used for creating recursively complex multipart
     messages. The message must first be initialized with
     `startmultipartbody()' before using `nextpart()'.

`lastpart()'
     This is used to designate the last part of a multipart message, and
     should _always_ be used when writing multipart messages.