PHP - Fonction imap_deletemailbox ()

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_deletemailbox() accepte une valeur de ressource représentant un flux IMAP, une valeur de chaîne représentant l'url / le nom de la boîte aux lettres et supprime la boîte aux lettres spécifiée.

Syntaxe

imap_deletemailbox($imap_stream, $mailbox);

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.

Valeurs de retour

Cette fonction renvoie une valeur booléenne qui est TRUE en cas de succès et 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_deletemailbox() 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
         $newmailbox = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.testmailbox";
         $res = imap_deletemailbox($mailbox, $newmailbox);
         if($res){
            print("Mailbox deleted successfully");
         } else {
            print("Error occurred");
         }		 
      ?>
   </body>
</html>

Production

Ce programme génère la sortie suivante -

Connection established....
Mailbox deleted successfully

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 mailboxes
         $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
         print("List of mailboxes: ");
         print("<br>");
         $list = imap_getmailboxes($mailbox, $url, "*");
         
         foreach ($list as $key => $val) {
           print_r($val->name);
           print("<br>");
         }	 
         //Deleting a mailbox
         imap_deletemailbox($mailbox, $newmailbox1);		 
         
         //Retrieving the contents of mail boxes
         print("<br>");
         print("List of mailboxes after deletion: ");
         print("<br>");
         $list = imap_getmailboxes($mailbox, $url, "*");
         
         foreach ($list as $key => $val) {
            print_r($val->name);
            print("<br>");
         }		 
      ?>
   </body>
</html>

Production

Ce programme génère la sortie suivante -

Connection established....
List of mailboxes:
{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

List of mailboxes after deletion:
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2