PHP - imap_ping() Function

PHP−IMAP functions helps you to access an 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_ping() function accepts a resource value representing an IMAP stream as a parameter and verifies if the given stream is still active.

Syntax

imap_ping($imap_stream);

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.

Return Values

This function returns a Boolean value if the given stream is still live and FALSE if not.

PHP Version

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

Example

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

<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>");
		   
         //list of mailboxes
         $res = imap_ping($imap);
	      
         if($res){
            print("IMAP stream is alive");		 
         } else {
            print("IMAP stream is not alive");		 
         }
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
IMAP stream is alive

Example

Following is another example of this function −

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");

         if (imap_ping($mailbox)) {
            //Retrieving the contents of mail boxes
            $list = imap_getmailboxes($mailbox, $url, "*");
            if (is_array($list)) {
              foreach ($list as $key => $val) {
                  print_r($val);
                  print("<br>");
               }
            }else{  }
         }
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....stdClass Object ( [name] => 
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX [attributes] => 64 
[delimiter] => / )
stdClass Object ( [name] => 
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail1 [attributes] =
> 64 [delimiter] => / )
stdClass Object ( [name] => 
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail2 [attributes] =
> 64 [delimiter] => / )

php_function_reference.htm