function.imap-search.html
来自「php的帮助文档,涉及到PHP的案例和基本语法,以及实际应用内容」· HTML 代码 · 共 288 行
HTML
288 行
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>This function returns an array of messages matching the given search criteria</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-scanmailbox.html">imap_scanmailbox</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-set-quota.html">imap_set_quota</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-search" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_search</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_search</span> — <span class="dc-title">This function returns an array of messages matching the given search criteria</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_search</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">$criteria</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$options</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$charset</tt></span> ]] )</div> <p class="para rdfs-comment"> This function performs a search on the mailbox currently opened in the given imap stream. </p> <p class="para"> For example, to match all unanswered messages sent by Mom, you'd use: "UNANSWERED FROM mom". Searches appear to be case insensitive. This list of criteria is from a reading of the UW c-client source code and may be incomplete or inaccurate (see also <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">» RFC2060</a>, section 6.4.4). </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">criteria</tt></i></span> <dd> <p class="para"> A string, delimited by spaces, in which the following keywords are allowed. Any multi-word arguments (e.g. FROM "joey smith") must be quoted. <ul class="itemizedlist"> <li class="listitem"> <span class="simpara"> ALL - return all messages matching the rest of the criteria </span> </li> <li class="listitem"> <span class="simpara"> ANSWERED - match messages with the \\ANSWERED flag set </span> </li> <li class="listitem"> <span class="simpara"> BCC "string" - match messages with "string" in the Bcc: field </span> </li> <li class="listitem"> <span class="simpara"> BEFORE "date" - match messages with Date: before "date" </span> </li> <li class="listitem"> <span class="simpara"> BODY "string" - match messages with "string" in the body of the message </span> </li> <li class="listitem"> <span class="simpara"> CC "string" - match messages with "string" in the Cc: field </span> </li> <li class="listitem"> <span class="simpara"> DELETED - match deleted messages </span> </li> <li class="listitem"> <span class="simpara"> FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set </span> </li> <li class="listitem"> <span class="simpara"> FROM "string" - match messages with "string" in the From: field </span> </li> <li class="listitem"> <span class="simpara"> KEYWORD "string" - match messages with "string" as a keyword </span> </li> <li class="listitem"> <span class="simpara"> NEW - match new messages </span> </li> <li class="listitem"> <span class="simpara"> OLD - match old messages </span> </li> <li class="listitem"> <span class="simpara"> ON "date" - match messages with Date: matching "date" </span> </li> <li class="listitem"> <span class="simpara"> RECENT - match messages with the \\RECENT flag set </span> </li> <li class="listitem"> <span class="simpara"> SEEN - match messages that have been read (the \\SEEN flag is set) </span> </li> <li class="listitem"> <span class="simpara"> SINCE "date" - match messages with Date: after "date" </span> </li> <li class="listitem"> <span class="simpara"> SUBJECT "string" - match messages with "string" in the Subject: </span> </li> <li class="listitem"> <span class="simpara"> TEXT "string" - match messages with text "string" </span> </li> <li class="listitem"> <span class="simpara"> TO "string" - match messages with "string" in the To: </span> </li> <li class="listitem"> <span class="simpara"> UNANSWERED - match messages that have not been answered </span> </li> <li class="listitem"> <span class="simpara"> UNDELETED - match messages that are not deleted </span> </li> <li class="listitem"> <span class="simpara"> UNFLAGGED - match messages that are not flagged </span> </li> <li class="listitem"> <span class="simpara"> UNKEYWORD "string" - match messages that do not have the keyword "string" </span> </li> <li class="listitem"> <span class="simpara"> UNSEEN - match messages which have not been read yet </span> </li> </ul> </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">options</tt></i></span> <dd> <p class="para"> Valid values for <i><tt class="parameter">options</tt></i> are <b><tt>SE_UID</tt></b>, which causes the returned array to contain UIDs instead of messages sequence numbers. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">charset</tt></i></span> <dd> <p class="para"> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an array of message numbers or UIDs. </p> <p class="para"> Return <b><tt>FALSE</tt></b> if it does not understand the search <i><tt class="parameter">criteria</tt></i> or no messages have been found. </p> </div> <div class="refsect1 changelog"> <h3 class="title">ChangeLog</h3> <p class="para"> <table class="informaltable"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Version</th> <th colspan="1">Description</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">4.3.3</td> <td colspan="1" rowspan="1" align="left"> The <i><tt class="parameter">charset</tt></i> parameter was added </td> </tr> </tbody> </colgroup> </table> </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-listscan.html" class="function" rel="rdfs-seeAlso">imap_listscan()</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-scanmailbox.html">imap_scanmailbox</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-set-quota.html">imap_set_quota</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 + -
显示快捷键?