Dutch PHP Conference 2019


(PHP 4, PHP 5, PHP 7)

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


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


Un flux IMAP retourné par la fonction imap_open().


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


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.


Exemple #1 Exemple avec imap_status()

      or die(
"Connexion impossible : " imap_last_error());

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


add a note add a note

User Contributed Notes 3 notes

jille at DIESPAMMERShexon dot cx
11 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
6 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
10 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>');
To Top