International PHP Conference 2015

imap_getmailboxes

(PHP 4, PHP 5)

imap_getmailboxesRead the list of mailboxes, returning detailed information on each one

Descrizione

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

Gets information on the mailboxes.

Elenco dei parametri

imap_stream

Uno stream IMAP restituito da imap_open().

ref

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

pattern

Specifica da dove, nella gerarchia della mailbox, cominciare a cercare.

Ci sono due caratteri speciali che si possono passare all'interno di pattern: '*' e '%'. '*' restituisce tutte le mailbox. Se si passa '*' in pattern, verrĂ  restituito un elenco du tutta le gerarchia della mailbox. '%' corrisponde al solo livello attuale. '%' nel parametro pattern restituirĂ  solo le mailbox del livello superiore; '~/mail/%' in UW_IMAPD restituirĂ  ogni mailbox nella cartella ~/mail, ma non quelle nelle sue sottocartelle.

Valori restituiti

Returns an array of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:

  • LATT_NOINFERIORS - This mailbox contains, and may not contain any "children" (there are no mailboxes below this one). Calling imap_createmailbox() will not work on this mailbox.

  • LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it.

  • LATT_MARKED - This mailbox is marked. This means that it may contain new messages since the last time it was checked. Not provided by all IMAP servers.

  • LATT_UNMARKED - This mailbox is not marked, does not contain new messages. If either MARKED or UNMARKED is provided, you can assume the IMAP server supports this feature for this mailbox.

Esempi

Example #1 imap_getmailboxes() example

<?php
$mbox 
imap_open("{imap.example.org}""username""password"OP_HALFOPEN)
      or die(
"can't connect: " imap_last_error());

$list imap_getmailboxes($mbox"{imap.example.org}""*");
if (
is_array($list)) {
    foreach (
$list as $key => $val) {
        echo 
"($key) ";
        echo 
imap_utf7_decode($val->name) . ",";
        echo 
"'" $val->delimiter "',";
        echo 
$val->attributes "<br />\n";
    }
} else {
    echo 
"imap_getmailboxes failed: " imap_last_error() . "\n";
}

imap_close($mbox);
?>

Vedere anche:

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top