Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 6ceea2de24d94155f5c535c4485ee772f07e5c97 / . / docs / epy / mimetools.Message-class.html
blob: 06b84c056ce5f58019ded3f77cdb7415381a6a99 [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>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_message" name="class_hierarchy_for_message">
59<area shape="rect" href="mimetools.Message-class.html" title="Message" alt="" coords="24,61,99,88"/>
60<area shape="rect" href="javascript:void(0);" title="rfc822.Message" alt="" coords="5,5,117,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]61</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]62 <img src="class_hierarchy_for_message.gif" alt='' usemap="#class_hierarchy_for_message" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]63</center>
64</center>
65<hr />
66<pre class="literalblock">
67A derived class of rfc822.Message that knows about MIME headers and
68contains some hooks for decoding encoded and multipart messages.
69
70</pre>
71
72<!-- ==================== INSTANCE METHODS ==================== -->
73<a name="section-InstanceMethods"></a>
74<table class="summary" border="1" cellpadding="3"
75 cellspacing="0" width="100%" bgcolor="white">
76<tr bgcolor="#70b0f0" class="table-header">
77 <td colspan="2" class="table-header">
78 <table border="0" cellpadding="0" cellspacing="0" width="100%">
79 <tr valign="top">
80 <td align="left"><span class="table-header">Instance Methods</span></td>
81 <td align="right" valign="top"
82 ><span class="options">[<a href="#section-InstanceMethods"
83 class="privatelink" onclick="toggle_private();"
84 >hide private</a>]</span></td>
85 </tr>
86 </table>
87 </td>
88</tr>
89<tr>
90 <td width="15%" align="right" valign="top" class="summary">
91 <span class="summary-type">&nbsp;</span>
92 </td><td class="summary">
93 <table width="100%" cellpadding="0" cellspacing="0" border="0">
94 <tr>
95 <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>,
96 <span class="summary-sig-arg">fp</span>,
97 <span class="summary-sig-arg">seekable</span>=<span class="summary-sig-default">1</span>)</span><br />
98 Initialize the class instance and read the headers.</td>
99 <td align="right" valign="top">
100
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <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>
115 <td align="right" valign="top">
116
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <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>
131 <td align="right" valign="top">
132
133
134 </td>
135 </tr>
136 </table>
137
138 </td>
139 </tr>
140<tr>
141 <td width="15%" align="right" valign="top" class="summary">
142 <span class="summary-type">&nbsp;</span>
143 </td><td class="summary">
144 <table width="100%" cellpadding="0" cellspacing="0" border="0">
145 <tr>
146 <td><span class="summary-sig"><a name="getparam"></a><span class="summary-sig-name">getparam</span>(<span class="summary-sig-arg">self</span>,
147 <span class="summary-sig-arg">name</span>)</span></td>
148 <td align="right" valign="top">
149
150
151 </td>
152 </tr>
153 </table>
154
155 </td>
156 </tr>
157<tr>
158 <td width="15%" align="right" valign="top" class="summary">
159 <span class="summary-type">&nbsp;</span>
160 </td><td class="summary">
161 <table width="100%" cellpadding="0" cellspacing="0" border="0">
162 <tr>
163 <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>
164 <td align="right" valign="top">
165
166
167 </td>
168 </tr>
169 </table>
170
171 </td>
172 </tr>
173<tr>
174 <td width="15%" align="right" valign="top" class="summary">
175 <span class="summary-type">&nbsp;</span>
176 </td><td class="summary">
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr>
179 <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>
180 <td align="right" valign="top">
181
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189<tr>
190 <td width="15%" align="right" valign="top" class="summary">
191 <span class="summary-type">&nbsp;</span>
192 </td><td class="summary">
193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <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>
196 <td align="right" valign="top">
197
198
199 </td>
200 </tr>
201 </table>
202
203 </td>
204 </tr>
205<tr>
206 <td width="15%" align="right" valign="top" class="summary">
207 <span class="summary-type">&nbsp;</span>
208 </td><td class="summary">
209 <table width="100%" cellpadding="0" cellspacing="0" border="0">
210 <tr>
211 <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>
212 <td align="right" valign="top">
213
214
215 </td>
216 </tr>
217 </table>
218
219 </td>
220 </tr>
221<tr>
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type">&nbsp;</span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr>
227 <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>
228 <td align="right" valign="top">
229
230
231 </td>
232 </tr>
233 </table>
234
235 </td>
236 </tr>
237<tr>
238 <td width="15%" align="right" valign="top" class="summary">
239 <span class="summary-type">&nbsp;</span>
240 </td><td class="summary">
241 <table width="100%" cellpadding="0" cellspacing="0" border="0">
242 <tr>
243 <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>
244 <td align="right" valign="top">
245
246
247 </td>
248 </tr>
249 </table>
250
251 </td>
252 </tr>
253 <tr>
254 <td colspan="2" class="summary">
255 <p class="indent-wrapped-lines"><b>Inherited from <code>rfc822.Message</code></b>:
256 <code>__contains__</code>,
257 <code>__delitem__</code>,
258 <code>__getitem__</code>,
259 <code>__iter__</code>,
260 <code>__len__</code>,
261 <code>__setitem__</code>,
262 <code>__str__</code>,
263 <code>get</code>,
264 <code>getaddr</code>,
265 <code>getaddrlist</code>,
266 <code>getallmatchingheaders</code>,
267 <code>getdate</code>,
268 <code>getdate_tz</code>,
269 <code>getfirstmatchingheader</code>,
270 <code>getheader</code>,
271 <code>getheaders</code>,
272 <code>getrawheader</code>,
273 <code>has_key</code>,
274 <code>iscomment</code>,
275 <code>isheader</code>,
276 <code>islast</code>,
277 <code>items</code>,
278 <code>keys</code>,
279 <code>readheaders</code>,
280 <code>rewindbody</code>,
281 <code>setdefault</code>,
282 <code>values</code>
283 </p>
284 </td>
285 </tr>
286</table>
287<!-- ==================== METHOD DETAILS ==================== -->
288<a name="section-MethodDetails"></a>
289<table class="details" border="1" cellpadding="3"
290 cellspacing="0" width="100%" bgcolor="white">
291<tr bgcolor="#70b0f0" class="table-header">
292 <td colspan="2" class="table-header">
293 <table border="0" cellpadding="0" cellspacing="0" width="100%">
294 <tr valign="top">
295 <td align="left"><span class="table-header">Method Details</span></td>
296 <td align="right" valign="top"
297 ><span class="options">[<a href="#section-MethodDetails"
298 class="privatelink" onclick="toggle_private();"
299 >hide private</a>]</span></td>
300 </tr>
301 </table>
302 </td>
303</tr>
304</table>
305<a name="__init__"></a>
306<div>
307<table class="details" border="1" cellpadding="3"
308 cellspacing="0" width="100%" bgcolor="white">
309<tr><td>
310 <table width="100%" cellpadding="0" cellspacing="0" border="0">
311 <tr valign="top"><td>
312 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
313 <span class="sig-arg">fp</span>,
314 <span class="sig-arg">seekable</span>=<span class="sig-default">1</span>)</span>
315 <br /><em class="fname">(Constructor)</em>
316 </h3>
317 </td><td align="right" valign="top"
318 >&nbsp;
319 </td>
320 </tr></table>
321
322 <pre class="literalblock">
323Initialize the class instance and read the headers.
324
325</pre>
326 <dl class="fields">
327 <dt>Overrides:
328 rfc822.Message.__init__
329 <dd><em class="note">(inherited documentation)</em></dd>
330 </dt>
331 </dl>
332</td></tr></table>
333</div>
334<br />
335<!-- ==================== NAVIGATION BAR ==================== -->
336<table class="navbar" border="0" width="100%" cellpadding="0"
337 bgcolor="#a0c0ff" cellspacing="0">
338 <tr valign="middle">
339
340 <!-- Tree link -->
341 <th>&nbsp;&nbsp;&nbsp;<a
342 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
343
344 <!-- Index link -->
345 <th>&nbsp;&nbsp;&nbsp;<a
346 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
347
348 <!-- Help link -->
349 <th>&nbsp;&nbsp;&nbsp;<a
350 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
351
352 <th class="navbar" width="100%"></th>
353 </tr>
354</table>
355<table border="0" cellpadding="0" cellspacing="0" width="100%%">
356 <tr>
357 <td align="left" class="footer">
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]358 Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]359 </td>
360 <td align="right" class="footer">
361 <a target="mainFrame" href="http://epydoc.sourceforge.net"
362 >http://epydoc.sourceforge.net</a>
363 </td>
364 </tr>
365</table>
366
367<script type="text/javascript">
368 <!--
369 // Private objects are initially displayed (because if
370 // javascript is turned off then we want them to be
371 // visible); but by default, we want to hide them. So hide
372 // them unless we have a cookie that says to show them.
373 checkCookie();
374 // -->
375</script>
376</body>
377</html>