<!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><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-getmailboxes.html">imap_getmailboxes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-header.html">imap_header</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-getsubscribed" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_getsubscribed</h1>
<p class="verinfo">(PHP 4, PHP 5)</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">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <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>
)</div>
<p class="para rdfs-comment">
Gets information about the subscribed mailboxes.
</p>
<p class="para">
Identical to <span class="function"><a href="function.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">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
imap_stream</code></em></span><dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ref</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">ref</code></em> should normally be just the server
specification as described in <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">pattern</code></em></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 <em><code class="parameter">pattern</code></em>:
'<em>*</em>' and '<em>%</em>'.
'<em>*</em>' means to return all mailboxes. If you pass
<em><code class="parameter">pattern</code></em> as '<em>*</em>', you will
get a list of the entire mailbox hierarchy.
'<em>%</em>'
means to return the current level only.
'<em>%</em>' as the <em><code class="parameter">pattern</code></em>
parameter will return only the top level
mailboxes; '<em>~/mail/%</em>' on <em>UW_IMAPD</em> will return every mailbox in the <var class="filename">~/mail</var> directory, but none in subfolders of that directory.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-getsubscribed-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of objects containing mailbox information. Each
object has the attributes <em><code class="parameter">name</code></em>, specifying
the full name of the mailbox; <em><code class="parameter">delimiter</code></em>,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
<em><code class="parameter">attributes</code></em>. <em><code class="parameter">Attributes</code></em>
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>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-getmailboxes.html">imap_getmailboxes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-header.html">imap_header</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>
