PHP - imap_check() 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_check() function accepts a resource value representing an IMAP stream as a parameter, verifies the information about the given mail box and returns it in the form of an object.

Syntax

imap_check($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 an object which contains the information about the current mailbox, in case of success and a Boolean value which is 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

Following example demonstrates the usage of the imap_check() 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>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $obj = imap_check($imap);
         print("<br>");	
         print("Date :".$obj->Date);
         print("<br>");		
         print("Driver: ".$obj−>Driver);
         print("<br>");	
         print("Mailbox: ".$obj−>Mailbox);
         print("<br>");		
         print("Nmsgs: ".$obj−>Nmsgs);
         print("<br>");		
         print("Recent: ".$obj−>Recent);
         print("<br>");

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

This will generate the following output −

Connection established....
Overview of the first message:

Date :Mon, 26 Oct 2020 11:38:26 +0530 (India Standard Time)
Driver: imap
Mailbox: {imap.gmail.com:993/imap/notls/ssl/novalidate-cert/user="tutorialspoint.test@gmail.com"}INBOX
Nmsgs: 6
Recent: 0

Example

Following is another of this 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>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $MC = imap_check($imap);
         $overview = imap_fetch_overview($imap, "1:{$MC->Nmsgs}");
         foreach ($overview as $obj) {
            print("<br>");	
            print_r($obj);
            print("<br>");			
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Overview of the first message:

stdClass Object (
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Thu, 22 Oct 2020 20:10:17 +0530 
   [message_id] => [size] => 4857 [uid] => 19 
   [msgno] => 1 [recent] => 0 [flagged] => 0 
   [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603377656 
)
stdClass Object ( 
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Thu, 22 Oct 2020 20:10:52 +0530 
   [message_id] => [size] => 4858 [uid] => 20 
   [msgno] => 2 [recent] => 0 [flagged] => 0 
   [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603377691 
)
stdClass Object ( 
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Sun, 25 Oct 2020 16:11:22 +0530 [message_id] => 
   [size] => 4880 [uid] => 42 [msgno] => 3 [recent] => 0 
   [flagged] => 0 [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603622523 
)
stdClass Object ( 
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Sun, 25 Oct 2020 17:22:41 +0530 [message_id] => 
   [size] => 4882 [uid] => 49 [msgno] => 4 [recent] => 0 
   [flagged] => 0 [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603626802 
)
stdClass Object ( 
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Sun, 25 Oct 2020 17:23:10 +0530 [message_id] => 
   [size] => 4884 [uid] => 50 [msgno] => 5 [recent] => 0 
   [flagged] => 0 [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603626831 
)
stdClass Object ( 
   [from] => Sender[to] => tutorialspoint.test@gmail.com 
   [date] => Sun, 25 Oct 2020 17:24:25 +0530 [message_id] => 
   [size] => 4883 [uid] => 51 [msgno] => 6 [recent] => 0 
   [flagged] => 0 [answered] => 0 [deleted] => 0 [seen] => 1 
   [draft] => 0 [udate] => 1603626906 
)

php_function_reference.htm