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 = "[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>

输出

此程序生成以下输出：

Connection established....
Mailbox deleted successfully

示例

以下是此函数的另一个示例：

<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>

输出

此程序生成以下输出：

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

打印页面