imap_list

(PHP 4, PHP 5)

imap_list — Lit la liste des boîtes aux lettres

Description

array imap_list ( resource $imap_stream , string $ref , string $pattern )

Lit la liste des boîtes aux lettres.

Liste de paramètres

imap_stream

Un flux IMAP retourné par la fonction imap_open().

ref

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

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.

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

add a note User Contributed Notes imap_list

c6h1206free at gmail dot com 16-Sep-2008 12:00


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.

kevin at metalaxe dot com 05-Jun-2007 02:13


if there is an error imap_list returns FALSE not an empty array (as expected by docs)

add a note