imap_list

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

    imap_list — Lê 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

    Melhore Esta Página

    Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema
    ＋adicione uma nota

    Notas Enviadas por Usuários (em inglês) 2 notes

    up
    5
    Anonymous
    6 years ago
    use
    echo mb_convert_encoding($val, "utf-8", "UTF7-IMAP");
    for cyrrilic folder names
    up
    2
    c6h1206free at gmail dot com
    16 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.
    ＋adicione uma nota
    To Top