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

Descripción

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

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);
?>