mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
161 lines
9.9 KiB
HTML
161 lines
9.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<title>Read the list of mailboxes, returning detailed information on each one</title>
|
|
</head>
|
|
<body class="docs"><div id="layout">
|
|
<div id="layout-content"><div id="function.imap-getmailboxes" class="refentry">
|
|
<div class="refnamediv">
|
|
<h1 class="refname">imap_getmailboxes</h1>
|
|
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_getmailboxes</span> — <span class="dc-title">Read the list of mailboxes, returning detailed information on each one</span></p>
|
|
|
|
</div>
|
|
<div class="refsect1 description" id="refsect1-function.imap-getmailboxes-description">
|
|
<h3 class="title">说明</h3>
|
|
<div class="methodsynopsis dc-description">
|
|
<span class="methodname"><strong>imap_getmailboxes</strong></span>
|
|
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
|
|
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$ref</code></span>
|
|
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
|
|
) : <span class="type">array</span></div>
|
|
|
|
<p class="para rdfs-comment">
|
|
Gets information on the mailboxes.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 parameters" id="refsect1-function.imap-getmailboxes-parameters">
|
|
<h3 class="title">参数</h3>
|
|
<p class="para">
|
|
<dl>
|
|
|
|
<dt>
|
|
<code class="parameter">
|
|
imap_stream</code></dt>
|
|
<dd>
|
|
<p class="para">由 <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</p></dd>
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">ref</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
<code class="parameter">ref</code> should normally be just the server
|
|
specification as described in <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span>
|
|
</p>
|
|
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">
|
|
Passing untrusted data to this parameter is <em class="emphasis">insecure</em>, unless
|
|
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
|
|
</p></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">pattern</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">指定在邮箱层级的何处开始查找。</p>
|
|
<p class="para">在组成 <code class="parameter">pattern</code> 的字符中可使用两个特殊字符：
|
|
'<em>*</em>' 和 '<em>%</em>'。
|
|
'<em>*</em>' 是指返回所有邮箱目录. 如果将 '<em>*</em>' 作为
|
|
<code class="parameter">pattern</code> 参数时, 则会返回整个邮箱层级结构。
|
|
'<em>%</em>' 是指只返回当前级次。
|
|
'<em>%</em>' 作为 <code class="parameter">pattern</code> 参数则只会返回顶层邮箱；
|
|
'<em>~/mail/%</em>' 用于 <em>UW_IMAPD</em>
|
|
则会返回名为 <var class="filename">~/mail</var> 的目录, 但不包含其子目录。</p>
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 returnvalues" id="refsect1-function.imap-getmailboxes-returnvalues">
|
|
<h3 class="title">返回值</h3>
|
|
<p class="para">
|
|
Returns an array of objects containing mailbox information. Each
|
|
object has the attributes <code class="parameter">name</code>, specifying
|
|
the full name of the mailbox; <code class="parameter">delimiter</code>,
|
|
which is the hierarchy delimiter for the part of the hierarchy
|
|
this mailbox is in; and
|
|
<code class="parameter">attributes</code>. <code class="parameter">Attributes</code>
|
|
is a bitmask that can be tested against:
|
|
<ul class="itemizedlist">
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_NOINFERIORS</code></strong> - This mailbox not contains, and may not contain any
|
|
"children" (there are no mailboxes below this one). Calling
|
|
<span class="function"><a href="imap_createmailbox.html" class="function">imap_createmailbox()</a></span> will not work on this mailbox.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_NOSELECT</code></strong> - This is only a container,
|
|
not a mailbox - you cannot open it.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_MARKED</code></strong> - This mailbox is marked. This means that it may
|
|
contain new messages since the last time it was checked. Not provided by all IMAP
|
|
servers.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_UNMARKED</code></strong> - This mailbox is not marked, does not contain new
|
|
messages. If either <strong><code>MARKED</code></strong> or <strong><code>UNMARKED</code></strong> is
|
|
provided, you can assume the IMAP server supports this feature for this mailbox.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_REFERRAL</code></strong> - This container has a referral to a remote mailbox.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_HASCHILDREN</code></strong> - This mailbox has selectable inferiors.
|
|
</p>
|
|
</li>
|
|
<li class="listitem">
|
|
<p class="para">
|
|
<strong><code>LATT_HASNOCHILDREN</code></strong> - This mailbox has no selectable inferiors.
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 examples" id="refsect1-function.imap-getmailboxes-examples">
|
|
<h3 class="title">范例</h3>
|
|
<p class="para">
|
|
<div class="example" id="example-4025">
|
|
<p><strong>Example #1 <span class="function"><strong>imap_getmailboxes()</strong></span> example</strong></p>
|
|
<div class="example-contents">
|
|
<div class="phpcode"><pre><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}"</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">$list </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_getmailboxes</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"*"</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$list</span><span style="color: #007700">)) {<br /> foreach (</span><span style="color: #0000BB">$list </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"(</span><span style="color: #0000BB">$key</span><span style="color: #DD0000">) "</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">imap_utf7_decode</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">) . </span><span style="color: #DD0000">","</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"'" </span><span style="color: #007700">. </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">delimiter </span><span style="color: #007700">. </span><span style="color: #DD0000">"',"</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">attributes </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br />} else {<br /> echo </span><span style="color: #DD0000">"imap_getmailboxes 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>
|
|
</pre></div>
|
|
</div>
|
|
|
|
</div>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 seealso" id="refsect1-function.imap-getmailboxes-seealso">
|
|
<h3 class="title">参见</h3>
|
|
<p class="para">
|
|
<ul class="simplelist">
|
|
<li class="member"><span class="function"><a href="imap_getsubscribed.html" class="function" rel="rdfs-seeAlso">imap_getsubscribed()</a> - List all the subscribed mailboxes</span></li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
|
|
</div></div></div></body></html> |