Submit a Pull Request Report a Bug

    imap_list

    (PHP 4, PHP 5, PHP 7)

    imap_list — Read the list of mailboxes

    Opis

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

    Read the list of mailboxes.

    Parametry

    imap_stream

    Strumień IMAP zwrócony przez imap_open().

    ref

    ref should normally be just the server specification as described in imap_open().

    Ostrzeżenie

    Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

    pattern

    Określa gdzie w hierarchii skrzynki rozpocząć wyszukiwanie.

    Istnieją dwa specjalne znaki, które możesz przekazać jako część argumentu pattern: '*' i '%'. '*' oznacza zwrócenie wszystkich skrzynek. Jeżeli jako argument pattern ustawiony na '*' zwróci pełną hierarchię skrzynki mailowej. '%' oznacza zwrócenie tylko obecnego poziomu. '%' jako parametr pattern zwróci tylko skrzynki mailowe najwyższego poziomu; '~/mail/%' na UW_IMAPD zwróci każdą skrzynkę w katalogu ~/mail, ale nie w jego podkatalogach.

    Zwracane wartości

    Returns an array containing the names of the mailboxes or false in case of failure.

    Przykłady

    Przykład #1 imap_list() example

    <?php
    $mbox     = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
          or die(    "can't connect: " . 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 failed: " . imap_last_error() . "\n";
    }

    imap_close($mbox);
    ?>

    Zobacz też:

    add a note add a note

    User Contributed Notes 5 notes

    up
    2
    Anonymous
    5 years ago
    use
    echo mb_convert_encoding($val, "utf-8", "UTF7-IMAP");
    for cyrrilic folder names
    up
    2
    jemore at free dot fr
    10 years ago
    With the values returned from the imap_list function, you can search a message in the folder, but you have to use the imap_reopen function before . Continuing the previous example (from c6h1206free at gmail dot com )

    <?php
      $srv     = '{imap.example.com}';
          $conn = imap_open($srv, 'me', 'mypass');
          $boxes = imap_list($conn, $srv, '*');
      foreach(    $boxes as $box)
      {
            imap_reopen($srv, $box);
            var_dump(imap_search($srv, "ALL"));
      }
          imap_close($conn);
    ?>
    up
    2
    maxime dot marais+php at gmail dot com
    5 years ago
    Please be aware that if you are trying to list an empty mailbox, imap_list will return FALSE as if there was an error instead of an empty array() as one may expect.

    Example:

    With a brand new account created on your mail server, with an empty INBOX, you will get:

    $list = imap_list( $imap_stream, $ref, "INBOX/*");
    var_dump( $list );
    // bool(false)
    up
    1
    c6h1206free at gmail dot com
    15 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.
    up
    0
    kevin at metalaxe dot com
    16 years ago
    if there is an error imap_list returns FALSE not an empty array (as expected by docs)
    add a note add a note
    To Top