imap_list

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_listLê a lista de caixas de correio

Descrição

imap_list(IMAP\Connection $imap, string $reference, string $pattern): array|false

Lê a lista de caixas de correio.

Parâmetros

imap

Uma instância de IMAP\Connection.

reference

reference normalmente deve ser apenas a especificação do servidor conforme descrito em imap_open().

Aviso

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.

Valor Retornado

Retorna um array contendo os nomes das caixas de correio ou false em caso de falha.

Registro de Alterações

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.

Exemplos

Exemplo #1 Exemplo de imap_list()

<?php
$mbox
= imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die(
"Não foi possível conectar: " . 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 falhou: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

Veja Também

  • imap_getmailboxes() - Lê a lista de caixas de correio, retornando informações detalhadas sobre cada uma delas
  • imap_lsub() - Lista todas as caixas de correio assinadas