imap_status

(PHP 4, PHP 5)

imap_status — Devuelve la información de estado de un buzón

Descripción

object imap_status ( resource $imap_stream , string $mailbox , int $options )

Obtiene la información de estado sobre el buzón dado por mailbox.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

mailbox

El nombre del buzón, véase imap_open() para más información

options

Las banderas válidas son:

SA_MESSAGES - establece $estado->messages al número de mensajes del buzón
SA_RECENT - establece $estado->recent al número de mensajes recientes del buzón
SA_UNSEEN - establece $estado->unseen al número de mensajes no vistos (nuevos) del buzón
SA_UIDNEXT - establece $estado->uidnext al siguiente uid a usar del buzón
SA_UIDVALIDITY - establece $estado->uidvalidity a la constante que cambia cuando los uids para el buzón ya no pueden ser válidos
SA_ALL - establece todo lo anterior

Valores devueltos

Esta función devuelve un objeto que contiene la infomación de estado. El objeto tiene las siguientes propiedades: messages, recent, unseen, uidnext, y uidvalidity.

flags también está establecido, contiene una máscara de bits que puede ser comprobada con cualquiera de las contastes de arriba.

Ejemplos

Ejemplo #1 Ejemplo de imap_status()


<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
      or die("no se pudo conectar: " . imap_last_error());

$estado = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($estado) {
  echo "Mensajes:    " . $estado->messages    . "<br />\n";
  echo "Recientes:   " . $estado->recent      . "<br />\n";
  echo "No vistos:   " . $estado->unseen      . "<br />\n";
  echo "SiguienteUID:" . $estado->uidnext     . "<br />\n";
  echo "ValidezUID:  " . $estado->uidvalidity . "<br />\n";
} else {
  echo "imap_status failed: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

imap_subscribe

imap_sort

[edit] Last updated: Fri, 17 May 2013

add a note User Contributed Notes imap_status - [3 notes]

down

jille at DIESPAMMERShexon dot cx ¶

6 years ago


In 'reply' to my previous post;

I`m not sure of that anymore

I think this trick works,

but the rest of my script just sucks..



Conclusion:

You can get the last UID by using status->uidnext-1

BUT: This is not a good way, if another message is added after your append and before your status; you are screwed

down

mwwaygoo AT hotmail DOT com ¶

10 months 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;

    }

?>

down

razonklnbd at hotmail dot com ¶

5 years ago


another tips is to get only total number of message and recent message



$imap_obj = imap_status($mbox, '{mail.mysrv.com:143/imap}INBOX', SA_MESSAGES+SA_RECENT);

echo('<pre>'); var_dump($imap_obj); echo('</pre>');

add a note