Liste alle abonnierten Postfächer

Beschreibung

imap_getsubscribed ( resource $imap_stream , string $ref , string $pattern ) : array

Liefert Informationen zu den abonnierten Postfächern.

Diese Funktion ist weitgehend identisch zu imap_getmailboxes(), beachtet aber nur Postfächer, die der Benutzer bereits abonniert hat.

Parameter-Liste

imap_stream

Eine von imap_open() zurückgegebene IMAP-Verbindung.

ref

Spezifiziert den gewünschten Server wie in imap_open() beschrieben.

Warnung

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

pattern

Gibt an, wo in der Mailbox-Hierarchie mit der Suche begonnen werden soll.

Es gibt zwei Sonderzeichen, die man als Teil des pattern verwenden kann: '*' und '%'. '*' heißt, dass alle Mailboxen zurückgegeben werden sollen. Wenn man pattern als '*' übergibt, so erhält man eine Liste der vollständigen Mailboxhierarchie. '%' heißt, dass nur die aktuelle Stufe zurückgegeben wird. '%' als Wert des pattern Parameters wird nur die Mailboxen auf höchster Stufe zurückgeben. '~/mail/%' unter UW_IMAPD wird jede Mailbox innerhalb des ~/mail-Verzeichnisses zurückgeben, aber keine innerhalb von dessen Unterverzeichnissen.

Rückgabewerte

Liefert ein Array, das Objekte mit Postfachbeschreibungen, enthält. Jedes Objekt verfügt über die Attribute name für den Namen des Postfachs, delimiter für das gültige Hierachietrennzeichen innerhalb des Hierachieabschnitts in dem sich das Postfach befindet, und Eigenschaften des Postfachs in attribute. Die Eigenschaften setzen sich als Bitmaske aus folgenden möglichen Werten zusammen:

LATT_NOINFERIORS - innerhalb dieses Postfachs existieren keine weiteren Unterpostfächer.
LATT_NOSELECT - dieses Postfach enthält nur Unterpostfächer aber keine Nachrichten; es kann nicht geöffnet werden.
LATT_MARKED - dieses Postfach ist markiert. Nur verwendet von UW-IMAPD.
LATT_UNMARKED - dieses Postfach ist nicht markiert. Nur verwendet von UW-IMAPD.
LATT_REFERRAL - Das Postfach bezieht sich auf eine Remote-Mailbox.
LATT_HASCHILDREN - Das Postfach enthält auswählbare Unterpostfächer.
LATT_HASNOCHILDREN - Das Postfach enthält keine auswählbaren Unterpostfächer.