PHP - imap_msgno() 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_msgno() function accepts a resource value representing an IMAP stream, an integer value representing the UID of the message as parameters and retrieves the sequence number of the message responding to the given UID.

Syntax

imap_msgno($imap_stream, $uid);

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	uid (Mandatory) This is an integer value

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

uid (Mandatory)

This is an integer value

Return Values

This function returns an integer value representing the message sequence number.

PHP Version

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

Example

<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("UID of the 1st message: ");
         $UID = imap_uid($imap, 1);
         print($UID);
         print("<br>");

         //Retrieving the message number
         $msg = imap_msgno($imap, $UID);
         print($msg); 		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
UID of the 1st message: 19
1

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 contents of a message
         print("UID of the 1st message: ");
         $UID = imap_uid($imap, 1);
         print($UID);
         print("<br>");

         //Retrieving the message number
         $msg = imap_msgno($imap, $UID);
         print($msg);
		   
         $emailData = imap_search($imap, '');
         foreach ($emailData as $msg) {
            $msg = imap_msgno($imap, imap_uid($imap, $msg));
            print($msg);
            print("<br>");
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....
UID of the 1st message: 19
11
2
3
4
5
6
7

php_function_reference.htm