PHP - imap_headers() 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_headers() function accepts a resource value representing an IMAP stream as a parameter, retrieves and returns headers for all the messages in the specified mailbox.

Syntax

imap_headers($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 array of strings where each string contains header info.

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_headers() 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 headers of all messages		 
         print("Headers of all messages: "."<br>");
         $res = imap_headers($imap);		 
         foreach ($res as $msg) {
            print($msg);
            print("<br>");     
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Headers of all messages:
1)22-Oct-2020 Sender1 (4857 chars)
U 2)22-Oct-2020 Sender1 (4858 chars)
3)25-Oct-2020 Sender2 (4880 chars)
4)25-Oct-2020 Sender 2 (4882 chars)
U 5)25-Oct-2020 Sender 3 (4884 chars)
6)25-Oct-2020 Sender 3 (4883 chars)
7)26-Oct-2020 Sender 3 (4888 chars)

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 headers of all messages		 
         print("Headers of all messages: "."<br>");
         $res = imap_headers($imap);	
         print_r($res);		     
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Headers of all messages:
Array ( 
   [0] => 1
)
22-Oct-2020 KrishnaKasyap Bhagav (4857 chars) 
[1] => U 2)22-Oct-2020 KrishnaKasyap Bhagav (4858 chars) 
[2] => 3)25-Oct-2020 KrishnaKasyap Bhagav (4880 chars) 
[3] => 4)25-Oct-2020 KrishnaKasyap Bhagav (4882 chars) 
[4] => U 5))

php_function_reference.htm

Kickstart Your Career

Get certified by completing the course

Get Started