imap_listscan

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

imap_listscan — Lit la liste des boîtes aux lettres, et y recherche une chaîne

Description

function imap_listscan(
    IMAP\Connection $imap,
    string $reference,
    string $pattern,
    string $content
): array|false

Retourne un tableau contenant les noms des boîtes aux lettres qui contiennent la chaîne content dans leur nom.

Cette fonction est similaire à imap_listmailbox(), mais va aussi vérifier la présence de la chaîne content dans les messages de la boîte aux lettres.

Liste de paramètres

imap

Une instance de IMAP\Connection.

reference

reference ne devrait être que le serveur sous la forme décrite dans imap_open()

Avertissement

Passer des données qui ne sont pas dignes de confiance à ce paramètre est dangereux, sauf si imap.enable_insecure_rsh est désactivé.

pattern

Spécifie la position dans la hiérarchie des boîtes aux lettres, où il faut commencer à chercher.

Il y a deux caractères spéciaux qui peuvent être utilisés dans pattern : '*' et '%'. '*' signifie : toutes les boîtes aux lettres. Si vous passez pattern comme '*', vous obtiendrez la liste complète des boîtes aux lettres de la hiérarchie. '%' signifie qu'on ne s'intéresse qu'au niveau courant. '%' passé à pattern ne retournera que les boîtes aux lettres de niveau supérieur ; '~/mail/%' sous UW_IMAPD retournera toutes les boîtes aux lettres du dossier ~/mail, mais pas celles de ses sous-dossiers.

content

La chaîne cherchée

Valeurs de retour

Retourne un tableau contenant les noms des boîtes aux lettres qui contiennent la chaîne content dans le nom de la boîte aux lettres, ou false si une erreur survient.

Historique

Version Description
8.1.0 Le paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une resource imap était attendue.

Voir aussi