<!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=
"next" href=
"module-mimetypes.html" />
<link rel=
"prev" href=
"module-mhlib.html" />
<link rel=
"parent" href=
"netdata.html" />
<link rel=
"next" href=
"mimetools-message-objects.html" />
<meta name='aesop' content='information'
/>
<title>12.6 mimetools -- Tools for parsing MIME messages
</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.5.3 Message Objects"
href=
"mh-message-objects.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. Internet Data Handling"
href=
"netdata.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.6.1 Additional Methods of"
href=
"mimetools-message-objects.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=
"mh-message-objects.html">12.5.3 Message Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"netdata.html">12. Internet Data Handling
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"mimetools-message-objects.html">12.6.1 Additional Methods of
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION0014600000000000000000">
12.6 <tt class=
"module">mimetools
</tt> --
Tools for parsing MIME messages
</A>
<A NAME=
"module-mimetools"></A>
<div class=
"versionnote"><b>Deprecated since release
2.3.
</b>
The
<tt class=
"module"><a href=
"module-email.html">email
</a></tt> package should be used in
preference to the
<tt class=
"module">mimetools
</tt> module. This
module is present only to maintain backward
compatibility.
</div><p></p>
This module defines a subclass of the
<tt class=
"module"><a href=
"module-rfc822.html">rfc822
</a></tt><a id='l2h-
4011' xml:id='l2h-
4011'
></a> module's
<tt class=
"class">Message
</tt> class and a number of utility functions that are
useful for the manipulation for MIME multipart or encoded message.
It defines the following items:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
4005' xml:id='l2h-
4005'
class=
"class">Message
</tt></b>(
</nobr></td>
<td><var>fp
</var><big>[
</big><var>, seekable
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Return a new instance of the
<tt class=
"class">Message
</tt> class. This is a
subclass of the
<tt class=
"class">rfc822.Message
</tt> class, with some additional
methods (see below). The
<var>seekable
</var> argument has the same meaning
as for
<tt class=
"class">rfc822.Message
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4006' xml:id='l2h-
4006'
class=
"function">choose_boundary
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return a unique string that has a high likelihood of being usable as a
part boundary. The string has the form
<code>'
<var>hostipaddr
</var>.
<var>uid
</var>.
<var>pid
</var>.
<var>timestamp
</var>.
<var>random
</var>'
</code>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4007' xml:id='l2h-
4007'
class=
"function">decode
</tt></b>(
</nobr></td>
<td><var>input, output, encoding
</var>)
</td></tr></table></dt>
Read data encoded using the allowed MIME
<var>encoding
</var> from open file
object
<var>input
</var> and write the decoded data to open file object
<var>output
</var>. Valid values for
<var>encoding
</var> include
<code>'base64'
</code>,
<code>'quoted-printable'
</code>,
<code>'uuencode'
</code>,
<code>'x-uuencode'
</code>,
<code>'uue'
</code>,
<code>'x-uue'
</code>,
<code>'
7bit'
</code>, and
<code>'
8bit'
</code>. Decoding messages encoded in
<code>'
7bit'
</code> or
<code>'
8bit'
</code>
has no effect. The input is simply copied to the output.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4008' xml:id='l2h-
4008'
class=
"function">encode
</tt></b>(
</nobr></td>
<td><var>input, output, encoding
</var>)
</td></tr></table></dt>
Read data from open file object
<var>input
</var> and write it encoded using
the allowed MIME
<var>encoding
</var> to open file object
<var>output
</var>.
Valid values for
<var>encoding
</var> are the same as for
<tt class=
"method">decode()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4009' xml:id='l2h-
4009'
class=
"function">copyliteral
</tt></b>(
</nobr></td>
<td><var>input, output
</var>)
</td></tr></table></dt>
Read lines from open file
<var>input
</var> until EOF and write them to
open file
<var>output
</var>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4010' xml:id='l2h-
4010'
class=
"function">copybinary
</tt></b>(
</nobr></td>
<td><var>input, output
</var>)
</td></tr></table></dt>
Read blocks until EOF from open file
<var>input
</var> and write them to
open file
<var>output
</var>. The block size is currently fixed at
8192.
<p class=
"heading">See Also:
</p>
<dl compact=
"compact" class=
"seemodule">
<dt>Module
<b><tt class=
"module"><a href=
"module-email.html">email
</a></tt>:
</b>
<dd>Comprehensive email handling package; supersedes
the
<tt class=
"module">mimetools
</tt> module.
<dl compact=
"compact" class=
"seemodule">
<dt>Module
<b><tt class=
"module"><a href=
"module-rfc822.html">rfc822
</a></tt>:
</b>
<dd>Provides the base class for
<tt class=
"class">mimetools.Message
</tt>.
<dl compact=
"compact" class=
"seemodule">
<dt>Module
<b><tt class=
"module"><a href=
"module-multifile.html">multifile
</a></tt>:
</b>
<dd>Support for reading files which contain
distinct parts, such as MIME data.
<dl compact=
"compact" class=
"seeurl">
<dt><a href=
"http://www.cs.uu.nl/wais/html/na-dir/mail/mime-faq/.html"
class=
"url">http://www.cs.uu.nl/wais/html/na-dir/mail/mime-faq/.html
</a></dt>
The MIME Frequently Asked Questions document. For an
overview of MIME, see the answer to question
1.1 in Part
1
<p><br /></p><hr class='online-navigation'
/>
<div class='online-navigation'
>
<!--Table of Child-Links-->
<A NAME=
"CHILD_LINKS"><STRONG>Subsections
</STRONG></a>
<LI><A href=
"mimetools-message-objects.html">12.6.1 Additional Methods of Message Objects
</a>
<!--End of Table of Child-Links-->
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"12.5.3 Message Objects"
href=
"mh-message-objects.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. Internet Data Handling"
href=
"netdata.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.6.1 Additional Methods of"
href=
"mimetools-message-objects.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=
"mh-message-objects.html">12.5.3 Message Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"netdata.html">12. Internet Data Handling
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"mimetools-message-objects.html">12.6.1 Additional Methods of
</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.