PHP - imap_fetchmime() 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_fetchmime() function accepts a resource value representing an IMAP stream, an integer value representing a message in the mailbox, a string value containing the part number(s) of a message, as parameters and, retrieves the MIME headers for a specified section of the message body.

Syntax

imap_fetchmime($imap_stream, $msg, $section[, $options]);

Parameters

options(Optional)

This is an optional parameter which can be one or more of the following −

FT_UID
FT_PEEK
FT_INTERNAL

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.
3	section(Mandatory) This is a string value representing the message numbers (separated by ".").

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

msg (Mandatory)

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

section(Mandatory)

This is a string value representing the message numbers (separated by ".").

Return Values

This function returns a string value containing the retrieved MIME headers.

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_fetchmime() 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("Mime Headers: "."<br>");
         $body = imap_fetchmime($imap, 1, 1);
         print_r($body);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

Following is an example of this function −

Connection established....
Mime Headers:
Content−Type: text/plain; charset="UTF-8"

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

Output

This will generate the following output −

Connection established....
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"
Content-Type: text/plain; charset="UTF-8"

Example

Following is another example of this function −

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>");
		 
         //Fetching the contents of a message
         print("Mime Headers: "."<br>");
         $body = imap_fetchmime($imap, imap_uid($imap, 1), 1, FT_UID);
         print_r($body);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Mime Headers:
Content-Type: text/plain; charset="UTF-8"

php_function_reference.htm