imap_status

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

    imap_status — Retorna informações de status sobre uma caixa de correio

    Descrição

    imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false

    Obtém informações de status sobre a caixa de correio informada em mailbox.

    Parâmetros

    imap

    Uma instância de IMAP\Connection.

    mailbox

    O nome da caixa de correio, veja imap_open() para mais informações

    Aviso

    Passar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.

    flags

    As opções válidas são:

    • SA_MESSAGES - define $status->messages para o número de mensagens na caixa de correio
    • SA_RECENT - define $status->recent para o número de mensagens recentes na caixa de correio
    • SA_UNSEEN - define $status->unseen para o número de mensagens não vistas (novas) na caixa de correio
    • SA_UIDNEXT - define $status->uidnext para o próximo UID a ser usado na caixa de correio
    • SA_UIDVALIDITY - define $status->uidvalidity para uma constante que altera quando os UIDs para a caixa de correio podem não mais ser válidos
    • SA_ALL - define todas as opções acima

    Valor Retornado

    Esta função retorna um objeto contendo informações de status, ou false em caso de falha. O objeto tem as seguintes propriedades: messages, recent, unseen, uidnext e uidvalidity.

    flags também é definido, o qual contém uma máscara de bits que pode ser verificada em relação a qualquer uma das constantes acima.

    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_status()

    <?php
    $mbox     = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
    or die(    "Não foi possível conectar: " . imap_last_error());

    $status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
    if (    $status) {
    echo     "Mensagens: " . $status->messages . "<br />\n";
    echo     "Recentes: " . $status->recent . "<br />\n";
    echo     "Não vistas: " . $status->unseen . "<br />\n";
    echo     "Próximo UID: " . $status->uidnext . "<br />\n";
    echo     "Validade do UID: " . $status->uidvalidity . "<br />\n";
    } else {
    echo     "imap_status falhou: " . imap_last_error() . "\n";
    }

    imap_close($mbox);
    ?>

    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) 1 note

    up
    2
    mwwaygoo AT hotmail DOT com
    12 years ago
    I had issues with imap_status not working correctly, while other imap functions seemed okay. I always got the ['flags']=0 response. No notes here and Google searching suggests it doesn't working properly with Exchange, so I wrote a little workaround, to at least get some information.

    <?php
    function my_imap_status($stream, $mailbox='', $info=SA_ALL)
    {
    // get current mailbox name (and info)
    $curr_obj=imap_check($stream);
    if(!    $curr_obj) return false;

    // if request if for current mailbox then just return it
    if( (empty($mailbox)) || ($mailbox==$curr_obj->Mailbox) ) return $curr_obj;

    // get current mailbox
    $current_mailbox=$curr_obj->Mailbox;

    //switch to new mailbox
    if(!imap_reopen($stream, $mailbox)) return false;

    // get info
    $obj=imap_check($stream);

    // switch back to original mailbox
    imap_reopen($stream, $current_mailbox);

    //return info
    return $obj;
    }
    ?>
    ＋adicione uma nota
    To Top