PHP - imap_bodystruct() 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_bodystruct() function accepts a resource value representing an IMAP stream, an integer value representing a particular message and a string value representing section of the body as parameters and reads the structure of the specified body section of a (representing by the integer) message.

Syntax

imap_bodystruct($imap_stream ,$msg, $section);

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	section(Mandatory) This is string value representing section of the body to read.

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.

section(Mandatory)

This is string value representing section of the body to read.

Return Values

This function returns an object which contains the information about the structure of the specified body section.

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 imap_bodystruct() 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("Message Structure: "."<br>");
         $struct = imap_bodystruct($imap, 1, 1);
         print_r($struct);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message Structure:
stdClass Object ( 
   [type] => 0 [encoding] => 0 
   [ifsubtype] => 1 
   [subtype] => PLAIN 
   [ifdescription] => 0 
   [ifid] => 0 
   [lines] => 1 
   [bytes] => 15 
   [ifdisposition] => 0 
   [ifdparameters] => 0 
   [ifparameters] => 1 
   [parameters] => Array ( 
      [0] => stdClass Object ( 
         [attribute] => CHARSET [value] => UTF-8 
      ) 
   ) 
)

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) {
               $struct = imap_bodystruct($imap, $msg, 1);
               print_r($struct);  
               print("<br>");			
               print("<br>");			   
			   
            }    
         } 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
stdClass Object ( 
   [type] => 0 
   [encoding] => 0 
   [ifsubtype] => 1 
   [subtype] => PLAIN 
   [ifdescription] => 0 
   [ifid] => 0 
   [lines] => 1 
   [bytes] => 15 
   [ifdisposition] => 0 
   [ifdparameters] => 0 
   [ifparameters] => 1 
   [parameters] => Array ( 
      [0] => stdClass Object ( 
         [attribute] => CHARSET [value] => UTF-8 
      ) 
   ) 
)
stdClass Object ( 
   [type] => 0 
   [encoding] => 0 
   [ifsubtype] => 1 
   [subtype] => PLAIN 
   [ifdescription] => 0 
   [ifid] => 0 
   [lines] => 1 
   [bytes] => 16 
   [ifdisposition] => 0 
   [ifdparameters] => 0 
   [ifparameters] => 1 
   [parameters] => Array ( 
      [0] => stdClass Object ( 
         [attribute] => CHARSET 
         [value] => UTF-8 
      ) 
   )
)
stdClass Object ( 
   [type] => 0 
   [encoding] => 0 
   [ifsubtype] => 1 
   [subtype] => PLAIN 
   [ifdescription] => 0 
   [ifid] => 0 
   [lines] => 1 
   [bytes] => 16 
   [ifdisposition] => 0 
   [ifdparameters] => 0 
   [ifparameters] => 1 
   [parameters] => Array ( 
      [0] => stdClass Object ([attribute] => CHARSET [value] => UTF-8 ) 
   ) 
)
stdClass Object ( 
   [type] => 0 
   [encoding] => 0 
   [ifsubtype] => 1 
   [subtype] => PLAIN 
   [ifdescription] => 0 
   [ifid] => 0 
   [lines] => 1 
   [bytes] => 16 
   [ifdisposition] => 0 
   [ifdparameters] => 0 
   [ifparameters] => 1 
   [parameters] => Array ( 
      [0] => stdClass Object ( [attribute] => CHARSET [value] => UTF-8 ) 
   ) 
)

php_function_reference.htm