PHP 7.4.32 Released!


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

imap_statusDevuelve la información de estado de un buzón


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

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



IMAP stream devuelto por imap_open().


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


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.


Ejemplo #1 Ejemplo de imap_status()

      or die(
"no se pudo conectar: " imap_last_error());

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


add a note

User Contributed Notes 3 notes

jille at DIESPAMMERShexon dot cx
15 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..

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
mwwaygoo AT hotmail DOT com
10 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.

function my_imap_status($stream, $mailbox='', $info=SA_ALL)
// get current mailbox name (and info)
$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
//switch to new mailbox
if(!imap_reopen($stream, $mailbox)) return false;
// get info
// switch back to original mailbox
imap_reopen($stream, $current_mailbox);
//return info
return $obj;
razonklnbd at hotmail dot com
14 years ago
another tips is to get only total number of message and recent message

$imap_obj = imap_status($mbox, '{}INBOX', SA_MESSAGES+SA_RECENT);
echo('<pre>'); var_dump($imap_obj); echo('</pre>');
To Top