• PHP Video Tutorials

PHP - imap_mailboxmsginfo() 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_mailboxmsginfo() function accepts a resource value representing an IMAP stream and retrieves the information about the current mailbox and returns it as an object.

Syntax

imap_mailboxmsginfo($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 value representing the information about the current mailbox in case of success and returns a Boolean value FALSE in case of 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_mailboxmsginfo() 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 message info
         print("Message Info: "."<br>");
         $body = imap_mailboxmsginfo($imap,);
         print_r($body);
         
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message Info:
stdClass Object (
   [Unread] => 0 [Deleted] => 0 [Nmsgs] => 7 [Size] => 34132 
   [Date] => Wed, 28 Oct 2020 22:11:14 +0530 (India Standard Time) 
   [Driver] => imap 
   [Mailbox] => {imap.gmail.com:993/imap/notls/ssl/novalidate-cert/user="tutorialspoint.test@gmail.com"}INBOX 
   [Recent] => 0 
)

Example

Following is another example 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 message info
         print("Message Info: "."<br>");
         $info = imap_mailboxmsginfo($imap,);
         print( "Date: ". $info->Date . "<br />\n") ;
         print("Driver: ". $info->Driver . "<br />\n");
         print("Mailbox: ". $info->Mailbox . "<br />\n");
         print("Messages: ". $info->Nmsgs . "<br />\n");
         print("Recent: ". $info->Recent . "<br />\n");
         print("Unread: ". $info->Unread . "<br />\n");
         print("Deleted: ". $info->Deleted . "<br />\n");
         print("Size: ". $info->Size . "<br />\n");
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message Info:
Date: Wed, 28 Oct 2020 22:20:05 +0530 (India Standard Time)
Driver: imap
Mailbox: {imap.gmail.com:993/imap/notls/ssl/novalidate-cert/user="tutorialspoint.test@gmail.com"}INBOX
Messages: 7
Recent: 0
Unread: 0
Deleted: 0
Size: 34132
php_function_reference.htm
Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements