PHP - imap_append() Function

Previous
Quiz
Next

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_append() function accepts a resource value representing an IMAP stream, and two other string values representing a mailbox name/URL and, a message as parameters, appends the given message to the specified mailbox.

imap_binary() function notranslate"> imap_append($imap_stream ,$mailbox ,$message [$options, $internal_date]);

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

mailbox(Mandatory)

This is a string value representing the name/URL of the mailbox. It contains the server name, mailbox path.
3

message(Mandatory)

This is a string value representing the message to be appended.
4

options (Optional)

This is an optional string value which will be appended to the mail specified mailbox.
5

date (Optional)

This is a string value representing the optional internal date, that is to be added to the message.

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 4 and works in all the later versions.

Example

Following example demonstrates the usage of the imap_append() function − 

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $stream = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");
		 
         $num = imap_num_msg($stream);
         print("Number of messages: ".$num."\n");

         imap_append($stream, $url
            , "From: [email protected]\r\n"
            . "To: [email protected]\r\n"
            . "Subject: test\r\n"
            . "\r\n"
            . "this is a test message, please ignore\r\n"
         );
         print("<br>");
         print("Number of messages after append: ".imap_num_msg($stream)."\n");

         imap_close($stream);
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....
Number of messages: 10
Number of messages after append: 11

Example

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

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $stream = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");
		 
         $num = imap_num_msg($stream);
         print("Number of messages: ".$num."\n");

         $msg = "From: [email protected]\r\n"
            . "To: [email protected]\r\n"
            . "Subject: test\r\n"
            . "\r\n"
            . "this is a test message, please ignore\r\n";

         imap_append($stream, $url, $msg, "", date("2/2/2020"));
         print("Message appended");
         imap_close($stream);
      ?>
   </body>
</html>

Output

This will generate the following output −

Message appended
php_function_reference.htm
Print Page
Previous
Next
Advertisements