array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.imap-list.php', 1 => 'imap_list', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Funções', ), 'prev' => array ( 0 => 'function.imap-last-error.php', 1 => 'imap_last_error', ), 'next' => array ( 0 => 'function.imap-listmailbox.php', 1 => 'imap_listmailbox', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/imap/functions/imap-list.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_list — Read the list of mailboxes
Read the list of mailboxes.
imap
Uma instância de IMAP\Connection.
reference
reference
should normally be just the server
specification as described in imap_open().
Passar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.
pattern
Especifica onde iniciar a pesquisa na hierarquia da caixa de mensagem.
Existem dois caracteres especiais que podem
ser passados como parte do parâmetro pattern
:
'*
' e '%
'.
'*
' significa retornar todas as caixas de mensagem. Se
pattern
for passado como '*
', será retornada
uma lista de toda a hierarquia da caixa de mensagem.
'%
'
significa retornar apenas o nível atual.
Passar '%
' como o parâmetro pattern
retornará apenas as caixas de mensagem do nível
mais alto; Passar '~/mail/%
' em UW_IMAPD
retornará todas as caixas de mensagem no diretório ~/mail, mas não retornará nenhuma nas subpastas deste diretório.
Returns an array containing the names of the mailboxes or false
in case of failure.
Versão | Descrição |
---|---|
8.1.0 |
O parâmetro imap agora espera uma instância de IMAP\Connection;
anteriormente, um resource imap válido era esperado.
|
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);
?>