PHP - imap_setflag_full() 函数

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

**imap_setflag_full()** 函数接收表示 IMAP 流的资源值、表示消息编号序列的两个字符串值和标志作为参数，并在给定的消息上设置指定的标志。

语法

imap_setflag_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 版本中，并在所有后续版本中可用。

示例

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

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

输出

这将生成以下输出：

Connection established....
Messages Were Flagged

示例

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

<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>");
             
         $list = imap_uid($imap, 2)."".imap_uid($imap, 5);		 
         $res = imap_setflag_full($imap, $list, "\\Seen \\Flagged", ST_UID);
         print("Messages Were Flagged");   
		   
         //Closing the connection
         imap_close($imap);   		 
      
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Messages Were Flagged

php_function_reference.htm

打印页面