1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
<html xmlns="http://www.w3.org/1999/xhtml">
7
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
<title>18.1.1. email.message: Representing an email message — Python 2.7.10 documentation</title>
11
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
12
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
<script type="text/javascript">
15
var DOCUMENTATION_OPTIONS = {
18
COLLAPSE_INDEX: false,
23
<script type="text/javascript" src="../_static/jquery.js"></script>
24
<script type="text/javascript" src="../_static/underscore.js"></script>
25
<script type="text/javascript" src="../_static/doctools.js"></script>
26
<script type="text/javascript" src="../_static/sidebar.js"></script>
27
<link rel="search" type="application/opensearchdescription+xml"
28
title="Search within Python 2.7.10 documentation"
29
href="../_static/opensearch.xml"/>
30
<link rel="author" title="About these documents" href="../about.html" />
31
<link rel="copyright" title="Copyright" href="../copyright.html" />
32
<link rel="top" title="Python 2.7.10 documentation" href="../index.html" />
33
<link rel="up" title="18.1. email — An email and MIME handling package" href="email.html" />
34
<link rel="next" title="18.1.2. email.parser: Parsing email messages" href="email.parser.html" />
35
<link rel="prev" title="18.1. email — An email and MIME handling package" href="email.html" />
36
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
37
<script type="text/javascript" src="../_static/copybutton.js"></script>
38
<script type="text/javascript" src="../_static/version_switch.js"></script>
47
<li class="right" style="margin-right: 10px">
48
<a href="../genindex.html" title="General Index"
49
accesskey="I">index</a></li>
51
<a href="../py-modindex.html" title="Python Module Index"
54
<a href="email.parser.html" title="18.1.2. email.parser: Parsing email messages"
55
accesskey="N">next</a> |</li>
57
<a href="email.html" title="18.1. email — An email and MIME handling package"
58
accesskey="P">previous</a> |</li>
59
<li><img src="../_static/py.png" alt=""
60
style="vertical-align: middle; margin-top: -1px"/></li>
61
<li><a href="https://www.python.org/">Python</a> »</li>
63
<span class="version_switcher_placeholder">2.7.10</span>
64
<a href="../index.html">Documentation</a> »
67
<li><a href="index.html" >The Python Standard Library</a> »</li>
68
<li><a href="netdata.html" >18. Internet Data Handling</a> »</li>
69
<li><a href="email.html" accesskey="U">18.1. <tt class="docutils literal"><span class="pre">email</span></tt> — An email and MIME handling package</a> »</li>
73
<div class="document">
74
<div class="documentwrapper">
75
<div class="bodywrapper">
78
<div class="section" id="module-email.message">
79
<span id="email-message-representing-an-email-message"></span><h1>18.1.1. <a class="reference internal" href="#module-email.message" title="email.message: The base class representing email messages."><tt class="xref py py-mod docutils literal"><span class="pre">email.message</span></tt></a>: Representing an email message<a class="headerlink" href="#module-email.message" title="Permalink to this headline">¶</a></h1>
80
<p>The central class in the <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><tt class="xref py py-mod docutils literal"><span class="pre">email</span></tt></a> package is the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> class,
81
imported from the <a class="reference internal" href="#module-email.message" title="email.message: The base class representing email messages."><tt class="xref py py-mod docutils literal"><span class="pre">email.message</span></tt></a> module. It is the base class for the
82
<a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><tt class="xref py py-mod docutils literal"><span class="pre">email</span></tt></a> object model. <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> provides the core functionality for
83
setting and querying header fields, and for accessing message bodies.</p>
84
<p>Conceptually, a <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> object consists of <em>headers</em> and <em>payloads</em>.
85
Headers are <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> style field names and values where the field name and
86
value are separated by a colon. The colon is not part of either the field name
87
or the field value.</p>
88
<p>Headers are stored and returned in case-preserving form but are matched
89
case-insensitively. There may also be a single envelope header, also known as
90
the <em>Unix-From</em> header or the <tt class="docutils literal"><span class="pre">From_</span></tt> header. The payload is either a string
91
in the case of simple message objects or a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects for
92
MIME container documents (e.g. <em class="mimetype">multipart/*</em> and
93
<em class="mimetype">message/rfc822</em>).</p>
94
<p><a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects provide a mapping style interface for accessing the
95
message headers, and an explicit interface for accessing both the headers and
96
the payload. It provides convenience methods for generating a flat text
97
representation of the message object tree, for accessing commonly used header
98
parameters, and for recursively walking over the object tree.</p>
99
<p>Here are the methods of the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> class:</p>
101
<dt id="email.message.Message">
102
<em class="property">class </em><tt class="descclassname">email.message.</tt><tt class="descname">Message</tt><a class="headerlink" href="#email.message.Message" title="Permalink to this definition">¶</a></dt>
103
<dd><p>The constructor takes no arguments.</p>
105
<dt id="email.message.Message.as_string">
106
<tt class="descname">as_string</tt><big>(</big><span class="optional">[</span><em>unixfrom</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.as_string" title="Permalink to this definition">¶</a></dt>
107
<dd><p>Return the entire message flattened as a string. When optional <em>unixfrom</em>
108
is <tt class="docutils literal"><span class="pre">True</span></tt>, the envelope header is included in the returned string.
109
<em>unixfrom</em> defaults to <tt class="docutils literal"><span class="pre">False</span></tt>. Flattening the message may trigger
110
changes to the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> if defaults need to be filled in to
111
complete the transformation to a string (for example, MIME boundaries may
112
be generated or modified).</p>
113
<p>Note that this method is provided as a convenience and may not always
114
format the message the way you want. For example, by default it mangles
115
lines that begin with <tt class="docutils literal"><span class="pre">From</span></tt>. For more flexibility, instantiate a
116
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><tt class="xref py py-class docutils literal"><span class="pre">Generator</span></tt></a> instance and use its
117
<a class="reference internal" href="email.generator.html#email.generator.Generator.flatten" title="email.generator.Generator.flatten"><tt class="xref py py-meth docutils literal"><span class="pre">flatten()</span></tt></a> method directly. For example:</p>
118
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">cStringIO</span> <span class="kn">import</span> <span class="n">StringIO</span>
119
<span class="kn">from</span> <span class="nn">email.generator</span> <span class="kn">import</span> <span class="n">Generator</span>
120
<span class="n">fp</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
121
<span class="n">g</span> <span class="o">=</span> <span class="n">Generator</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">mangle_from_</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">maxheaderlen</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
122
<span class="n">g</span><span class="o">.</span><span class="n">flatten</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
123
<span class="n">text</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
129
<dt id="email.message.Message.__str__">
130
<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.__str__" title="Permalink to this definition">¶</a></dt>
131
<dd><p>Equivalent to <tt class="docutils literal"><span class="pre">as_string(unixfrom=True)</span></tt>.</p>
135
<dt id="email.message.Message.is_multipart">
136
<tt class="descname">is_multipart</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.is_multipart" title="Permalink to this definition">¶</a></dt>
137
<dd><p>Return <tt class="docutils literal"><span class="pre">True</span></tt> if the message’s payload is a list of sub-<a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects, otherwise return <tt class="docutils literal"><span class="pre">False</span></tt>. When
138
<a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><tt class="xref py py-meth docutils literal"><span class="pre">is_multipart()</span></tt></a> returns <tt class="docutils literal"><span class="pre">False</span></tt>, the payload should be a string object.</p>
142
<dt id="email.message.Message.set_unixfrom">
143
<tt class="descname">set_unixfrom</tt><big>(</big><em>unixfrom</em><big>)</big><a class="headerlink" href="#email.message.Message.set_unixfrom" title="Permalink to this definition">¶</a></dt>
144
<dd><p>Set the message’s envelope header to <em>unixfrom</em>, which should be a string.</p>
148
<dt id="email.message.Message.get_unixfrom">
149
<tt class="descname">get_unixfrom</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_unixfrom" title="Permalink to this definition">¶</a></dt>
150
<dd><p>Return the message’s envelope header. Defaults to <tt class="docutils literal"><span class="pre">None</span></tt> if the
151
envelope header was never set.</p>
155
<dt id="email.message.Message.attach">
156
<tt class="descname">attach</tt><big>(</big><em>payload</em><big>)</big><a class="headerlink" href="#email.message.Message.attach" title="Permalink to this definition">¶</a></dt>
157
<dd><p>Add the given <em>payload</em> to the current payload, which must be <tt class="docutils literal"><span class="pre">None</span></tt> or
158
a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects before the call. After the call, the
159
payload will always be a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects. If you want to
160
set the payload to a scalar object (e.g. a string), use
161
<a class="reference internal" href="#email.message.Message.set_payload" title="email.message.Message.set_payload"><tt class="xref py py-meth docutils literal"><span class="pre">set_payload()</span></tt></a> instead.</p>
165
<dt id="email.message.Message.get_payload">
166
<tt class="descname">get_payload</tt><big>(</big><span class="optional">[</span><em>i</em><span class="optional">[</span>, <em>decode</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_payload" title="Permalink to this definition">¶</a></dt>
167
<dd><p>Return the current payload, which will be a list of
168
<a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects when <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><tt class="xref py py-meth docutils literal"><span class="pre">is_multipart()</span></tt></a> is <tt class="docutils literal"><span class="pre">True</span></tt>, or a
169
string when <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><tt class="xref py py-meth docutils literal"><span class="pre">is_multipart()</span></tt></a> is <tt class="docutils literal"><span class="pre">False</span></tt>. If the payload is a list
170
and you mutate the list object, you modify the message’s payload in place.</p>
171
<p>With optional argument <em>i</em>, <a class="reference internal" href="#email.message.Message.get_payload" title="email.message.Message.get_payload"><tt class="xref py py-meth docutils literal"><span class="pre">get_payload()</span></tt></a> will return the <em>i</em>-th
172
element of the payload, counting from zero, if <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><tt class="xref py py-meth docutils literal"><span class="pre">is_multipart()</span></tt></a> is
173
<tt class="docutils literal"><span class="pre">True</span></tt>. An <a class="reference internal" href="exceptions.html#exceptions.IndexError" title="exceptions.IndexError"><tt class="xref py py-exc docutils literal"><span class="pre">IndexError</span></tt></a> will be raised if <em>i</em> is less than 0 or
174
greater than or equal to the number of items in the payload. If the
175
payload is a string (i.e. <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><tt class="xref py py-meth docutils literal"><span class="pre">is_multipart()</span></tt></a> is <tt class="docutils literal"><span class="pre">False</span></tt>) and <em>i</em> is
176
given, a <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> is raised.</p>
177
<p>Optional <em>decode</em> is a flag indicating whether the payload should be
178
decoded or not, according to the <em class="mailheader">Content-Transfer-Encoding</em>
179
header. When <tt class="docutils literal"><span class="pre">True</span></tt> and the message is not a multipart, the payload will
180
be decoded if this header’s value is <tt class="docutils literal"><span class="pre">quoted-printable</span></tt> or <tt class="docutils literal"><span class="pre">base64</span></tt>.
181
If some other encoding is used, or <em class="mailheader">Content-Transfer-Encoding</em>
182
header is missing, or if the payload has bogus base64 data, the payload is
183
returned as-is (undecoded). If the message is a multipart and the
184
<em>decode</em> flag is <tt class="docutils literal"><span class="pre">True</span></tt>, then <tt class="docutils literal"><span class="pre">None</span></tt> is returned. The default for
185
<em>decode</em> is <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
189
<dt id="email.message.Message.set_payload">
190
<tt class="descname">set_payload</tt><big>(</big><em>payload</em><span class="optional">[</span>, <em>charset</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.set_payload" title="Permalink to this definition">¶</a></dt>
191
<dd><p>Set the entire message object’s payload to <em>payload</em>. It is the client’s
192
responsibility to ensure the payload invariants. Optional <em>charset</em> sets
193
the message’s default character set; see <a class="reference internal" href="#email.message.Message.set_charset" title="email.message.Message.set_charset"><tt class="xref py py-meth docutils literal"><span class="pre">set_charset()</span></tt></a> for details.</p>
194
<div class="versionchanged">
195
<p><span class="versionmodified">Changed in version 2.2.2: </span><em>charset</em> argument added.</p>
200
<dt id="email.message.Message.set_charset">
201
<tt class="descname">set_charset</tt><big>(</big><em>charset</em><big>)</big><a class="headerlink" href="#email.message.Message.set_charset" title="Permalink to this definition">¶</a></dt>
202
<dd><p>Set the character set of the payload to <em>charset</em>, which can either be a
203
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><tt class="xref py py-class docutils literal"><span class="pre">Charset</span></tt></a> instance (see <a class="reference internal" href="email.charset.html#module-email.charset" title="email.charset: Character Sets"><tt class="xref py py-mod docutils literal"><span class="pre">email.charset</span></tt></a>), a
204
string naming a character set, or <tt class="docutils literal"><span class="pre">None</span></tt>. If it is a string, it will
205
be converted to a <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><tt class="xref py py-class docutils literal"><span class="pre">Charset</span></tt></a> instance. If <em>charset</em>
206
is <tt class="docutils literal"><span class="pre">None</span></tt>, the <tt class="docutils literal"><span class="pre">charset</span></tt> parameter will be removed from the
207
<em class="mailheader">Content-Type</em> header (the message will not be otherwise
208
modified). Anything else will generate a <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a>.</p>
209
<p>If there is no existing <em class="mailheader">MIME-Version</em> header one will be
210
added. If there is no existing <em class="mailheader">Content-Type</em> header, one
211
will be added with a value of <em class="mimetype">text/plain</em>. Whether the
212
<em class="mailheader">Content-Type</em> header already exists or not, its <tt class="docutils literal"><span class="pre">charset</span></tt>
213
parameter will be set to <em>charset.output_charset</em>. If
214
<em>charset.input_charset</em> and <em>charset.output_charset</em> differ, the payload
215
will be re-encoded to the <em>output_charset</em>. If there is no existing
216
<em class="mailheader">Content-Transfer-Encoding</em> header, then the payload will be
217
transfer-encoded, if needed, using the specified
218
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><tt class="xref py py-class docutils literal"><span class="pre">Charset</span></tt></a>, and a header with the appropriate value
219
will be added. If a <em class="mailheader">Content-Transfer-Encoding</em> header
220
already exists, the payload is assumed to already be correctly encoded
221
using that <em class="mailheader">Content-Transfer-Encoding</em> and is not modified.</p>
222
<p>The message will be assumed to be of type <em class="mimetype">text/*</em>, with the
223
payload either in unicode or encoded with <em>charset.input_charset</em>.
224
It will be encoded or converted to <em>charset.output_charset</em>
225
and transfer encoded properly, if needed, when generating the plain text
226
representation of the message. MIME headers (<em class="mailheader">MIME-Version</em>,
227
<em class="mailheader">Content-Type</em>, <em class="mailheader">Content-Transfer-Encoding</em>) will
228
be added as needed.</p>
229
<div class="versionadded">
230
<p><span class="versionmodified">New in version 2.2.2.</span></p>
235
<dt id="email.message.Message.get_charset">
236
<tt class="descname">get_charset</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_charset" title="Permalink to this definition">¶</a></dt>
237
<dd><p>Return the <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><tt class="xref py py-class docutils literal"><span class="pre">Charset</span></tt></a> instance associated with the
238
message’s payload.</p>
239
<div class="versionadded">
240
<p><span class="versionmodified">New in version 2.2.2.</span></p>
244
<p>The following methods implement a mapping-like interface for accessing the
245
message’s <span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> headers. Note that there are some semantic differences
246
between these methods and a normal mapping (i.e. dictionary) interface. For
247
example, in a dictionary there are no duplicate keys, but here there may be
248
duplicate message headers. Also, in dictionaries there is no guaranteed
249
order to the keys returned by <a class="reference internal" href="#email.message.Message.keys" title="email.message.Message.keys"><tt class="xref py py-meth docutils literal"><span class="pre">keys()</span></tt></a>, but in a <a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> object,
250
headers are always returned in the order they appeared in the original
251
message, or were added to the message later. Any header deleted and then
252
re-added are always appended to the end of the header list.</p>
253
<p>These semantic differences are intentional and are biased toward maximal
255
<p>Note that in all cases, any envelope header present in the message is not
256
included in the mapping interface.</p>
258
<dt id="email.message.Message.__len__">
259
<tt class="descname">__len__</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.__len__" title="Permalink to this definition">¶</a></dt>
260
<dd><p>Return the total number of headers, including duplicates.</p>
264
<dt id="email.message.Message.__contains__">
265
<tt class="descname">__contains__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#email.message.Message.__contains__" title="Permalink to this definition">¶</a></dt>
266
<dd><p>Return true if the message object has a field named <em>name</em>. Matching is
267
done case-insensitively and <em>name</em> should not include the trailing colon.
268
Used for the <tt class="docutils literal"><span class="pre">in</span></tt> operator, e.g.:</p>
269
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="s">'message-id'</span> <span class="ow">in</span> <span class="n">myMessage</span><span class="p">:</span>
270
<span class="k">print</span> <span class="s">'Message-ID:'</span><span class="p">,</span> <span class="n">myMessage</span><span class="p">[</span><span class="s">'message-id'</span><span class="p">]</span>
276
<dt id="email.message.Message.__getitem__">
277
<tt class="descname">__getitem__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#email.message.Message.__getitem__" title="Permalink to this definition">¶</a></dt>
278
<dd><p>Return the value of the named header field. <em>name</em> should not include the
279
colon field separator. If the header is missing, <tt class="docutils literal"><span class="pre">None</span></tt> is returned; a
280
<a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><tt class="xref py py-exc docutils literal"><span class="pre">KeyError</span></tt></a> is never raised.</p>
281
<p>Note that if the named field appears more than once in the message’s
282
headers, exactly which of those field values will be returned is
283
undefined. Use the <a class="reference internal" href="#email.message.Message.get_all" title="email.message.Message.get_all"><tt class="xref py py-meth docutils literal"><span class="pre">get_all()</span></tt></a> method to get the values of all the
284
extant named headers.</p>
288
<dt id="email.message.Message.__setitem__">
289
<tt class="descname">__setitem__</tt><big>(</big><em>name</em>, <em>val</em><big>)</big><a class="headerlink" href="#email.message.Message.__setitem__" title="Permalink to this definition">¶</a></dt>
290
<dd><p>Add a header to the message with field name <em>name</em> and value <em>val</em>. The
291
field is appended to the end of the message’s existing fields.</p>
292
<p>Note that this does <em>not</em> overwrite or delete any existing header with the same
293
name. If you want to ensure that the new header is the only one present in the
294
message with field name <em>name</em>, delete the field first, e.g.:</p>
295
<div class="highlight-python"><div class="highlight"><pre><span class="k">del</span> <span class="n">msg</span><span class="p">[</span><span class="s">'subject'</span><span class="p">]</span>
296
<span class="n">msg</span><span class="p">[</span><span class="s">'subject'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'Python roolz!'</span>
302
<dt id="email.message.Message.__delitem__">
303
<tt class="descname">__delitem__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#email.message.Message.__delitem__" title="Permalink to this definition">¶</a></dt>
304
<dd><p>Delete all occurrences of the field with name <em>name</em> from the message’s
305
headers. No exception is raised if the named field isn’t present in the headers.</p>
309
<dt id="email.message.Message.has_key">
310
<tt class="descname">has_key</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#email.message.Message.has_key" title="Permalink to this definition">¶</a></dt>
311
<dd><p>Return true if the message contains a header field named <em>name</em>, otherwise
316
<dt id="email.message.Message.keys">
317
<tt class="descname">keys</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.keys" title="Permalink to this definition">¶</a></dt>
318
<dd><p>Return a list of all the message’s header field names.</p>
322
<dt id="email.message.Message.values">
323
<tt class="descname">values</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.values" title="Permalink to this definition">¶</a></dt>
324
<dd><p>Return a list of all the message’s field values.</p>
328
<dt id="email.message.Message.items">
329
<tt class="descname">items</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.items" title="Permalink to this definition">¶</a></dt>
330
<dd><p>Return a list of 2-tuples containing all the message’s field headers and
335
<dt id="email.message.Message.get">
336
<tt class="descname">get</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get" title="Permalink to this definition">¶</a></dt>
337
<dd><p>Return the value of the named header field. This is identical to
338
<a class="reference internal" href="#email.message.Message.__getitem__" title="email.message.Message.__getitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__getitem__()</span></tt></a> except that optional <em>failobj</em> is returned if the
339
named header is missing (defaults to <tt class="docutils literal"><span class="pre">None</span></tt>).</p>
342
<p>Here are some additional useful methods:</p>
344
<dt id="email.message.Message.get_all">
345
<tt class="descname">get_all</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_all" title="Permalink to this definition">¶</a></dt>
346
<dd><p>Return a list of all the values for the field named <em>name</em>. If there are
347
no such named headers in the message, <em>failobj</em> is returned (defaults to
348
<tt class="docutils literal"><span class="pre">None</span></tt>).</p>
352
<dt id="email.message.Message.add_header">
353
<tt class="descname">add_header</tt><big>(</big><em>_name</em>, <em>_value</em>, <em>**_params</em><big>)</big><a class="headerlink" href="#email.message.Message.add_header" title="Permalink to this definition">¶</a></dt>
354
<dd><p>Extended header setting. This method is similar to <a class="reference internal" href="#email.message.Message.__setitem__" title="email.message.Message.__setitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__setitem__()</span></tt></a>
355
except that additional header parameters can be provided as keyword
356
arguments. <em>_name</em> is the header field to add and <em>_value</em> is the
357
<em>primary</em> value for the header.</p>
358
<p>For each item in the keyword argument dictionary <em>_params</em>, the key is
359
taken as the parameter name, with underscores converted to dashes (since
360
dashes are illegal in Python identifiers). Normally, the parameter will
361
be added as <tt class="docutils literal"><span class="pre">key="value"</span></tt> unless the value is <tt class="docutils literal"><span class="pre">None</span></tt>, in which case
362
only the key will be added. If the value contains non-ASCII characters,
363
it must be specified as a three tuple in the format
364
<tt class="docutils literal"><span class="pre">(CHARSET,</span> <span class="pre">LANGUAGE,</span> <span class="pre">VALUE)</span></tt>, where <tt class="docutils literal"><span class="pre">CHARSET</span></tt> is a string naming the
365
charset to be used to encode the value, <tt class="docutils literal"><span class="pre">LANGUAGE</span></tt> can usually be set
366
to <tt class="docutils literal"><span class="pre">None</span></tt> or the empty string (see <span class="target" id="index-2"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a> for other possibilities),
367
and <tt class="docutils literal"><span class="pre">VALUE</span></tt> is the string value containing non-ASCII code points.</p>
368
<p>Here’s an example:</p>
369
<div class="highlight-python"><div class="highlight"><pre><span class="n">msg</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s">'Content-Disposition'</span><span class="p">,</span> <span class="s">'attachment'</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s">'bud.gif'</span><span class="p">)</span>
372
<p>This will add a header that looks like</p>
373
<div class="highlight-python"><div class="highlight"><pre>Content-Disposition: attachment; filename="bud.gif"
376
<p>An example with non-ASCII characters:</p>
377
<div class="highlight-python"><div class="highlight"><pre><span class="n">msg</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s">'Content-Disposition'</span><span class="p">,</span> <span class="s">'attachment'</span><span class="p">,</span>
378
<span class="n">filename</span><span class="o">=</span><span class="p">(</span><span class="s">'iso-8859-1'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="s">'Fußballer.ppt'</span><span class="p">))</span>
381
<p>Which produces</p>
382
<div class="highlight-python"><div class="highlight"><pre>Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"
388
<dt id="email.message.Message.replace_header">
389
<tt class="descname">replace_header</tt><big>(</big><em>_name</em>, <em>_value</em><big>)</big><a class="headerlink" href="#email.message.Message.replace_header" title="Permalink to this definition">¶</a></dt>
390
<dd><p>Replace a header. Replace the first header found in the message that
391
matches <em>_name</em>, retaining header order and field name case. If no
392
matching header was found, a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><tt class="xref py py-exc docutils literal"><span class="pre">KeyError</span></tt></a> is raised.</p>
393
<div class="versionadded">
394
<p><span class="versionmodified">New in version 2.2.2.</span></p>
399
<dt id="email.message.Message.get_content_type">
400
<tt class="descname">get_content_type</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_content_type" title="Permalink to this definition">¶</a></dt>
401
<dd><p>Return the message’s content type. The returned string is coerced to
402
lower case of the form <em class="mimetype">maintype/subtype</em>. If there was no
403
<em class="mailheader">Content-Type</em> header in the message the default type as given
404
by <a class="reference internal" href="#email.message.Message.get_default_type" title="email.message.Message.get_default_type"><tt class="xref py py-meth docutils literal"><span class="pre">get_default_type()</span></tt></a> will be returned. Since according to
405
<span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2045.html"><strong>RFC 2045</strong></a>, messages always have a default type, <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><tt class="xref py py-meth docutils literal"><span class="pre">get_content_type()</span></tt></a>
406
will always return a value.</p>
407
<p><span class="target" id="index-4"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2045.html"><strong>RFC 2045</strong></a> defines a message’s default type to be <em class="mimetype">text/plain</em>
408
unless it appears inside a <em class="mimetype">multipart/digest</em> container, in
409
which case it would be <em class="mimetype">message/rfc822</em>. If the
410
<em class="mailheader">Content-Type</em> header has an invalid type specification,
411
<span class="target" id="index-5"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2045.html"><strong>RFC 2045</strong></a> mandates that the default type be <em class="mimetype">text/plain</em>.</p>
412
<div class="versionadded">
413
<p><span class="versionmodified">New in version 2.2.2.</span></p>
418
<dt id="email.message.Message.get_content_maintype">
419
<tt class="descname">get_content_maintype</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_content_maintype" title="Permalink to this definition">¶</a></dt>
420
<dd><p>Return the message’s main content type. This is the <em class="mimetype">maintype</em>
421
part of the string returned by <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><tt class="xref py py-meth docutils literal"><span class="pre">get_content_type()</span></tt></a>.</p>
422
<div class="versionadded">
423
<p><span class="versionmodified">New in version 2.2.2.</span></p>
428
<dt id="email.message.Message.get_content_subtype">
429
<tt class="descname">get_content_subtype</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_content_subtype" title="Permalink to this definition">¶</a></dt>
430
<dd><p>Return the message’s sub-content type. This is the <em class="mimetype">subtype</em>
431
part of the string returned by <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><tt class="xref py py-meth docutils literal"><span class="pre">get_content_type()</span></tt></a>.</p>
432
<div class="versionadded">
433
<p><span class="versionmodified">New in version 2.2.2.</span></p>
438
<dt id="email.message.Message.get_default_type">
439
<tt class="descname">get_default_type</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.get_default_type" title="Permalink to this definition">¶</a></dt>
440
<dd><p>Return the default content type. Most messages have a default content
441
type of <em class="mimetype">text/plain</em>, except for messages that are subparts of
442
<em class="mimetype">multipart/digest</em> containers. Such subparts have a default
443
content type of <em class="mimetype">message/rfc822</em>.</p>
444
<div class="versionadded">
445
<p><span class="versionmodified">New in version 2.2.2.</span></p>
450
<dt id="email.message.Message.set_default_type">
451
<tt class="descname">set_default_type</tt><big>(</big><em>ctype</em><big>)</big><a class="headerlink" href="#email.message.Message.set_default_type" title="Permalink to this definition">¶</a></dt>
452
<dd><p>Set the default content type. <em>ctype</em> should either be
453
<em class="mimetype">text/plain</em> or <em class="mimetype">message/rfc822</em>, although this is not
454
enforced. The default content type is not stored in the
455
<em class="mailheader">Content-Type</em> header.</p>
456
<div class="versionadded">
457
<p><span class="versionmodified">New in version 2.2.2.</span></p>
462
<dt id="email.message.Message.get_params">
463
<tt class="descname">get_params</tt><big>(</big><span class="optional">[</span><em>failobj</em><span class="optional">[</span>, <em>header</em><span class="optional">[</span>, <em>unquote</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_params" title="Permalink to this definition">¶</a></dt>
464
<dd><p>Return the message’s <em class="mailheader">Content-Type</em> parameters, as a list.
465
The elements of the returned list are 2-tuples of key/value pairs, as
466
split on the <tt class="docutils literal"><span class="pre">'='</span></tt> sign. The left hand side of the <tt class="docutils literal"><span class="pre">'='</span></tt> is the key,
467
while the right hand side is the value. If there is no <tt class="docutils literal"><span class="pre">'='</span></tt> sign in
468
the parameter the value is the empty string, otherwise the value is as
469
described in <a class="reference internal" href="#email.message.Message.get_param" title="email.message.Message.get_param"><tt class="xref py py-meth docutils literal"><span class="pre">get_param()</span></tt></a> and is unquoted if optional <em>unquote</em> is
470
<tt class="docutils literal"><span class="pre">True</span></tt> (the default).</p>
471
<p>Optional <em>failobj</em> is the object to return if there is no
472
<em class="mailheader">Content-Type</em> header. Optional <em>header</em> is the header to
473
search instead of <em class="mailheader">Content-Type</em>.</p>
474
<div class="versionchanged">
475
<p><span class="versionmodified">Changed in version 2.2.2: </span><em>unquote</em> argument added.</p>
480
<dt id="email.message.Message.get_param">
481
<tt class="descname">get_param</tt><big>(</big><em>param</em><span class="optional">[</span>, <em>failobj</em><span class="optional">[</span>, <em>header</em><span class="optional">[</span>, <em>unquote</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_param" title="Permalink to this definition">¶</a></dt>
482
<dd><p>Return the value of the <em class="mailheader">Content-Type</em> header’s parameter
483
<em>param</em> as a string. If the message has no <em class="mailheader">Content-Type</em>
484
header or if there is no such parameter, then <em>failobj</em> is returned
485
(defaults to <tt class="docutils literal"><span class="pre">None</span></tt>).</p>
486
<p>Optional <em>header</em> if given, specifies the message header to use instead of
487
<em class="mailheader">Content-Type</em>.</p>
488
<p>Parameter keys are always compared case insensitively. The return value
489
can either be a string, or a 3-tuple if the parameter was <span class="target" id="index-6"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>
490
encoded. When it’s a 3-tuple, the elements of the value are of the form
491
<tt class="docutils literal"><span class="pre">(CHARSET,</span> <span class="pre">LANGUAGE,</span> <span class="pre">VALUE)</span></tt>. Note that both <tt class="docutils literal"><span class="pre">CHARSET</span></tt> and
492
<tt class="docutils literal"><span class="pre">LANGUAGE</span></tt> can be <tt class="docutils literal"><span class="pre">None</span></tt>, in which case you should consider <tt class="docutils literal"><span class="pre">VALUE</span></tt>
493
to be encoded in the <tt class="docutils literal"><span class="pre">us-ascii</span></tt> charset. You can usually ignore
494
<tt class="docutils literal"><span class="pre">LANGUAGE</span></tt>.</p>
495
<p>If your application doesn’t care whether the parameter was encoded as in
496
<span class="target" id="index-7"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>, you can collapse the parameter value by calling
497
<a class="reference internal" href="email.util.html#email.utils.collapse_rfc2231_value" title="email.utils.collapse_rfc2231_value"><tt class="xref py py-func docutils literal"><span class="pre">email.utils.collapse_rfc2231_value()</span></tt></a>, passing in the return value
498
from <a class="reference internal" href="#email.message.Message.get_param" title="email.message.Message.get_param"><tt class="xref py py-meth docutils literal"><span class="pre">get_param()</span></tt></a>. This will return a suitably decoded Unicode
499
string when the value is a tuple, or the original string unquoted if it
500
isn’t. For example:</p>
501
<div class="highlight-python"><div class="highlight"><pre><span class="n">rawparam</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_param</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span>
502
<span class="n">param</span> <span class="o">=</span> <span class="n">email</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">collapse_rfc2231_value</span><span class="p">(</span><span class="n">rawparam</span><span class="p">)</span>
505
<p>In any case, the parameter value (either the returned string, or the
506
<tt class="docutils literal"><span class="pre">VALUE</span></tt> item in the 3-tuple) is always unquoted, unless <em>unquote</em> is set
507
to <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
508
<div class="versionchanged">
509
<p><span class="versionmodified">Changed in version 2.2.2: </span><em>unquote</em> argument added, and 3-tuple return value possible.</p>
514
<dt id="email.message.Message.set_param">
515
<tt class="descname">set_param</tt><big>(</big><em>param</em>, <em>value</em><span class="optional">[</span>, <em>header</em><span class="optional">[</span>, <em>requote</em><span class="optional">[</span>, <em>charset</em><span class="optional">[</span>, <em>language</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.set_param" title="Permalink to this definition">¶</a></dt>
516
<dd><p>Set a parameter in the <em class="mailheader">Content-Type</em> header. If the
517
parameter already exists in the header, its value will be replaced with
518
<em>value</em>. If the <em class="mailheader">Content-Type</em> header as not yet been defined
519
for this message, it will be set to <em class="mimetype">text/plain</em> and the new
520
parameter value will be appended as per <span class="target" id="index-8"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2045.html"><strong>RFC 2045</strong></a>.</p>
521
<p>Optional <em>header</em> specifies an alternative header to
522
<em class="mailheader">Content-Type</em>, and all parameters will be quoted as necessary
523
unless optional <em>requote</em> is <tt class="docutils literal"><span class="pre">False</span></tt> (the default is <tt class="docutils literal"><span class="pre">True</span></tt>).</p>
524
<p>If optional <em>charset</em> is specified, the parameter will be encoded
525
according to <span class="target" id="index-9"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>. Optional <em>language</em> specifies the RFC 2231
526
language, defaulting to the empty string. Both <em>charset</em> and <em>language</em>
527
should be strings.</p>
528
<div class="versionadded">
529
<p><span class="versionmodified">New in version 2.2.2.</span></p>
534
<dt id="email.message.Message.del_param">
535
<tt class="descname">del_param</tt><big>(</big><em>param</em><span class="optional">[</span>, <em>header</em><span class="optional">[</span>, <em>requote</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.del_param" title="Permalink to this definition">¶</a></dt>
536
<dd><p>Remove the given parameter completely from the <em class="mailheader">Content-Type</em>
537
header. The header will be re-written in place without the parameter or
538
its value. All values will be quoted as necessary unless <em>requote</em> is
539
<tt class="docutils literal"><span class="pre">False</span></tt> (the default is <tt class="docutils literal"><span class="pre">True</span></tt>). Optional <em>header</em> specifies an
540
alternative to <em class="mailheader">Content-Type</em>.</p>
541
<div class="versionadded">
542
<p><span class="versionmodified">New in version 2.2.2.</span></p>
547
<dt id="email.message.Message.set_type">
548
<tt class="descname">set_type</tt><big>(</big><em>type[, header][, requote]</em><big>)</big><a class="headerlink" href="#email.message.Message.set_type" title="Permalink to this definition">¶</a></dt>
549
<dd><p>Set the main type and subtype for the <em class="mailheader">Content-Type</em>
550
header. <em>type</em> must be a string in the form <em class="mimetype">maintype/subtype</em>,
551
otherwise a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> is raised.</p>
552
<p>This method replaces the <em class="mailheader">Content-Type</em> header, keeping all
553
the parameters in place. If <em>requote</em> is <tt class="docutils literal"><span class="pre">False</span></tt>, this leaves the
554
existing header’s quoting as is, otherwise the parameters will be quoted
556
<p>An alternative header can be specified in the <em>header</em> argument. When the
557
<em class="mailheader">Content-Type</em> header is set a <em class="mailheader">MIME-Version</em>
558
header is also added.</p>
559
<div class="versionadded">
560
<p><span class="versionmodified">New in version 2.2.2.</span></p>
565
<dt id="email.message.Message.get_filename">
566
<tt class="descname">get_filename</tt><big>(</big><span class="optional">[</span><em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_filename" title="Permalink to this definition">¶</a></dt>
567
<dd><p>Return the value of the <tt class="docutils literal"><span class="pre">filename</span></tt> parameter of the
568
<em class="mailheader">Content-Disposition</em> header of the message. If the header
569
does not have a <tt class="docutils literal"><span class="pre">filename</span></tt> parameter, this method falls back to looking
570
for the <tt class="docutils literal"><span class="pre">name</span></tt> parameter on the <em class="mailheader">Content-Type</em> header. If
571
neither is found, or the header is missing, then <em>failobj</em> is returned.
572
The returned string will always be unquoted as per
573
<a class="reference internal" href="email.util.html#email.utils.unquote" title="email.utils.unquote"><tt class="xref py py-func docutils literal"><span class="pre">email.utils.unquote()</span></tt></a>.</p>
577
<dt id="email.message.Message.get_boundary">
578
<tt class="descname">get_boundary</tt><big>(</big><span class="optional">[</span><em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_boundary" title="Permalink to this definition">¶</a></dt>
579
<dd><p>Return the value of the <tt class="docutils literal"><span class="pre">boundary</span></tt> parameter of the
580
<em class="mailheader">Content-Type</em> header of the message, or <em>failobj</em> if either
581
the header is missing, or has no <tt class="docutils literal"><span class="pre">boundary</span></tt> parameter. The returned
582
string will always be unquoted as per <a class="reference internal" href="email.util.html#email.utils.unquote" title="email.utils.unquote"><tt class="xref py py-func docutils literal"><span class="pre">email.utils.unquote()</span></tt></a>.</p>
586
<dt id="email.message.Message.set_boundary">
587
<tt class="descname">set_boundary</tt><big>(</big><em>boundary</em><big>)</big><a class="headerlink" href="#email.message.Message.set_boundary" title="Permalink to this definition">¶</a></dt>
588
<dd><p>Set the <tt class="docutils literal"><span class="pre">boundary</span></tt> parameter of the <em class="mailheader">Content-Type</em> header to
589
<em>boundary</em>. <a class="reference internal" href="#email.message.Message.set_boundary" title="email.message.Message.set_boundary"><tt class="xref py py-meth docutils literal"><span class="pre">set_boundary()</span></tt></a> will always quote <em>boundary</em> if
590
necessary. A <a class="reference internal" href="email.errors.html#email.errors.HeaderParseError" title="email.errors.HeaderParseError"><tt class="xref py py-exc docutils literal"><span class="pre">HeaderParseError</span></tt></a> is raised if the
591
message object has no <em class="mailheader">Content-Type</em> header.</p>
592
<p>Note that using this method is subtly different than deleting the old
593
<em class="mailheader">Content-Type</em> header and adding a new one with the new
594
boundary via <a class="reference internal" href="#email.message.Message.add_header" title="email.message.Message.add_header"><tt class="xref py py-meth docutils literal"><span class="pre">add_header()</span></tt></a>, because <a class="reference internal" href="#email.message.Message.set_boundary" title="email.message.Message.set_boundary"><tt class="xref py py-meth docutils literal"><span class="pre">set_boundary()</span></tt></a> preserves
595
the order of the <em class="mailheader">Content-Type</em> header in the list of
596
headers. However, it does <em>not</em> preserve any continuation lines which may
597
have been present in the original <em class="mailheader">Content-Type</em> header.</p>
601
<dt id="email.message.Message.get_content_charset">
602
<tt class="descname">get_content_charset</tt><big>(</big><span class="optional">[</span><em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_content_charset" title="Permalink to this definition">¶</a></dt>
603
<dd><p>Return the <tt class="docutils literal"><span class="pre">charset</span></tt> parameter of the <em class="mailheader">Content-Type</em> header,
604
coerced to lower case. If there is no <em class="mailheader">Content-Type</em> header, or if
605
that header has no <tt class="docutils literal"><span class="pre">charset</span></tt> parameter, <em>failobj</em> is returned.</p>
606
<p>Note that this method differs from <a class="reference internal" href="#email.message.Message.get_charset" title="email.message.Message.get_charset"><tt class="xref py py-meth docutils literal"><span class="pre">get_charset()</span></tt></a> which returns the
607
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><tt class="xref py py-class docutils literal"><span class="pre">Charset</span></tt></a> instance for the default encoding of the message body.</p>
608
<div class="versionadded">
609
<p><span class="versionmodified">New in version 2.2.2.</span></p>
614
<dt id="email.message.Message.get_charsets">
615
<tt class="descname">get_charsets</tt><big>(</big><span class="optional">[</span><em>failobj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.message.Message.get_charsets" title="Permalink to this definition">¶</a></dt>
616
<dd><p>Return a list containing the character set names in the message. If the
617
message is a <em class="mimetype">multipart</em>, then the list will contain one element
618
for each subpart in the payload, otherwise, it will be a list of length 1.</p>
619
<p>Each item in the list will be a string which is the value of the
620
<tt class="docutils literal"><span class="pre">charset</span></tt> parameter in the <em class="mailheader">Content-Type</em> header for the
621
represented subpart. However, if the subpart has no
622
<em class="mailheader">Content-Type</em> header, no <tt class="docutils literal"><span class="pre">charset</span></tt> parameter, or is not of
623
the <em class="mimetype">text</em> main MIME type, then that item in the returned list
624
will be <em>failobj</em>.</p>
628
<dt id="email.message.Message.walk">
629
<tt class="descname">walk</tt><big>(</big><big>)</big><a class="headerlink" href="#email.message.Message.walk" title="Permalink to this definition">¶</a></dt>
630
<dd><p>The <a class="reference internal" href="#email.message.Message.walk" title="email.message.Message.walk"><tt class="xref py py-meth docutils literal"><span class="pre">walk()</span></tt></a> method is an all-purpose generator which can be used to
631
iterate over all the parts and subparts of a message object tree, in
632
depth-first traversal order. You will typically use <a class="reference internal" href="#email.message.Message.walk" title="email.message.Message.walk"><tt class="xref py py-meth docutils literal"><span class="pre">walk()</span></tt></a> as the
633
iterator in a <tt class="docutils literal"><span class="pre">for</span></tt> loop; each iteration returns the next subpart.</p>
634
<p>Here’s an example that prints the MIME type of every part of a multipart
635
message structure:</p>
636
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">msg</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span>
637
<span class="gp">... </span> <span class="k">print</span> <span class="n">part</span><span class="o">.</span><span class="n">get_content_type</span><span class="p">()</span>
638
<span class="go">multipart/report</span>
639
<span class="go">text/plain</span>
640
<span class="go">message/delivery-status</span>
641
<span class="go">text/plain</span>
642
<span class="go">text/plain</span>
643
<span class="go">message/rfc822</span>
648
<div class="versionchanged">
649
<p><span class="versionmodified">Changed in version 2.5: </span>The previously deprecated methods <tt class="xref py py-meth docutils literal"><span class="pre">get_type()</span></tt>, <tt class="xref py py-meth docutils literal"><span class="pre">get_main_type()</span></tt>, and
650
<tt class="xref py py-meth docutils literal"><span class="pre">get_subtype()</span></tt> were removed.</p>
652
<p><a class="reference internal" href="#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> objects can also optionally contain two instance attributes,
653
which can be used when generating the plain text of a MIME message.</p>
654
<dl class="attribute">
655
<dt id="email.message.Message.preamble">
656
<tt class="descname">preamble</tt><a class="headerlink" href="#email.message.Message.preamble" title="Permalink to this definition">¶</a></dt>
657
<dd><p>The format of a MIME document allows for some text between the blank line
658
following the headers, and the first multipart boundary string. Normally,
659
this text is never visible in a MIME-aware mail reader because it falls
660
outside the standard MIME armor. However, when viewing the raw text of
661
the message, or when viewing the message in a non-MIME aware reader, this
662
text can become visible.</p>
663
<p>The <em>preamble</em> attribute contains this leading extra-armor text for MIME
664
documents. When the <a class="reference internal" href="email.parser.html#email.parser.Parser" title="email.parser.Parser"><tt class="xref py py-class docutils literal"><span class="pre">Parser</span></tt></a> discovers some text
665
after the headers but before the first boundary string, it assigns this
666
text to the message’s <em>preamble</em> attribute. When the
667
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><tt class="xref py py-class docutils literal"><span class="pre">Generator</span></tt></a> is writing out the plain text
668
representation of a MIME message, and it finds the
669
message has a <em>preamble</em> attribute, it will write this text in the area
670
between the headers and the first boundary. See <a class="reference internal" href="email.parser.html#module-email.parser" title="email.parser: Parse flat text email messages to produce a message object structure."><tt class="xref py py-mod docutils literal"><span class="pre">email.parser</span></tt></a> and
671
<a class="reference internal" href="email.generator.html#module-email.generator" title="email.generator: Generate flat text email messages from a message structure."><tt class="xref py py-mod docutils literal"><span class="pre">email.generator</span></tt></a> for details.</p>
672
<p>Note that if the message object has no preamble, the <em>preamble</em> attribute
673
will be <tt class="docutils literal"><span class="pre">None</span></tt>.</p>
676
<dl class="attribute">
677
<dt id="email.message.Message.epilogue">
678
<tt class="descname">epilogue</tt><a class="headerlink" href="#email.message.Message.epilogue" title="Permalink to this definition">¶</a></dt>
679
<dd><p>The <em>epilogue</em> attribute acts the same way as the <em>preamble</em> attribute,
680
except that it contains text that appears between the last boundary and
681
the end of the message.</p>
682
<div class="versionchanged">
683
<p><span class="versionmodified">Changed in version 2.5: </span>You do not need to set the epilogue to the empty string in order for the
684
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><tt class="xref py py-class docutils literal"><span class="pre">Generator</span></tt></a> to print a newline at the end of the
689
<dl class="attribute">
690
<dt id="email.message.Message.defects">
691
<tt class="descname">defects</tt><a class="headerlink" href="#email.message.Message.defects" title="Permalink to this definition">¶</a></dt>
692
<dd><p>The <em>defects</em> attribute contains a list of all the problems found when
693
parsing this message. See <a class="reference internal" href="email.errors.html#module-email.errors" title="email.errors: The exception classes used by the email package."><tt class="xref py py-mod docutils literal"><span class="pre">email.errors</span></tt></a> for a detailed description
694
of the possible parsing defects.</p>
695
<div class="versionadded">
696
<p><span class="versionmodified">New in version 2.4.</span></p>
708
<div class="sphinxsidebar">
709
<div class="sphinxsidebarwrapper">
710
<h4>Previous topic</h4>
711
<p class="topless"><a href="email.html"
712
title="previous chapter">18.1. <tt class="docutils literal"><span class="pre">email</span></tt> — An email and MIME handling package</a></p>
714
<p class="topless"><a href="email.parser.html"
715
title="next chapter">18.1.2. <tt class="docutils literal"><span class="pre">email.parser</span></tt>: Parsing email messages</a></p>
717
<ul class="this-page-menu">
718
<li><a href="../bugs.html">Report a Bug</a></li>
719
<li><a href="../_sources/library/email.message.txt"
720
rel="nofollow">Show Source</a></li>
723
<div id="searchbox" style="display: none">
724
<h3>Quick search</h3>
725
<form class="search" action="../search.html" method="get">
726
<input type="text" name="q" />
727
<input type="submit" value="Go" />
728
<input type="hidden" name="check_keywords" value="yes" />
729
<input type="hidden" name="area" value="default" />
731
<p class="searchtip" style="font-size: 90%">
732
Enter search terms or a module, class or function name.
735
<script type="text/javascript">$('#searchbox').show(0);</script>
738
<div class="clearer"></div>
740
<div class="related">
743
<li class="right" style="margin-right: 10px">
744
<a href="../genindex.html" title="General Index"
747
<a href="../py-modindex.html" title="Python Module Index"
750
<a href="email.parser.html" title="18.1.2. email.parser: Parsing email messages"
753
<a href="email.html" title="18.1. email — An email and MIME handling package"
755
<li><img src="../_static/py.png" alt=""
756
style="vertical-align: middle; margin-top: -1px"/></li>
757
<li><a href="https://www.python.org/">Python</a> »</li>
759
<span class="version_switcher_placeholder">2.7.10</span>
760
<a href="../index.html">Documentation</a> »
763
<li><a href="index.html" >The Python Standard Library</a> »</li>
764
<li><a href="netdata.html" >18. Internet Data Handling</a> »</li>
765
<li><a href="email.html" >18.1. <tt class="docutils literal"><span class="pre">email</span></tt> — An email and MIME handling package</a> »</li>
769
© <a href="../copyright.html">Copyright</a> 1990-2015, Python Software Foundation.
771
The Python Software Foundation is a non-profit corporation.
772
<a href="https://www.python.org/psf/donations/">Please donate.</a>
774
Last updated on May 23, 2015.
775
<a href="../bugs.html">Found a bug</a>?
777
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.
b'\\ No newline at end of file'
added
removed
python-2.7.10-docs-html/library/email.message.html
