Fonction PHP - imap_list ()

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_list() La fonction accepte une valeur de ressource représentant un flux IMAP, deux valeurs de chaîne représentant la spécification du serveur et la hiérarchie de boîtes aux lettres comme paramètres et lit la liste des boîtes aux lettres spécifiées.

Syntaxe

imap_list($imap_stream, $ref, $pattern);

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

ref (Mandatory)

Il s'agit d'une valeur de chaîne représentant la spécification du serveur.
3

pattern (Mandatory)

Il s'agit d'une valeur de chaîne représentant le début de la recherche dans la hiérarchie de boîtes aux lettres.

Valeurs de retour

Cette fonction renvoie un tableau qui contient les noms des boîtes aux lettres en cas de succès, et renvoie une valeur booléenne FALSE en cas d'échec.

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_list() 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>");
		 
         //list of mailboxes
         $res = imap_list($imap, $url, "*");
         print_r($res);		 

         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Production

Cela générera la sortie suivante -

Connection established....
Array ( 
   [0] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX [1] => 
   {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1 [2] => 
   {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2 [3] => 
   {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail3 [4] => 
)

Exemple

Voici un autre exemple de cette fonction -

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2";   
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox1));
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox2));		 
		 
         //Retrieving the contents of mail boxes
         $list = imap_list($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val);
            print("<br>");
         }	 
      ?>
   </body>
</html>

Production

Cela générera la sortie suivante -

Connection established....
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2