Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / mimetools.Message-class.html
blob: 2859d17fb7875f393ec24147ab9e2d99ba9f6dde [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame^]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>mimetools.Message</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 mimetools ::
38 Message ::
39 Class&nbsp;Message
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="mimetools.Message-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class Message</h1><p class="nomargin-top"></p>
57<center>
58<center> <map id="uml_class_diagram_for_mimetool" name="uml_class_diagram_for_mimetool">
59<area shape="rect" href="mimetools.Message-class.html#__init__" title="Initialize the class instance and read the headers." alt="" coords="33,372,207,391"/>
60<area shape="rect" href="mimetools.Message-class.html#getencoding" title="mimetools.Message.getencoding" alt="" coords="33,391,207,409"/>
61<area shape="rect" href="mimetools.Message-class.html#getmaintype" title="mimetools.Message.getmaintype" alt="" coords="33,409,207,428"/>
62<area shape="rect" href="mimetools.Message-class.html#getparam" title="mimetools.Message.getparam" alt="" coords="33,428,207,447"/>
63<area shape="rect" href="mimetools.Message-class.html#getparamnames" title="mimetools.Message.getparamnames" alt="" coords="33,447,207,465"/>
64<area shape="rect" href="mimetools.Message-class.html#getplist" title="mimetools.Message.getplist" alt="" coords="33,465,207,484"/>
65<area shape="rect" href="mimetools.Message-class.html#getsubtype" title="mimetools.Message.getsubtype" alt="" coords="33,484,207,503"/>
66<area shape="rect" href="mimetools.Message-class.html#gettype" title="mimetools.Message.gettype" alt="" coords="33,503,207,521"/>
67<area shape="rect" href="mimetools.Message-class.html#parseplist" title="mimetools.Message.parseplist" alt="" coords="33,521,207,540"/>
68<area shape="rect" href="mimetools.Message-class.html#parsetype" title="mimetools.Message.parsetype" alt="" coords="33,540,207,559"/>
69<area shape="rect" href="mimetools.Message-class.html" title="A derived class of rfc822.Message that knows about MIME headers and contains some hooks for decoding encoded and multipart messages." alt="" coords="32,347,208,560"/>
70<area shape="rect" href="javascript:void(0);" title="Determine whether a message contains the named header." alt="" coords="17,36,223,55"/>
71<area shape="rect" href="javascript:void(0);" title="Delete all occurrences of a specific header, if it is present." alt="" coords="17,55,223,73"/>
72<area shape="rect" href="javascript:void(0);" title="Get a specific header, as from a dictionary." alt="" coords="17,73,223,92"/>
73<area shape="rect" href="javascript:void(0);" title="rfc822.Message.__iter__" alt="" coords="17,92,223,111"/>
74<area shape="rect" href="javascript:void(0);" title="Get the number of headers in a message." alt="" coords="17,111,223,129"/>
75<area shape="rect" href="javascript:void(0);" title="Set the value of a header." alt="" coords="17,129,223,148"/>
76<area shape="rect" href="javascript:void(0);" title="rfc822.Message.__str__" alt="" coords="17,148,223,167"/>
77<area shape="rect" href="javascript:void(0);" title="Get the header value for a name." alt="" coords="17,167,223,185"/>
78<area shape="rect" href="javascript:void(0);" title="Get a single address from a header, as a tuple." alt="" coords="17,185,223,204"/>
79<area shape="rect" href="javascript:void(0);" title="Get a list of addresses from a header." alt="" coords="17,204,223,223"/>
80<area shape="rect" href="javascript:void(0);" title="Find all header lines matching a given header name." alt="" coords="17,223,223,241"/>
81<area shape="rect" href="javascript:void(0);" title="Retrieve a date field from a header." alt="" coords="17,241,223,260"/>
82<area shape="rect" href="javascript:void(0);" title="Retrieve a date field from a header as a 10&#45;tuple." alt="" coords="17,260,223,279"/>
83<area shape="rect" href="javascript:void(0);" title="Get all of a message&#39;s header field values." alt="" coords="17,297,223,316"/>
84<area shape="rect" href="javascript:void(0);" title="Represents a single RFC 2822&#45;compliant message." alt="" coords="16,11,224,317"/>
85</map>
86 <img src="uml_class_diagram_for_mimetool.gif" alt='' usemap="#uml_class_diagram_for_mimetool" ismap="ismap" class="graph-without-title" />
87</center>
88</center>
89<hr />
90<pre class="literalblock">
91A derived class of rfc822.Message that knows about MIME headers and
92contains some hooks for decoding encoded and multipart messages.
93
94</pre>
95
96<!-- ==================== INSTANCE METHODS ==================== -->
97<a name="section-InstanceMethods"></a>
98<table class="summary" border="1" cellpadding="3"
99 cellspacing="0" width="100%" bgcolor="white">
100<tr bgcolor="#70b0f0" class="table-header">
101 <td colspan="2" class="table-header">
102 <table border="0" cellpadding="0" cellspacing="0" width="100%">
103 <tr valign="top">
104 <td align="left"><span class="table-header">Instance Methods</span></td>
105 <td align="right" valign="top"
106 ><span class="options">[<a href="#section-InstanceMethods"
107 class="privatelink" onclick="toggle_private();"
108 >hide private</a>]</span></td>
109 </tr>
110 </table>
111 </td>
112</tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td><span class="summary-sig"><a href="mimetools.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
120 <span class="summary-sig-arg">fp</span>,
121 <span class="summary-sig-arg">seekable</span>=<span class="summary-sig-default">1</span>)</span><br />
122 Initialize the class instance and read the headers.</td>
123 <td align="right" valign="top">
124
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a name="getencoding"></a><span class="summary-sig-name">getencoding</span>(<span class="summary-sig-arg">self</span>)</span></td>
139 <td align="right" valign="top">
140
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <td><span class="summary-sig"><a name="getmaintype"></a><span class="summary-sig-name">getmaintype</span>(<span class="summary-sig-arg">self</span>)</span></td>
155 <td align="right" valign="top">
156
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164<tr>
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type">&nbsp;</span>
167 </td><td class="summary">
168 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <tr>
170 <td><span class="summary-sig"><a name="getparam"></a><span class="summary-sig-name">getparam</span>(<span class="summary-sig-arg">self</span>,
171 <span class="summary-sig-arg">name</span>)</span></td>
172 <td align="right" valign="top">
173
174
175 </td>
176 </tr>
177 </table>
178
179 </td>
180 </tr>
181<tr>
182 <td width="15%" align="right" valign="top" class="summary">
183 <span class="summary-type">&nbsp;</span>
184 </td><td class="summary">
185 <table width="100%" cellpadding="0" cellspacing="0" border="0">
186 <tr>
187 <td><span class="summary-sig"><a name="getparamnames"></a><span class="summary-sig-name">getparamnames</span>(<span class="summary-sig-arg">self</span>)</span></td>
188 <td align="right" valign="top">
189
190
191 </td>
192 </tr>
193 </table>
194
195 </td>
196 </tr>
197<tr>
198 <td width="15%" align="right" valign="top" class="summary">
199 <span class="summary-type">&nbsp;</span>
200 </td><td class="summary">
201 <table width="100%" cellpadding="0" cellspacing="0" border="0">
202 <tr>
203 <td><span class="summary-sig"><a name="getplist"></a><span class="summary-sig-name">getplist</span>(<span class="summary-sig-arg">self</span>)</span></td>
204 <td align="right" valign="top">
205
206
207 </td>
208 </tr>
209 </table>
210
211 </td>
212 </tr>
213<tr>
214 <td width="15%" align="right" valign="top" class="summary">
215 <span class="summary-type">&nbsp;</span>
216 </td><td class="summary">
217 <table width="100%" cellpadding="0" cellspacing="0" border="0">
218 <tr>
219 <td><span class="summary-sig"><a name="getsubtype"></a><span class="summary-sig-name">getsubtype</span>(<span class="summary-sig-arg">self</span>)</span></td>
220 <td align="right" valign="top">
221
222
223 </td>
224 </tr>
225 </table>
226
227 </td>
228 </tr>
229<tr>
230 <td width="15%" align="right" valign="top" class="summary">
231 <span class="summary-type">&nbsp;</span>
232 </td><td class="summary">
233 <table width="100%" cellpadding="0" cellspacing="0" border="0">
234 <tr>
235 <td><span class="summary-sig"><a name="gettype"></a><span class="summary-sig-name">gettype</span>(<span class="summary-sig-arg">self</span>)</span></td>
236 <td align="right" valign="top">
237
238
239 </td>
240 </tr>
241 </table>
242
243 </td>
244 </tr>
245<tr>
246 <td width="15%" align="right" valign="top" class="summary">
247 <span class="summary-type">&nbsp;</span>
248 </td><td class="summary">
249 <table width="100%" cellpadding="0" cellspacing="0" border="0">
250 <tr>
251 <td><span class="summary-sig"><a name="parseplist"></a><span class="summary-sig-name">parseplist</span>(<span class="summary-sig-arg">self</span>)</span></td>
252 <td align="right" valign="top">
253
254
255 </td>
256 </tr>
257 </table>
258
259 </td>
260 </tr>
261<tr>
262 <td width="15%" align="right" valign="top" class="summary">
263 <span class="summary-type">&nbsp;</span>
264 </td><td class="summary">
265 <table width="100%" cellpadding="0" cellspacing="0" border="0">
266 <tr>
267 <td><span class="summary-sig"><a name="parsetype"></a><span class="summary-sig-name">parsetype</span>(<span class="summary-sig-arg">self</span>)</span></td>
268 <td align="right" valign="top">
269
270
271 </td>
272 </tr>
273 </table>
274
275 </td>
276 </tr>
277 <tr>
278 <td colspan="2" class="summary">
279 <p class="indent-wrapped-lines"><b>Inherited from <code>rfc822.Message</code></b>:
280 <code>__contains__</code>,
281 <code>__delitem__</code>,
282 <code>__getitem__</code>,
283 <code>__iter__</code>,
284 <code>__len__</code>,
285 <code>__setitem__</code>,
286 <code>__str__</code>,
287 <code>get</code>,
288 <code>getaddr</code>,
289 <code>getaddrlist</code>,
290 <code>getallmatchingheaders</code>,
291 <code>getdate</code>,
292 <code>getdate_tz</code>,
293 <code>getfirstmatchingheader</code>,
294 <code>getheader</code>,
295 <code>getheaders</code>,
296 <code>getrawheader</code>,
297 <code>has_key</code>,
298 <code>iscomment</code>,
299 <code>isheader</code>,
300 <code>islast</code>,
301 <code>items</code>,
302 <code>keys</code>,
303 <code>readheaders</code>,
304 <code>rewindbody</code>,
305 <code>setdefault</code>,
306 <code>values</code>
307 </p>
308 </td>
309 </tr>
310</table>
311<!-- ==================== METHOD DETAILS ==================== -->
312<a name="section-MethodDetails"></a>
313<table class="details" border="1" cellpadding="3"
314 cellspacing="0" width="100%" bgcolor="white">
315<tr bgcolor="#70b0f0" class="table-header">
316 <td colspan="2" class="table-header">
317 <table border="0" cellpadding="0" cellspacing="0" width="100%">
318 <tr valign="top">
319 <td align="left"><span class="table-header">Method Details</span></td>
320 <td align="right" valign="top"
321 ><span class="options">[<a href="#section-MethodDetails"
322 class="privatelink" onclick="toggle_private();"
323 >hide private</a>]</span></td>
324 </tr>
325 </table>
326 </td>
327</tr>
328</table>
329<a name="__init__"></a>
330<div>
331<table class="details" border="1" cellpadding="3"
332 cellspacing="0" width="100%" bgcolor="white">
333<tr><td>
334 <table width="100%" cellpadding="0" cellspacing="0" border="0">
335 <tr valign="top"><td>
336 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
337 <span class="sig-arg">fp</span>,
338 <span class="sig-arg">seekable</span>=<span class="sig-default">1</span>)</span>
339 <br /><em class="fname">(Constructor)</em>
340 </h3>
341 </td><td align="right" valign="top"
342 >&nbsp;
343 </td>
344 </tr></table>
345
346 <pre class="literalblock">
347Initialize the class instance and read the headers.
348
349</pre>
350 <dl class="fields">
351 <dt>Overrides:
352 rfc822.Message.__init__
353 <dd><em class="note">(inherited documentation)</em></dd>
354 </dt>
355 </dl>
356</td></tr></table>
357</div>
358<br />
359<!-- ==================== NAVIGATION BAR ==================== -->
360<table class="navbar" border="0" width="100%" cellpadding="0"
361 bgcolor="#a0c0ff" cellspacing="0">
362 <tr valign="middle">
363
364 <!-- Tree link -->
365 <th>&nbsp;&nbsp;&nbsp;<a
366 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
367
368 <!-- Index link -->
369 <th>&nbsp;&nbsp;&nbsp;<a
370 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
371
372 <!-- Help link -->
373 <th>&nbsp;&nbsp;&nbsp;<a
374 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
375
376 <th class="navbar" width="100%"></th>
377 </tr>
378</table>
379<table border="0" cellpadding="0" cellspacing="0" width="100%%">
380 <tr>
381 <td align="left" class="footer">
382 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012
383 </td>
384 <td align="right" class="footer">
385 <a target="mainFrame" href="http://epydoc.sourceforge.net"
386 >http://epydoc.sourceforge.net</a>
387 </td>
388 </tr>
389</table>
390
391<script type="text/javascript">
392 <!--
393 // Private objects are initially displayed (because if
394 // javascript is turned off then we want them to be
395 // visible); but by default, we want to hide them. So hide
396 // them unless we have a cookie that says to show them.
397 checkCookie();
398 // -->
399</script>
400</body>
401</html>