• PHP Video Tutorials

PHP - imap_rfc822_parse_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_rfc822_parse_headers() function accepts two string values representing the address and the default host name as parameters and parses and returns the email headers form the given string.

Syntax

imap_rfc822_parse_headers($address [, $default_host]);

Parameters

Sr.No Parameter & Description
1

address (Mandatory)

This is a string value representing the addresses.
2

default_host (Optional)

This is a string value representing the default hostname.

Return Values

This function returns an object containing the header.

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_rfc822_parse_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>");
		  
         //Parsing a mail address	 
         print("Parsing mail address: "."<br>");
         $header = imap_fetchheader($imap, 1);
         $res = imap_rfc822_parse_headers($header);
         print_r($res);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Parsing mail address:
stdClass Object ( 
   [date] => Thu, 22 Oct 2020 20:10:17 +0530 
   [Date] => Thu, 22 Oct 2020 20:10:17 +0530 
   [subject] => [Subject] => [message_id] => 
   [toaddress] => tutorialspoint.test@gmail.com [to] => 
   Array ( 
      [0] => stdClass Object ( 
         [mailbox] => tutorialspoint.test [host] => gmail.com 
      ) 
   ) 
   [fromaddress] => Sender[from] => 
   Array ( 
      [0] => stdClass Object ( 
         [personal] => Sender[mailbox] => 
         sample.test[host] => gmail.com 
      ) 
   ) 
   [reply_toaddress] => Sender[reply_to] => 
   Array ( 
      [0] => stdClass Object ( 
         [personal] => Sender[mailbox] => 
         sample.test[host] => gmail.com 
      ) 
   ) 
   [senderaddress] => Sender[sender] => 
   Array ( 
      [0] => stdClass Object ( 
         [personal] => Sender[mailbox] => sample.test[host] => gmail.com 
      ) 
   ) 
)

Example

Following is an example of the above function with optional parameters −

<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>");
		  
         //Parsing a mail address	 
         print("Parsing mail address: "."<br>");
         $header = imap_fetchheader($imap, 1);
         $res = imap_rfc822_parse_headers($header, "default_header");
         print_r($res);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Parsing mail address:
stdClass Object ( [date] => Thu, 22 Oct 2020 20:10:17 +0530 [Date] => Thu, 
22 Oct 2020 20:10:17 +0530 [subject] => [Subject] => [message_id] => 
[toaddress] => tutorialspoint.test@gmail.com [to] => Array ( [0] => 
stdClass Object ( [mailbox] => tutorialspoint.test [host] => gmail.com ) ) 
[fromaddress] => Sender [from] => Array ( [0] => stdClass Object ( 
[personal] => Sender [mailbox] => sample.test[host] => gmail.com ) ) 
[reply_toaddress] => Sender [reply_to] => Array ( [0] => stdClass Object 
( [personal] => Sender [mailbox] => sample.test[host] => gmail.com ) ) 
[senderaddress] => Sender [sender] => Array ( [0] => stdClass Object ( 
[personal] => Sender [mailbox] => sample.test[host] => gmail.com ) ) )
php_function_reference.htm
Advertisements