Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / lib / mailbox-objects.html
CommitLineData
86530b38
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="prev" href="module-mailbox.html" />
13<link rel="parent" href="module-mailbox.html" />
14<link rel="next" href="module-mhlib.html" />
15<meta name='aesop' content='information' />
16<title>12.4.1 Mailbox Objects </title>
17</head>
18<body>
19<DIV CLASS="navigation">
20<div id='top-navigation-panel' xml:id='top-navigation-panel'>
21<table align="center" width="100%" cellpadding="0" cellspacing="2">
22<tr>
23<td class='online-navigation'><a rel="prev" title="12.4 mailbox "
24 href="module-mailbox.html"><img src='../icons/previous.png'
25 border='0' height='32' alt='Previous Page' width='32' /></A></td>
26<td class='online-navigation'><a rel="parent" title="12.4 mailbox "
27 href="module-mailbox.html"><img src='../icons/up.png'
28 border='0' height='32' alt='Up One Level' width='32' /></A></td>
29<td class='online-navigation'><a rel="next" title="12.5 mhlib "
30 href="module-mhlib.html"><img src='../icons/next.png'
31 border='0' height='32' alt='Next Page' width='32' /></A></td>
32<td align="center" width="100%">Python Library Reference</td>
33<td class='online-navigation'><a rel="contents" title="Table of Contents"
34 href="contents.html"><img src='../icons/contents.png'
35 border='0' height='32' alt='Contents' width='32' /></A></td>
36<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
37 border='0' height='32' alt='Module Index' width='32' /></a></td>
38<td class='online-navigation'><a rel="index" title="Index"
39 href="genindex.html"><img src='../icons/index.png'
40 border='0' height='32' alt='Index' width='32' /></A></td>
41</tr></table>
42<div class='online-navigation'>
43<b class="navlabel">Previous:</b>
44<a class="sectref" rel="prev" href="module-mailbox.html">12.4 mailbox </A>
45<b class="navlabel">Up:</b>
46<a class="sectref" rel="parent" href="module-mailbox.html">12.4 mailbox </A>
47<b class="navlabel">Next:</b>
48<a class="sectref" rel="next" href="module-mhlib.html">12.5 mhlib </A>
49</div>
50<hr /></div>
51</DIV>
52<!--End of Navigation Panel-->
53
54<H2><A NAME="SECTION0014410000000000000000"></A><A NAME="mailbox-objects"></A>
55<BR>
5612.4.1 Mailbox Objects
57</H2>
58
59<P>
60All implementations of mailbox objects are iterable objects, and
61have one externally visible method. This method is used by iterators
62created from mailbox objects and may also be used directly.
63
64<P>
65<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
66 <td><nobr><b><tt id='l2h-3970' xml:id='l2h-3970' class="method">next</tt></b>(</nobr></td>
67 <td><var></var>)</td></tr></table></dt>
68<dd>
69Return the next message in the mailbox, created with the optional
70<var>factory</var> argument passed into the mailbox object's constructor.
71By default this is an <tt class="class">rfc822.Message</tt>
72object (see the <tt class="module"><a href="module-rfc822.html">rfc822</a></tt> module). Depending on the mailbox
73implementation the <var>fp</var> attribute of this object may be a true
74file object or a class instance simulating a file object, taking care
75of things like message boundaries if multiple mail messages are
76contained in a single file, etc. If no more messages are available,
77this method returns <code>None</code>.
78</dl>
79
80<DIV CLASS="navigation">
81<div class='online-navigation'>
82<p></p><hr />
83<table align="center" width="100%" cellpadding="0" cellspacing="2">
84<tr>
85<td class='online-navigation'><a rel="prev" title="12.4 mailbox "
86 href="module-mailbox.html"><img src='../icons/previous.png'
87 border='0' height='32' alt='Previous Page' width='32' /></A></td>
88<td class='online-navigation'><a rel="parent" title="12.4 mailbox "
89 href="module-mailbox.html"><img src='../icons/up.png'
90 border='0' height='32' alt='Up One Level' width='32' /></A></td>
91<td class='online-navigation'><a rel="next" title="12.5 mhlib "
92 href="module-mhlib.html"><img src='../icons/next.png'
93 border='0' height='32' alt='Next Page' width='32' /></A></td>
94<td align="center" width="100%">Python Library Reference</td>
95<td class='online-navigation'><a rel="contents" title="Table of Contents"
96 href="contents.html"><img src='../icons/contents.png'
97 border='0' height='32' alt='Contents' width='32' /></A></td>
98<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
99 border='0' height='32' alt='Module Index' width='32' /></a></td>
100<td class='online-navigation'><a rel="index" title="Index"
101 href="genindex.html"><img src='../icons/index.png'
102 border='0' height='32' alt='Index' width='32' /></A></td>
103</tr></table>
104<div class='online-navigation'>
105<b class="navlabel">Previous:</b>
106<a class="sectref" rel="prev" href="module-mailbox.html">12.4 mailbox </A>
107<b class="navlabel">Up:</b>
108<a class="sectref" rel="parent" href="module-mailbox.html">12.4 mailbox </A>
109<b class="navlabel">Next:</b>
110<a class="sectref" rel="next" href="module-mhlib.html">12.5 mhlib </A>
111</div>
112</div>
113<hr />
114<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
115</DIV>
116<!--End of Navigation Panel-->
117<ADDRESS>
118See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
119</ADDRESS>
120</BODY>
121</HTML>