imap_lsub
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — Liefert eine Liste aller abonnierten Postfächer
Beschreibung
Gibt ein Array aller vom Benutzer abonnierten Postfächer zurück.
Parameter-Liste
-
imap -
Eine IMAP\Connection-Instanz.
-
reference -
Die Angabe des Servers in der in imap_open() beschriebenen Form.
WarnungDie Ü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 Postfach-Hierarchie mit der Suche begonnen werden soll.
Es gibt zwei Sonderzeichen, die man als Teil von
patternverwenden kann: '*' und '%'. '*' heißt, dass alle Postfächer zurückgegeben werden sollen. Wenn manpatternals '*' übergibt, so erhält man eine Liste der vollständigen Postfach-Hierarchie. '%' heißt, dass nur die aktuelle Stufe zurückgegeben wird. '%' als Wert despatternParameters wird nur die Postfächer auf höchster Stufe zurückgeben. '~/mail/%' unterUW_IMAPDwird jedes Postfach innerhalb des Verzeichnisses ~/mail zurückgeben, aber keine innerhalb von dessen Unterverzeichnissen.
Rückgabewerte
Gibt ein Array mit allen abonnierten Postfächern zurück.
Bei einem Fehler wird false zurückgegeben.
Changelog
| Version | Beschreibung |
|---|---|
| 8.1.0 |
Der Parameter imap erwartet nun eine
IMAP\Connection-Instanz; vorher wurde eine Ressource
erwartet.
|
Siehe auch
- imap_list() - Liefert die Liste der Postfächer
- imap_getmailboxes() - Liefert detaillierte Informationen zu allen Postfächern
