(PHP 4, PHP 5, PHP 7, PHP 8)
imap_listscan — Liefert eine Liste von Postfächern nach Suchkriterien
$imap
, string $reference
, string $pattern
, string $content
) : array|false
Gibt ein Array mit den Namen der Postfächer zurück, in deren Inhalt der
Suchtext content
vorkommt.
Diese Funktion verhält sich ähnlich wie
imap_listmailbox(), sucht aber zusätzlich nach dem
Suchtext content
innerhalb der Daten des Postfachs.
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.
content
Der zu suchende Text
Gibt ein Array mit den Namen der Postfächer zurück, in deren Inhalt der
Suchtext content
vorkommt. Im Fehlerfall wird false
zurückgegeben.