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 = "tutorialspoint.test@gmail.com";
         $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 = "tutorialspoint.test@gmail.com";
         $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
廣告