PHP - imap_clearflag_full() 函数



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

**imap_clearflag_full()** 函数接受一个表示 IMAP 流的资源值、两个表示邮件编号序列的字符串值以及标志作为参数,并从邮件中删除指定的标志。

语法

imap_clearflag_full($imap_stream, $sequence, $flag [, $options]);

参数

序号 参数及描述
1

imap_stream (必填)

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

2

sequence(必填)

这是一个表示邮件编号序列的字符串值。您还可以指定邮件的间隔,例如 4:12。

3

flag(必填)

这是一个表示要删除的标志值的字符串值("\\Seen","\\Answered","\\Flagged","\\Deleted" 和 "\\Draft")。

4

Options(可选)

这是一个表示可选值的整数类型,如果指定 ST_UID,则需要传递 UID 而不是序列号。

返回值

此函数返回一个布尔值,成功时为 TRUE,失败时为 FALSE。

PHP 版本

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

示例

<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>");
		 		 
         imap_setflag_full($imap, "2,5", "\\Seen \\Flagged"); 		 
         $res = imap_clearflag_full($imap, "2,5", "\\Seen \\Flagged" );
         if($res){
            print("Flags Cleared");
         } else {
            print("Error Occurred");
         }
         //Closing the connection
         imap_close($imap);  		 
      ?>
   </body>
</html>

输出

这将生成以下输出:

Connection established....
Flags Cleared

示例

以下是上述方法带可选参数的示例:

<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>");
		 		 
         imap_setflag_full($imap, "2,5", "\\Seen \\Flagged"); 		 
         $list = imap_uid($imap, 2)."".imap_uid($imap, 5);		 
         $res = imap_clearflag_full($imap, $list, "\\Seen \\Flagged", ST_UID);
         if($res){
            print("Flags Cleared");
         } else {
            print("Error Occurred");
         }
         //Closing the connection
         imap_close($imap);  		 
      ?>
   </body>
</html>

输出

这将生成以下输出:

Connection established....
Flags Cleared
php_function_reference.htm
广告