PHP - Fonction imap_status ()

Les fonctions PHP-IMAP vous aident à accéder aux comptes de messagerie, IMAP signifie IInternet Mail Aaccès Protocol en utilisant ces fonctions, vous pouvez également travailler avec les protocoles NNTP, POP3 et les méthodes d'accès aux boîtes aux lettres locales.

le imap_status() accepte une valeur de ressource représentant un flux IMAP, une valeur de chaîne représentant l'url / nom de la boîte aux lettres et un entier représentant la valeur facultative en tant que paramètre, récupère et retourne l'état de la boîte aux lettres donnée.

Syntaxe

imap_status($imap_stream, $mailbox, $options);

Paramètres

Sr. Non Paramètre et description
1

imap_stream (Mandatory)

Il s'agit d'une valeur de chaîne représentant un flux IMAP, valeur de retour du imap_open() fonction.
2

mailbox(Mandatory)

Il s'agit d'une valeur de chaîne représentant le nom / l'URL de la boîte aux lettres. Il contient le nom du serveur, le chemin de la boîte aux lettres.
3

options (Mandatory)

Il s'agit d'une valeur entière représentant le paramètre facultatif qui peut être l'un des suivants:

  • SA_MESSAGES

  • SA_RECENT

  • SA_UNSEEN

  • SA_UIDNEXT

  • SA_UIDVALIDITY _subscribed

  • SA_ALL

Valeurs de retour

Cette fonction renvoie un objet qui contient les informations d'état de la boîte aux lettres donnée.

Version PHP

Cette fonction a été introduite pour la première fois dans la version 4 de PHP et fonctionne dans toutes les versions ultérieures.

Exemple

L'exemple suivant montre l'utilisation du imap_status() fonction -

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
         
         //Status info of the mailbox
         $info = imap_status($imap, $url, SA_ALL);
         print_r($info);
		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Production

Cela générera la sortie suivante -

Connection established....
stdClass Object ( 
   [flags] => 31 [messages] => 12 [recent] => 0 
   [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 
)

Exemple

Voici un autre exemple de la fonction ci-dessus -

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
         
         //Status info of the mailbox
         print_r(imap_status($imap, $url, SA_MESSAGES));
         print("<br>");
         print_r(imap_status($imap, $url, SA_RECENT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UNSEEN));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDNEXT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDVALIDITY));
         print("<br>");
         print_r(imap_status($imap, $url, SA_ALL));
		   
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Production

Cela générera la sortie suivante -

Connection established....
stdClass Object ( [flags] => 1 [messages] => 12 )
stdClass Object ( [flags] => 2 [recent] => 0 )
stdClass Object ( [flags] => 4 [unseen] => 2 )
stdClass Object ( [flags] => 8 [uidnext] => 61 )
stdClass Object ( [flags] => 16 [uidvalidity] => 1 )
stdClass Object ( [flags] => 31 [messages] => 12 [recent] => 0 [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 )