PHP - imap_expunge() 函数

PHP 的 IMAP 函数可以帮助您访问电子邮件帐户，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用这些函数您还可以处理 NNTP、POP3 协议和本地邮箱访问方法。

您可以使用 imap_delete()、imap_mail_move() 或 imap_setflag_full() 函数中的任何一个来标记特定邮箱中的邮件/消息以供删除。

**imap_expunge()** 函数接受表示 IMAP 流的资源值作为参数，并删除所有标记为要删除的消息。

语法

imap_expunge($imap_stream);

参数

序号	参数 & 描述
1	imap_stream (必填) 这是一个字符串值，表示 IMAP 流，是 imap_open() 函数的返回值。

返回值

此函数返回布尔值 TRUE。

PHP 版本

此函数首次引入于 PHP 4 版本，并在所有后续版本中有效。

示例

以下示例演示了 **imap_delete()** 函数的用法：

<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>");
		 		 
         //Marking message for deletion
         $res = imap_delete($imap, 5);
         if($res){
            print("Message marked for deletion"."<br>");
         }		 
         //Deleting messages
         $res = imap_expunge($imap);	 	
         if($res){
            print("Message deleted");
         }		 		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Message marked for deletion
Message deleted

示例

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

<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>");
         print("Contents  of inbox: "."<br>");
         $emailData = imap_search($imap, '');
         foreach ($emailData as $msg) {
            $msg = imap_fetchbody($imap, $msg, "1");
            print(quoted_printable_decode($msg)."<br>");                
         }    
         //Marking message for deletion
         imap_delete($imap, 5);
         
         //Deleting messages
         imap_expunge($imap);	 		 
		 
         print("Contents of inbox after deletion: "."<br>");
         $emailData = imap_search($imap, '');
         foreach ($emailData as $msg) {
            $msg = imap_fetchbody($imap, $msg, "1");
            print(quoted_printable_decode($msg)."<br>");                
         }    
		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Contents of inbox:
#sample_mail1
#sample_mail2
#sample_mail3
#sample_mail4
#sample_mail5
Contents of inbox after deletion:
#sample_mail1
#sample_mail2
#sample_mail3
#sample_mail4

php_function_reference.htm

打印页面