imap_listscan

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_listscan — Liefert eine Liste von Postfächern nach Suchkriterien

Beschreibung

imap_listscan(
    IMAP\Connection $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.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

reference

Die Angabe des Servers in der in imap_open() beschriebenen Form.

Warnung

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 Postfach-Hierarchie mit der Suche begonnen werden soll.

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

content

Der zu suchende Text

Rückgabewerte

Gibt ein Array mit den Namen der Postfächer zurück, in deren Inhalt der Suchtext content vorkommt. 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_listmailbox() - Alias von imap_list
imap_search() - Liefert ein Array von Nachrichten, die den gegebenen Suchkriterien entsprechen

add a note

User Contributed Notes

There are no user contributed notes for this page.