PHP - imap_delete() 函数

上一个
下一个

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

imap_delete() 函数接受表示 IMAP 流的资源值、表示邮箱中邮件的整数作为参数，并将指定的邮件标记为删除。

使用此函数标记所需的邮件后，每当调用 imap_expunge() 函数或使用 CL_EXPLUNGE 作为参数调用 close() 函数时，它们将从邮箱中删除。

语法

imap_delete($imap_stream, $msg [, $options]);

参数

序号 参数和描述
1

imap_stream (必填)

这是一个字符串值，表示 IMAP 流，是 imap_open() 函数的返回值。
2

msg (必填)

这是一个整数，表示要标记为删除的邮件/邮件编号。
3

options(可选)

这是一个整数值，表示一个可选值 FT_UID，如果指定，则作为 msg 参数传递的值将被视为 UID。

返回值

此函数返回一个布尔值，如果成功则为 TRUE，如果失败则为 FALSE。

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

示例

以下是带可选参数的上述函数的示例 −

<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, imap_uid($imap, 5), FT_UID );
         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
php_function_reference.htm
打印页面
上一个
下一个
广告