-
Notifications
You must be signed in to change notification settings - Fork 39
/
imap-getmailboxes.xml
191 lines (182 loc) · 5.57 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
186
187
188
189
190
191
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: nobody Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-getmailboxes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_getmailboxes</refname>
<refpurpose>Liefert detaillierte Informationen zu allen Postfächern</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>
Gibt Informationen über die Postfächer zurück.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>reference</parameter></term>
<listitem>
<para>
Die Angabe des Servers in der in <function>imap_open</function>
beschriebenen Form.
</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>
Gibt ein Array zurück, das Objekte mit Postfachbeschreibungen enthält.
Jedes Objekt verfügt über die Attribute <parameter>name</parameter> für den
Namen des Postfachs, <parameter>delimiter</parameter> für das gültige
Hierachietrennzeichen innerhalb des Hierachieabschnitts, in dem sich das
Postfach befindet, und den Eigenschaften des Postfachs in
<parameter>attributes</parameter>. Die Eigenschaften setzen sich als
Bitmaske aus folgenden möglichen Werten zusammen:
<itemizedlist>
<listitem>
<para>
<constant>LATT_NOINFERIORS</constant> - Dieses Postfach enthält keine
Unterpostfächer und kann auch keine enthalten. Der Aufruf von
<function>imap_createmailbox</function> wird für dieses Postfach
fehlschlagen.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_NOSELECT</constant> - Dieses Postfach enthält nur
Unterpostfächer aber keine Nachrichten; es kann nicht geöffnet werden.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_MARKED</constant> - Dieses Postfach ist markiert. Das
bedeutet, dass es neue Nachrichten enthalten kann, seitdem es zuletzt
geprüft wurde. Wird nicht von allen IMAP-Servern unterstützt.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_UNMARKED</constant> - Dieses Postfach ist nicht markiert,
d. h. es enthält keine neuen Nachrichten. Wenn entweder
<constant>MARKED</constant> oder <constant>UNMARKED</constant> vorhanden
ist, kann man davon ausgehen, das der IMAP-Server dieses Feature für
dieses Postfach unterstützt.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_REFERRAL</constant> - Dieses Postfach bezieht sich auf
eine Remote-Mailbox.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASCHILDREN</constant> - Dieses Postfach enthält
auswählbare Unterpostfächer.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASNOCHILDREN</constant> - Dieses Postfach enthält keine
auswählbaren Unterpostfächer.
</para>
</listitem>
</itemizedlist>
Diese Funktion gibt bei einem Fehler &false; zurück.
</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><function>imap_getmailboxes</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Kann keine Verbindung aufbauen: " . 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 schlug fehl: " . 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
-->