imap_status

(PHP 4, PHP 5)

imap_statusRetourne les informations de statut sur une bo�te aux lettres

Description

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

Retourne les informations de statut sur la bo�te aux lettres mailbox .

Liste de param�tres

imap_stream

Un flux IMPA retourn� par la fonction imap_open().

mailbox

Le nom de la bo�te aux lettres, voir la documentation de la fonction imap_open() pour plus de d�tails

options

Les drapeaux valides sont :

  • SA_MESSAGES - met la valeur de $status->messages au nombre de messages dans la bo�te aux lettres.
  • SA_RECENT - met la valeur de $status->recent au nombre de messages r�cents dans la bo�te aux lettres.
  • SA_UNSEEN - met la valeur de $status->unseen au nombre de messages non lus dans la bo�te aux lettres.
  • SA_UIDNEXT - met la valeur de $status->uidnext � la prochaine valeur d'uid qui sera utilis�e.
  • SA_UIDVALIDITY - met la valeur de $status->uidvalidity � une constante, qui change lorsque l'uid de la bo�te aux lettres n'est plus valide.
  • SA_ALL - fixe toutes les valeurs pr�c�dentes.

Valeurs de retour

Cette fonction retourne un objet contenant les informations sur le statut. L'objet a les propri�t�s suivantes : messages, recent, unseen, uidnext, et uidvalidity.

flags est �galement d�fini, qui contient un masque contenant une des constantes ci-dessus.

Exemples

Exemple #1 Exemple avec imap_status()

<?php
$mbox 
imap_open("{imap.example.com}""username""password"OP_HALFOPEN)
      or die(
"Connexion impossible : " imap_last_error());

$status imap_status($mbox"{imap.example.org}INBOX"SA_ALL);
if (
$status) {
  echo 
"Messages :   " $status->messages    "<br />\n";
  echo 
"R�cent :     " $status->recent      "<br />\n";
  echo 
"Non lu :     " $status->unseen      "<br />\n";
  echo 
"Prochain UID:    " $status->uidnext     "<br />\n";
  echo 
"Validit� de l'UID:" $status->uidvalidity "<br />\n";
} else {
  echo 
"imap_status a �chou� : " imap_last_error() . "\n";
}

imap_close($mbox);
?>