sam-t2/devtools/amd64/html/python/lib/mimetools-message-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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-mimetools.html" />
<link rel="parent" href="module-mimetools.html" />
<link rel="next" href="module-mimetypes.html" />
<meta name='aesop' content='information' />
<title>12.6.1 Additional Methods of Message Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.6 mimetools  "
  href="module-mimetools.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.6 mimetools  "
  href="module-mimetools.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.7 mimetypes  "
  href="module-mimetypes.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-mimetools.html">12.6 mimetools  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-mimetools.html">12.6 mimetools  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-mimetypes.html">12.7 mimetypes  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0014610000000000000000"></A><A NAME="mimetools-message-objects"></A>
<BR>
12.6.1 Additional Methods of Message Objects

</H2>

<P>
The <tt class="class">Message</tt> class defines the following methods in
addition to the <tt class="class">rfc822.Message</tt> methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4012' xml:id='l2h-4012' class="method">getplist</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the parameter list of the <span class="mailheader">Content-Type:</span> header.
This is a list of strings.  For parameters of the form
"<tt class="samp"><var>key</var>=<var>value</var></tt>", <var>key</var> is converted to lower case but
<var>value</var> is not.  For example, if the message contains the header
"<tt class="samp">Content-type: text/html; spam=1; Spam=2; Spam</tt>" then
<tt class="method">getplist()</tt> will return the Python list <code>['spam=1',
'spam=2', 'Spam']</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4013' xml:id='l2h-4013' class="method">getparam</tt></b>(</nobr></td>
  <td><var>name</var>)</td></tr></table></dt>
<dd>
Return the <var>value</var> of the first parameter (as returned by
<tt class="method">getplist()</tt>) of the form "<tt class="samp"><var>name</var>=<var>value</var></tt>" for the
given <var>name</var>.  If <var>value</var> is surrounded by quotes of the form
`<code>&lt;</code>...<code>&gt;</code>' or `<code>"</code>...<code>"</code>', these are removed.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4014' xml:id='l2h-4014' class="method">getencoding</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the encoding specified in the
<span class="mailheader">Content-Transfer-Encoding:</span> message header.  If no such
header exists, return <code>'7bit'</code>.  The encoding is converted to
lower case.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4015' xml:id='l2h-4015' class="method">gettype</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the message type (of the form "<tt class="samp"><var>type</var>/<var>subtype</var></tt>")
as specified in the <span class="mailheader">Content-Type:</span> header.  If no such
header exists, return <code>'text/plain'</code>.  The type is converted to
lower case.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4016' xml:id='l2h-4016' class="method">getmaintype</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the main type as specified in the <span class="mailheader">Content-Type:</span>
header.  If no such header exists, return <code>'text'</code>.  The main
type is converted to lower case.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4017' xml:id='l2h-4017' class="method">getsubtype</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the subtype as specified in the <span class="mailheader">Content-Type:</span>
header.  If no such header exists, return <code>'plain'</code>.  The subtype
is converted to lower case.
</dl>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.6 mimetools  "
  href="module-mimetools.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.6 mimetools  "
  href="module-mimetools.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.7 mimetypes  "
  href="module-mimetypes.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-mimetools.html">12.6 mimetools  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-mimetools.html">12.6 mimetools  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-mimetypes.html">12.7 mimetypes  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>