📄 function.imap-status.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Returns status information on a mailbox</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-sort.html">imap_sort</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-subscribe.html">imap_subscribe</a></div> <div class="up"><a href="ref.imap.html">IMAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.imap-status" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_status</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_status</span> — <span class="dc-title">Returns status information on a mailbox</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><b>imap_status</b></b></span> ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$imap_stream</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$mailbox</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$options</tt></span> )</div> <p class="para rdfs-comment"> Gets status information about the given <i><tt class="parameter">mailbox</tt></i>. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt><span class="term"><i><tt class="parameter">imap_stream</tt></i></span><dd><p class="para">An IMAP stream returned by <a href="function.imap-open.html" class="function">imap_open()</a>.</p></dd></dt> <dt> <span class="term"><i><tt class="parameter">mailbox</tt></i></span> <dd> <p class="para"> The mailbox name, see <a href="function.imap-open.html" class="function">imap_open()</a> for more information </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">options</tt></i></span> <dd> <p class="para"> Valid flags are: <ul class="itemizedlist"> <li class="listitem"> <span class="simpara"> <b><tt>SA_MESSAGES</tt></b> - set status->messages to the number of messages in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> <b><tt>SA_RECENT</tt></b> - set status->recent to the number of recent messages in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> <b><tt>SA_UNSEEN</tt></b> - set status->unseen to the number of unseen (new) messages in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> <b><tt>SA_UIDNEXT</tt></b> - set status->uidnext to the next uid to be used in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> <b><tt>SA_UIDVALIDITY</tt></b> - set status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid </span> </li> <li class="listitem"> <span class="simpara"> <b><tt>SA_ALL</tt></b> - set all of the above </span> </li> </ul> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> This function returns an object containing status information. The object has the following properties: <i>messages</i>, <i>recent</i>, <i>unseen</i>, <i>uidnext</i>, and <i>uidvalidity</i>. </p> <p class="para"> <i>flags</i> is also set, which contains a bitmask which can be checked against any of the above constants. </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 <b>imap_status()</b> example</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.com}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">, </span><span style="color: #0000BB">OP_HALFOPEN</span><span style="color: #007700">)<br /> or die(</span><span style="color: #DD0000">"can't connect: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$status </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX"</span><span style="color: #007700">, </span><span style="color: #0000BB">SA_ALL</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$status</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Messages: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">messages </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Recent: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">recent </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Unseen: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">unseen </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"UIDnext: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">uidnext </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"UIDvalidity:" </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">uidvalidity </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"imap_status failed: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-sort.html">imap_sort</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-subscribe.html">imap_subscribe</a></div> <div class="up"><a href="ref.imap.html">IMAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -