• PHP Video Tutorials

PHP - imap_savebody() 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_savebody() function accepts a resource value representing an IMAP stream, a file path and an integer value representing a particular message as parameters and, saves the body of the given mail in the specified file path.

Syntax

imap_savebody($imap_stream, $file, $msg [,part, $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

file (Mandatory)

This is a file path in which you need to save the body of the mail.
3

msg (Mandatory)

This is an integer value representing the message/mail number.
4

part_number (Optional)

This is a string value containing the indexes of the body parts values separated by “.”.
5

options (Optional)

This is an integer value representing optional value which can be one or more of the following:

  • FT_UID

  • FT_PEEK

  • FT_INTERNAL

Return Values

This function returns a Boolean value which is TRUE in case of success and FALSE in case of failure.

PHP Version

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

Example

Following example demonstrates the usage of the imap_savebody() 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>");
		 
         //Saving the message in a file 
         $path = "sample.txt";
         $file = fopen($path, "w");

         $msg = 1;
         $body = imap_savebody($imap, $file, 1);
         print($body);
         print("Message saved in the file");
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message saved in the file

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>");
		 
         //Saving the message in a file 
         $path = "sample.txt";
         $file = fopen($path, "w");

         $msg = 1;
         $body = imap_savebody($imap, $file, 1, 1);
         print($body);
         print("Message saved in the file");
         
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message saved in the file
php_function_reference.htm
Advertisements