mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 22:06:57 +08:00
137 lines
5.3 KiB
HTML
137 lines
5.3 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>List all the subscribed mailboxes</title>
|
|
</head>
|
|
<body class="docs"><div id="layout">
|
|
<div id="layout-content"><div id="function.imap-getsubscribed" class="refentry">
|
|
<div class="refnamediv">
|
|
<h1 class="refname">imap_getsubscribed</h1>
|
|
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_getsubscribed</span> — <span class="dc-title">List all the subscribed mailboxes</span></p>
|
|
|
|
</div>
|
|
<div class="refsect1 description" id="refsect1-function.imap-getsubscribed-description">
|
|
<h3 class="title">说明</h3>
|
|
<div class="methodsynopsis dc-description">
|
|
<span class="methodname"><strong>imap_getsubscribed</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 about the subscribed mailboxes.
|
|
</p>
|
|
<p class="para">
|
|
Identical to <span class="function"><a href="imap_getmailboxes.html" class="function">imap_getmailboxes()</a></span>, except that it only
|
|
returns mailboxes that the user is subscribed to.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 parameters" id="refsect1-function.imap-getsubscribed-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-getsubscribed-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">
|
|
<span class="simpara">
|
|
<strong><code>LATT_NOINFERIORS</code></strong> - This mailbox has no
|
|
"children" (there are no mailboxes below this one).
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_NOSELECT</code></strong> - This is only a container,
|
|
not a mailbox - you cannot open it.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_MARKED</code></strong> - This mailbox is marked.
|
|
Only used by UW-IMAPD.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_UNMARKED</code></strong> - This mailbox is not marked.
|
|
Only used by UW-IMAPD.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_REFERRAL</code></strong> - This container has a referral to a remote mailbox.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_HASCHILDREN</code></strong> - This mailbox has selectable inferiors.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
<strong><code>LATT_HASNOCHILDREN</code></strong> - This mailbox has no selectable inferiors.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
|
|
</div></div></div></body></html> |