imap_status

(PHP 4, PHP 5)

imap_status — Retourne 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 1216. 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 );
?>