sam-t2/devtools/v8plus/html/python/lib/module-email.Encoders.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="next" href="module-email.Errors.html" />
<link rel="prev" href="module-email.Charset.html" />
<link rel="parent" href="module-email.html" />
<link rel="next" href="module-email.Errors.html" />
<meta name='aesop' content='information' />
<title>12.2.7 Encoders</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.2.6 Representing character sets"
  href="module-email.Charset.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.2 email  "
  href="module-email.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.2.8 Exception and Defect"
  href="module-email.Errors.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-email.Charset.html">12.2.6 Representing character sets</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">12.2 email  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-email.Errors.html">12.2.8 Exception and Defect</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0014270000000000000000">
12.2.7 Encoders</A>
</H2>
<A NAME="module-email.Encoders"></A>

<P>
When creating <tt class="class">Message</tt> objects from scratch, you often need to
encode the payloads for transport through compliant mail servers.
This is especially true for <span class="mimetype">image/*</span> and <span class="mimetype">text/*</span>
type messages containing binary data.

<P>
The <tt class="module">email</tt> package provides some convenient encodings in its
<tt class="module">Encoders</tt> module.  These encoders are actually used by the
<tt class="class">MIMEAudio</tt> and <tt class="class">MIMEImage</tt> class constructors to provide default
encodings.  All encoder functions take exactly one argument, the message
object to encode.  They usually extract the payload, encode it, and reset the
payload to this newly encoded value.  They should also set the
<span class="mailheader">Content-Transfer-Encoding:</span> header as appropriate.

<P>
Here are the encoding functions provided:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3931' xml:id='l2h-3931' class="function">encode_quopri</tt></b>(</nobr></td>
  <td><var>msg</var>)</td></tr></table></dt>
<dd>
Encodes the payload into quoted-printable form and sets the
<span class="mailheader">Content-Transfer-Encoding:</span> header to
<code>quoted-printable</code><A NAME="tex2html119"
  HREF="#foot58057"><SUP>12.2</SUP></A>.
This is a good encoding to use when most of your payload is normal
printable data, but contains a few unprintable characters.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3932' xml:id='l2h-3932' class="function">encode_base64</tt></b>(</nobr></td>
  <td><var>msg</var>)</td></tr></table></dt>
<dd>
Encodes the payload into base64 form and sets the
<span class="mailheader">Content-Transfer-Encoding:</span> header to
<code>base64</code>.  This is a good encoding to use when most of your payload
is unprintable data since it is a more compact form than
quoted-printable.  The drawback of base64 encoding is that it
renders the text non-human readable.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3933' xml:id='l2h-3933' class="function">encode_7or8bit</tt></b>(</nobr></td>
  <td><var>msg</var>)</td></tr></table></dt>
<dd>
This doesn't actually modify the message's payload, but it does set
the <span class="mailheader">Content-Transfer-Encoding:</span> header to either <code>7bit</code> or
<code>8bit</code> as appropriate, based on the payload data.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3934' xml:id='l2h-3934' class="function">encode_noop</tt></b>(</nobr></td>
  <td><var>msg</var>)</td></tr></table></dt>
<dd>
This does nothing; it doesn't even set the
<span class="mailheader">Content-Transfer-Encoding:</span> header.
</dl>

<P>
<BR><HR><H4>Footnotes</H4>
<DL>
<DT><A NAME="foot58057">...quoted-printable</A><A
 href="module-email.Encoders.html#tex2html119"><SUP>12.2</SUP></A></DT>
<DD>Note that encoding with
<tt class="method">encode_quopri()</tt> also encodes all tabs and space characters in
the data.

</DD>
</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.2.6 Representing character sets"
  href="module-email.Charset.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.2 email  "
  href="module-email.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.2.8 Exception and Defect"
  href="module-email.Errors.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-email.Charset.html">12.2.6 Representing character sets</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">12.2 email  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-email.Errors.html">12.2.8 Exception and Defect</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>