1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-getsubscribed" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_getsubscribed</refname>
<refpurpose>List all the subscribed mailboxes</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_getsubscribed</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>reference</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
Gets information about the subscribed mailboxes.
</para>
<para>
Identical to <function>imap_getmailboxes</function>, except that it only
returns mailboxes that the user is subscribed to.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>reference</parameter></term>
<listitem>
<para>
<parameter>reference</parameter> should normally be just the server
specification as described in <function>imap_open</function>
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
&imap.pattern;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of objects containing mailbox information. Each
object has the attributes <parameter>name</parameter>, specifying
the full name of the mailbox; <parameter>delimiter</parameter>,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
<parameter>attributes</parameter>. <parameter>Attributes</parameter>
is a bitmask that can be tested against:
<itemizedlist>
<listitem>
<simpara>
<constant>LATT_NOINFERIORS</constant> - This mailbox has no
"children" (there are no mailboxes below this one).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_NOSELECT</constant> - This is only a container,
not a mailbox - you cannot open it.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_MARKED</constant> - This mailbox is marked.
Only used by UW-IMAPD.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_UNMARKED</constant> - This mailbox is not marked.
Only used by UW-IMAPD.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_REFERRAL</constant> - This container has a referral to a remote mailbox.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_HASCHILDREN</constant> - This mailbox has selectable inferiors.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LATT_HASNOCHILDREN</constant> - This mailbox has no selectable inferiors.
</simpara>
</listitem>
</itemizedlist>
The function returns &false; on failure.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&imap.changelog.imap-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
