• PHP Video Tutorials

PHP - imap_clearflag_full() Function

PHP−IMAP functions helps you to access email accounts, IMAP stands for Internet Mail Access Protocol using these functions you can also work with NNTP, POP3 protocols and local mailbox access methods.

The imap_clearflag_full() function accepts a resource value representing an IMAP stream, two string values representing the sequence of message numbers and, flag as parameters and, removes the specified flags from the messages.

Syntax

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

Parameters

Sr.No Parameter & Description
1

imap_stream (Mandatory)

This is a string value representing an IMAP stream, return value of the imap_open() function.
2

sequence(Mandatory)

This is a string value representing the sequence of the message numbers. You can also specify an interval of the messages as 4:12.
3

flag(Mandatory)

This is a sting value representing the flag value to removed ("\\Seen", "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft").

4

Options(Optional)

This is an integer value representing an optional value ST_UID, if specified you need to pass UID’s instead of sequence numbers.

Return Values

This function returns a Boolean value which is TRUE in case of success and FALSE in case of a failure.

PHP Version

This function was first introduced in PHP Version 4 and works in all the later versions.

Example

<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>

Output

This will generate the following output −

Connection established....
Flags Cleared

Example

Following is an example of the above method with optional parameter −

<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>

Output

This will generate the following output −

Connection established....
Flags Cleared
php_function_reference.htm
Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements