function.imap-listscan.html

来自「php的帮助文档,涉及到PHP的案例和基本语法,以及实际应用内容」· HTML 代码 · 共 143 行

HTML
143
字号
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head>  <title>Returns the list of mailboxes that matches the given text</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-listmailbox.html">imap_listmailbox</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-listsubscribed.html">imap_listsubscribed</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-listscan" class="refentry"> <div class="refnamediv">  <h1 class="refname">imap_listscan</h1>  <p class="verinfo">(No version information available, might be only in CVS)</p><p class="refpurpose"><span class="refname">imap_listscan</span> &mdash; <span class="dc-title">Returns the list of mailboxes that matches the given text</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_listscan</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">$ref</tt></span>   , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pattern</tt></span>   , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$content</tt></span>   )</div>  <p class="para rdfs-comment">   Returns an array containing the names of the mailboxes that have   <i><tt class="parameter">content</tt></i> in the text of the mailbox.  </p>  <p class="para">   This function is similar to <a href="function.imap-listmailbox.html" class="function">imap_listmailbox()</a>,   but it will additionally check for the presence of the string   <i><tt class="parameter">content</tt></i> inside the mailbox data.  </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">ref</tt></i></span>     <dd>      <p class="para">       <i><tt class="parameter">ref</tt></i> should normally be just the server        specification as described in <a href="function.imap-open.html" class="function">imap_open()</a>      </p>     </dd>    </dt>    <dt>     <span class="term"><i><tt class="parameter">pattern</tt></i></span>     <dd>      <p class="para">       Specifies where in the mailbox hierarchy to start searching.      </p>      <p class="para">       There are two special characters you can pass as part of the       <i><tt class="parameter">pattern</tt></i>: &#039;*&#039; and &#039;%&#039;. &#039;*&#039; means to return       all mailboxes. If you pass <i><tt class="parameter">pattern</tt></i> as &#039;*&#039;,       you will get a list of the entire mailbox hierarchy. &#039;%&#039; means to       return the current level only. &#039;%&#039; as the       <i><tt class="parameter">pattern</tt></i> parameter will return only the top       level mailboxes; &#039;~/mail/%&#039; on UW_IMAPD will return every mailbox       in the ~/mail directory, but none in subfolders of that       directory      </p>     </dd>    </dt>    <dt>     <span class="term"><i><tt class="parameter">content</tt></i></span>     <dd>      <p class="para">       The searched string      </p>     </dd>    </dt>   </dl>  </p> </div> <div class="refsect1 returnvalues">  <h3 class="title">Return Values</h3>  <p class="para">   Returns an array containing the names of the mailboxes that have   <i><tt class="parameter">content</tt></i> in the text of the mailbox.  </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-listmailbox.html" class="function" rel="rdfs-seeAlso">imap_listmailbox()</a></li>    <li class="member"><a href="function.imap-search.html" class="function" rel="rdfs-seeAlso">imap_search()</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-listmailbox.html">imap_listmailbox</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-listsubscribed.html">imap_listsubscribed</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 + -
显示快捷键?