PHP - imap_body() 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_body() function accepts a resource value representing an IMAP stream, an integer value representing a particular message as parameters and, reads the body of the specified mail/message in the form of a string.

Syntax

imap_body($imap_stream ,$msg [,options]);

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.
3	Options(Mandatory) This is an optional parameter which can be one or more of the following − FT_UID FT_PEEK FT_INTERNAL

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.

Options(Mandatory)

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

FT_UID
FT_PEEK
FT_INTERNAL

Return Values

This function returns a string value representing the body of the specified message in the given mailbox.

PHP Version

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

Example

This is an example demonstrating the usage of the imap_fetchtext() 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("Contents of the first message: "."<br>");
         $body = imap_body($imap, 1);
         print($body);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Contents of the first message:
--000000000000a0d34e05b24373f4 Content-Type: text/plain; charset="UTF-8" #sample_mail1 --000000000000a0d34e05b24373f4 Content-Type: text/html; charset="UTF-8"
#sample_mail1
--000000000000a0d34e05b24373f4--

Example

This is another example 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) {
               $msg = imap_body($imap, $msg);
               print(quoted_printable_decode($msg)."<br>");                
            }    
         } 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
−−000000000000a0d34e05b24373f4 Content-Type: text/plain; charset="UTF-8" #sample_mail1 −−000000000000a0d34e05b24373f4 Content-Type: text/html; charset="UTF−8"
#sample_mail1
−−000000000000a0d34e05b24373f4−−
−−000000000000bb1b8205b24375b9 Content-Type: text/plain; charset="UTF−8" #sample_mail2 −−000000000000bb1b8205b24375b9 Content-Type: text/html; charset="UTF−8"
#sample_mail2
−−000000000000bb1b8205b24375b9−−
−−000000000000dceebf05b27c7601 Content-Type: text/plain; charset="UTF−8" #sample_mail3 −−000000000000dceebf05b27c7601 Content-Type: text/html; charset="UTF-8"
#sample_mail3
−−000000000000dceebf05b27c7601−−
−−000000000000e7e7c705b27d7527 Content-Type: text/plain; charset="UTF-8" #sample_mail4 −−000000000000e7e7c705b27d7527 Content−Type: text/html; charset="UTF−8"

php_function_reference.htm

Kickstart Your Career

Get certified by completing the course

Get Started