• PHP Video Tutorials

PHP - imap_uid() 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_uid() function accepts a resource value representing an IMAP stream, an integer value representing a message in the mailbox as parameters and, returns the UID for the given message.

Syntax

imap_uid($imap_stream, $msg);

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

msg (Mandatory)

This is an integer value representing the message/mail number, that is to marked for deletion.

Return Values

This function returns an integer value representing the UID of the specified message.

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_uid() 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);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

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

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>");
         
         //Searching emails
         $emailData = imap_search($imap, '');
        
         if (! empty($emailData)) {  
            foreach ($emailData as $msg) {
               $id = imap_uid($imap, $msg);
               print("UID of message $msg: ");			   
               print($id);  
               print("<br>");						   
            }    
         } 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
UID of message 1: 19
UID of message 2: 20
UID of message 3: 42
UID of message 4: 49
UID of message 5: 50
UID of message 6: 51
UID of message 7: 52
php_function_reference.htm
Advertisements