(PHP 4, PHP 5, PHP 7)
imap_list — Read the list of mailboxes
$imap_stream
, string $ref
, string $pattern
)Read the list of mailboxes.
imap_stream
Um stream IMAP retornado por imap_open().
ref
ref
should normally be just the server
specification as described in imap_open().
pattern
Especifica aonde na hierarquia da caixa de mensagens deve começar a procura.
Existem dois caracteres especiais que você
pode passar como parte para o pattern
:
'*' e '%'.
'*' significa retornar todas as caixas de mensagens. Se você passar
pattern
como '*', você terá
uma lista de toda a hierarquia da caixa de mensagens.
'%'
significa retornar o nível atual apenas.
'%' como o parâmetro pattern
ira retornar apenas as caixar de mensagem do nível superior;
'~/mail/%' em UW_IMAPD irá retornar cada caixa de mensagem no diretório ~/mail, mais nenhuma em subpastas deste diretório.
Returns an array containing the names of the mailboxes.
Exemplo #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);
?>