PHP - imap_deletemailbox() 函式

PHP 的 IMAP 函式幫助您訪問電子郵件帳戶，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用這些函式您還可以使用 NNTP、POP3 協議和本地郵箱訪問方法。

**imap_deletemailbox()** 函式接受一個代表 IMAP 流的資源值和一個代表郵箱 URL/名稱的字串值，並刪除指定的郵箱。

語法

imap_deletemailbox($imap_stream, $mailbox);

引數

序號	引數和描述
1	imap_stream (必填) 這是一個字串值，代表 IMAP 流，是 imap_open() 函式的返回值。
2	mailbox (必填) 這是一個字串值，代表郵箱的名稱/URL。它包含伺服器名稱和郵箱路徑。

序號

引數和描述

imap_stream (必填)

這是一個字串值，代表 IMAP 流，是 **imap_open()** 函式的返回值。

mailbox (必填)

這是一個字串值，代表郵箱的名稱/URL。它包含伺服器名稱和郵箱路徑。

返回值

此函式返回一個布林值，成功時為 TRUE，失敗時為 FALSE。

PHP 版本

此函式首次在 PHP 4 版本中引入，並在所有後續版本中均有效。

示例

以下示例演示了 **imap_deletemailbox()** 函式的用法：

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $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>

輸出

此程式生成以下輸出：

Connection established....
Mailbox deleted successfully

示例

以下是此函式的另一個示例：

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $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>

輸出

此程式生成以下輸出：

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

php_function_reference.htm

列印頁面