JetBrains PHPverse 2026

    imap_list

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

    imap_list — Lit la liste des boîtes aux lettres

    Description

    imap_list(IMAP\Connection $imap, string $reference, string $pattern): array|false

    Lit la liste des boîtes 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 digne 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 que vous pouvez utiliser 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 directory, mais pas leurs enfants.

    Valeurs de retour

    Retourne un tableau contenant les noms des boîtes aux lettres, ou false si une erreur survient.

    Historique

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

    Exemples

    Exemple #1 Exemple avec imap_list()

    <?php
    $mbox     = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
    or die(    "Connexion impossible : " . imap_last_error());

    $list = imap_list($mbox, "{imap.example.org}", "*");
    if (    is_array($list)) {
    foreach (    $list as $val) {
    echo     imap_utf7_decode($val) . "\n";
    }
    } else {
    echo     "imap_list a échoué : " . imap_last_error() . "\n";
    }

    imap_close($mbox);
    ?>

    Voir aussi

    • imap_getmailboxes() - Liste les boîtes aux lettres, et retourne les détails de chacune
    • imap_lsub() - Liste toutes les boîtes aux lettres enregistrées

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    5
    Anonymous
    7 years ago
    use 
echo mb_convert_encoding($val, "utf-8", "UTF7-IMAP");
for cyrrilic folder names
    up
    2
    c6h1206free at gmail dot com
    17 years ago
    imap_list returns a simple array of strings that look just like the $ref parameter one needs to specify:

<?php

  $srv = '{imap.example.com}';

  $conn = imap_open($srv, 'me', 'mypass');

  $boxes = imap_list($conn, $srv, '*');

  print_r($boxes);
  imap_close($conn);
?>

Output:

<pre>
Array
(
    [0] => {imap.example.com}Calendar
    [1] => {imap.example.com}Contacts
    [2] => {imap.example.com}Deleted Items
    [3] => {imap.example.com}Drafts
    [4] => {imap.example.com}Journal
    [5] => {imap.example.com}Junk E-mail
    [6] => {imap.example.com}Notes
    [7] => {imap.example.com}Outbox
    [8] => {imap.example.com}RSS Feeds
    [9] => {imap.example.com}Sent Items  
    [10] => {imap.example.com}Tasks
)
</pre>

These directly fill in the $ref argument for every function that takes one.
    ＋add a note
    To Top