PHP imap_delete()用法及代码示例

PHP-IMAP 函数可帮助您访问电子邮件帐户，IMAP 代表I互联网M艾尔A访问权限Protocol 使用这些函数您还可以使用 NNTP、POP3 协议和本地邮箱访问方法。

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

一旦您使用此函数标记了所需的邮件，无论何时使用此函数，它们都会从邮箱中删除imap_expunge()被调用，或者，每当close()函数是使用 CL_EXPLUNGE 作为参数调用的。

用法

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

参数

Sr.No	参数及说明
1	imap_stream (Mandatory) 这是一个表示 IMAP 流的字符串值，返回值imap_open()函数。
2	msg (Mandatory) 这是一个表示消息/邮件编号的整数值，即标记为删除。
3	options(Optional) 这是一个表示可选值 FT_UID 的整数值，如果指定了作为 msg 参数传递的值被视为 UID。

Sr.No

参数及说明

imap_stream (Mandatory)

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

msg (Mandatory)

这是一个表示消息/邮件编号的整数值，即标记为删除。

options(Optional)

这是一个表示可选值 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 = "tutorialspoint.test@gmail.com";
         $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 = "tutorialspoint.test@gmail.com";
         $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 = "tutorialspoint.test@gmail.com";
         $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 - imap_delete() Function。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。