PHP - imap_gc() Function

Quiz

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_gc() function accepts a resource value representing an IMAP stream, an integer value representing a cache and, purges/clears the specified cache.

Syntax

imap_gc($imap_stream, $chaches);

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	caches (Mandatory) This is an integer value representing the cache to purge. It can be the combination of the following constants: IMAP_GC_ELT (message cache elements), IMAP_GC_ENV (envelope and bodies), IMAP_GC_TEXTS (texts).

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

caches (Mandatory)

This is an integer value representing the cache to purge. It can be the combination of the following constants: IMAP_GC_ELT (message cache elements), IMAP_GC_ENV (envelope and bodies), IMAP_GC_TEXTS (texts).

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 5 and works in all the later versions.

Example

Following example demonstrates the usage of the imap_gc() function −

<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>");
         //Clearing the cache
         $res = imap_gc($imap, IMAP_GC_TEXTS);
         
         if($res){
            print("Cache Cleared");
         }else{
            print("Error Occurred");
         }
		   //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Cache Cleared

Example

Following example clears the cache regarding envelope and bodies −

<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>");
         //Clearing the cache
         $res = imap_gc($imap, IMAP_GC_ENV);         

         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....

php_function_reference.htm

Print Page