function.imap-fetch-overview.html
来自「php的帮助文档,涉及到PHP的案例和基本语法,以及实际应用内容」· HTML 代码 · 共 209 行
HTML
209 行
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Read an overview of the information in the headers of the given message</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-expunge.html">imap_expunge</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-fetchbody.html">imap_fetchbody</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-fetch-overview" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_fetch_overview</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_fetch_overview</span> — <span class="dc-title">Read an overview of the information in the headers of the given message</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><b>imap_fetch_overview</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">$sequence</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$options</tt></span> ] )</div> <p class="para rdfs-comment"> This function fetches mail headers for the given <i><tt class="parameter">sequence</tt></i> and returns an overview of their contents. </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">sequence</tt></i></span> <dd> <p class="para"> A message sequence description. You can enumerate desired messages with the <i>X,Y</i> syntax, or retrieve all messages within an interval with the <i>X:Y</i> syntax </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">options</tt></i></span> <dd> <p class="para"> <i><tt class="parameter">sequence</tt></i> will contain a sequence of message indices or UIDs, if this parameter is set to <b><tt>FT_UID</tt></b>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are: <ul class="itemizedlist"> <li class="listitem"> <span class="simpara"> subject - the messages subject </span> </li> <li class="listitem"> <span class="simpara"> from - who sent it </span> </li> <li class="listitem"> <span class="simpara"> to - recipient </span> </li> <li class="listitem"> <span class="simpara"> date - when was it sent </span> </li> <li class="listitem"> <span class="simpara"> message_id - Message-ID </span> </li> <li class="listitem"> <span class="simpara"> references - is a reference to this message id </span> </li> <li class="listitem"> <span class="simpara"> in_reply_to - is a reply to this message id </span> </li> <li class="listitem"> <span class="simpara"> size - size in bytes </span> </li> <li class="listitem"> <span class="simpara"> uid - UID the message has in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> msgno - message sequence number in the mailbox </span> </li> <li class="listitem"> <span class="simpara"> recent - this message is flagged as recent </span> </li> <li class="listitem"> <span class="simpara"> flagged - this message is flagged </span> </li> <li class="listitem"> <span class="simpara"> answered - this message is flagged as answered </span> </li> <li class="listitem"> <span class="simpara"> deleted - this message is flagged for deletion </span> </li> <li class="listitem"> <span class="simpara"> seen - this message is flagged as already read </span> </li> <li class="listitem"> <span class="simpara"> draft - this message is flagged as being a draft </span> </li> </ul> </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 <b>imap_fetch_overview()</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.org:143}INBOX"</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">)<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">$MC </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Fetch an overview for all messages in INBOX<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_fetch_overview</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">,</span><span style="color: #DD0000">"1:{$MC->Nmsgs}"</span><span style="color: #007700">,</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$result </span><span style="color: #007700">as </span><span style="color: #0000BB">$overview</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"#{$overview->msgno} ({$overview->date}) - From: {$overview->from}<br /> {$overview->subject}\n"</span><span style="color: #007700">;<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 class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.imap-fetchheader.html" class="function" rel="rdfs-seeAlso">imap_fetchheader()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-expunge.html">imap_expunge</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-fetchbody.html">imap_fetchbody</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 + =
减小字号Ctrl + -
显示快捷键?