PHP - imap_status() 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_status() function accepts a resource value representing an IMAP stream, a string value representing the url/name of the mailbox and an integer representing the optional value as a parameter, retrieves and returns the status of the given mailbox.

Syntax

imap_status($imap_stream, $mailbox, $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	mailbox(Mandatory) This is a string value representing the name/URL of the mailbox. It contains the server name, mailbox path.
3	options (Mandatory) This is an integer value representing the optional parameter which can be one of the following: SA_MESSAGES SA_RECENT SA_UNSEEN SA_UIDNEXT SA_UIDVALIDITY _subscribed SA_ALL

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

mailbox(Mandatory)

This is a string value representing the name/URL of the mailbox. It contains the server name, mailbox path.

options (Mandatory)

This is an integer value representing the optional parameter which can be one of the following:

SA_MESSAGES
SA_RECENT
SA_UNSEEN
SA_UIDNEXT
SA_UIDVALIDITY _subscribed
SA_ALL

Return Values

This function returns an object which holds the status information of the given mailbox.

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_status() 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>");
         
         //Status info of the mailbox
         $info = imap_status($imap, $url, SA_ALL);
         print_r($info);
		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
stdClass Object ( 
   [flags] => 31 [messages] => 12 [recent] => 0 
   [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 
)

Example

Following is another example of the above 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>");
         
         //Status info of the mailbox
         print_r(imap_status($imap, $url, SA_MESSAGES));
         print("<br>");
         print_r(imap_status($imap, $url, SA_RECENT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UNSEEN));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDNEXT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDVALIDITY));
         print("<br>");
         print_r(imap_status($imap, $url, SA_ALL));
		   
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
stdClass Object ( [flags] => 1 [messages] => 12 )
stdClass Object ( [flags] => 2 [recent] => 0 )
stdClass Object ( [flags] => 4 [unseen] => 2 )
stdClass Object ( [flags] => 8 [uidnext] => 61 )
stdClass Object ( [flags] => 16 [uidvalidity] => 1 )
stdClass Object ( [flags] => 31 [messages] => 12 [recent] => 0 [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 )

php_function_reference.htm