(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — Liefert die Liste aller abonnierten Postfächer
$imap
, string $reference
, string $pattern
) : array|falseGibt Informationen zu den abonnierten Postfächern zurück.
Diese Funktion ist weitgehend identisch zu imap_getmailboxes(), beachtet aber nur Postfächer, die der Benutzer bereits abonniert hat.
imap
Eine von imap_open() zurückgegebene IMAP-Verbindung.
reference
Die Angabe des Servers in der in imap_open() beschriebenen Form.
Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher, falls imap.enable_insecure_rsh nicht deaktiviert ist.
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.
Gibt ein Array zurück, 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
- Dieses Postfach enthält keine
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
- Dieses Postfach bezieht sich auf
eine Remote-Mailbox.
LATT_HASCHILDREN
- Dieses Postfach enthält
auswählbare Unterpostfächer.
LATT_HASNOCHILDREN
- Dieses Postfach enthält keine
auswählbaren Unterpostfächer.
false
zurück.