<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"prev" href=
"module-MimeWriter.html" />
<link rel=
"parent" href=
"module-MimeWriter.html" />
<link rel=
"next" href=
"module-mimify.html" />
<meta name='aesop' content='information'
/>
<title>12.8.1 MimeWriter Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"12.8 MimeWriter "
href=
"module-MimeWriter.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"12.8 MimeWriter "
href=
"module-MimeWriter.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"12.9 mimify "
href=
"module-mimify.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-MimeWriter.html">12.8 MimeWriter
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-MimeWriter.html">12.8 MimeWriter
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-mimify.html">12.9 mimify
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0014810000000000000000"></A><A NAME=
"MimeWriter-objects"></A>
12.8.1 MimeWriter Objects
<tt class=
"class">MimeWriter
</tt> instances have the following methods:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4045' xml:id='l2h-
4045'
class=
"method">addheader
</tt></b>(
</nobr></td>
<td><var>key, value
</var><big>[
</big><var>, prefix
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Add a header line to the MIME message. The
<var>key
</var> is the name of
the header, where the
<var>value
</var> obviously provides the value of the
header. The optional argument
<var>prefix
</var> determines where the header
is inserted;
"<tt class="samp
">0</tt>" means append at the end,
"<tt class="samp
">1</tt>" is insert at
the start. The default is to append.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4046' xml:id='l2h-
4046'
class=
"method">flushheaders
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
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
<span class=
"mimetype">message/rfc822
</span> that's (mis)used
to store some header-like information.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4047' xml:id='l2h-
4047'
class=
"method">startbody
</tt></b>(
</nobr></td>
<td><var>ctype
</var><big>[
</big><var>, plist
</var><big>[
</big><var>, prefix
</var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
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
<var>ctype
</var>, and the optional parameter
<var>plist
</var> provides
additional parameters for the content-type declaration.
<var>prefix
</var>
functions as in
<tt class=
"method">addheader()
</tt> except that the default is to
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4048' xml:id='l2h-
4048'
class=
"method">startmultipartbody
</tt></b>(
</nobr></td>
<td><var>subtype
</var><big>[
</big><var>,
boundary
</var><big>[
</big><var>, plist
</var><big>[
</big><var>, prefix
</var><big>]
</big><var></var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
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
<var>subtype
</var> provides the multipart subtype,
<var>boundary
</var> may provide a user-defined boundary specification, and
<var>plist
</var> provides optional parameters for the subtype.
<var>prefix
</var> functions as in
<tt class=
"method">startbody()
</tt>. Subparts should be
created using
<tt class=
"method">nextpart()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4049' xml:id='l2h-
4049'
class=
"method">nextpart
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Returns a new instance of
<tt class=
"class">MimeWriter
</tt> 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
<tt class=
"method">startmultipartbody()
</tt> before using
<tt class=
"method">nextpart()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4050' xml:id='l2h-
4050'
class=
"method">lastpart
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
This is used to designate the last part of a multipart message, and
should
<em>always
</em> be used when writing multipart messages.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"12.8 MimeWriter "
href=
"module-MimeWriter.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"12.8 MimeWriter "
href=
"module-MimeWriter.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"12.9 mimify "
href=
"module-mimify.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-MimeWriter.html">12.8 MimeWriter
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-MimeWriter.html">12.8 MimeWriter
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-mimify.html">12.9 mimify
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.