-
Notifications
You must be signed in to change notification settings - Fork 146
/
imap-getmailboxes.xml
185 lines (178 loc) · 5.48 KB
/
imap-getmailboxes.xml
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-getmailboxes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_getmailboxes</refname>
<refpurpose>Liste les boîtes aux lettres, et retourne les détails de chacune</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_getmailboxes</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>
Liste les boîtes aux lettres.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>reference</parameter></term>
<listitem>
<para>
<parameter>reference</parameter> ne devrait être que le serveur
sous la forme décrite dans <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>
Retourne un tableau d'objets contenant les informations sur les
boîtes aux lettres. Chaque objet possède un attribut de
<parameter>name</parameter>, qui contient le nom complet
de la boîte aux lettres, <parameter>delimiter</parameter> qui
est le délimiteur hiérarchique et <parameter>attributes</parameter>.
<parameter>attributes</parameter> est un masque de bits, qui contient :
<itemizedlist>
<listitem>
<para>
<constant>LATT_NOINFERIORS</constant> - Cette boîte aux lettres
n'a pas d'"enfants" (il n'y a plus de boîtes aux lettres en
dessous de celle-ci) et ne peut en contenir aucun. Un appel à la
fonction <function>imap_createmailbox</function> ne fonctionnera pas
sur cette boîte.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_NOSELECT</constant> - Ceci est juste un container,
pas une boîte aux lettres (vous ne pouvez pas l'ouvrir).
</para>
</listitem>
<listitem>
<para>
<constant>LATT_MARKED</constant> - Cette boîte aux lettres est marquée.
Ceci signifie qu'elle peut contenir des nouveaux messages depuis la dernière
fois qu'elle a été vérifiée. Ce marqueur n'est pas fourni avec tous les
serveurs IMAP.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_UNMARKED</constant> - Cette boîte aux lettres n'est pas
marquée et ne contient pas de nouveaux messages. Si
<constant>MARKED</constant> ou <constant>UNMARKED</constant> est fourni,
vous pouvez supposer que le serveur IMAP supporte cette fonctionnalité
pour cette boîte aux lettres.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_REFERRAL</constant> - Ce conteneur a une référence vers une boîte aux lettres distante.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASCHILDREN</constant> - Cette boîte aux lettres a des inférieurs sélectionnables.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASNOCHILDREN</constant> - Cette boîte aux lettres n'a pas d'inférieurs sélectionnables.
</para>
</listitem>
</itemizedlist>
Retourne &false; en cas d'échec.
</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>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>imap_getmailboxes</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Connexion impossible : " . imap_last_error());
$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "<br />\n";
}
} else {
echo "imap_getmailboxes a échoué : " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_getsubscribed</function></member>
</simplelist>
</para>
</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
-->