[edit] Last updated: Fri, 10 Feb 2012

imap_append

(PHP 4, PHP 5)

imap_append — Append a string message to a specified mailbox

Description

bool imap_append ( resource $imap_stream , string $mailbox , string $message [, string $options = NULL [, string $internal_date = NULL ]] )

Appends a string message to the specified mailbox.

Parameters

imap_stream

An IMAP stream returned by imap_open().

mailbox

The mailbox name, see imap_open() for more information

message

The message to be append, as a string

When talking to the Cyrus IMAP server, you must use "\r\n" as your end-of-line terminator instead of "\n" or the operation will fail

options

If provided, the options will also be written to the mailbox

internal_date

If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value.

Return Values

Returns TRUE on success or FALSE on failure.

Changelog

Version	Description
5.3.2	Added INTERNALDATE support to imap_append.

Examples

Example #1 imap_append() example


<?php
$stream = imap_open("{imap.example.org}INBOX.Drafts", "username", "password");

$check = imap_check($stream);
echo "Msg Count before append: ". $check->Nmsgs . "\n";

imap_append($stream, "{imap.example.org}INBOX.Drafts"
                   , "From: me@example.com\r\n"
                   . "To: you@example.com\r\n"
                   . "Subject: test\r\n"
                   . "\r\n"
                   . "this is a test message, please ignore\r\n"
                   );

$check = imap_check($stream);
echo "Msg Count after append : ". $check->Nmsgs . "\n";

imap_close($stream);
?>

imap_base64

imap_alerts

[edit] Last updated: Fri, 10 Feb 2012

add a note User Contributed Notes imap_append

bill at dyndns dot org 23-Nov-2011 11:45


Here is how I used this function with an attachment. I used examples from everyone else but made it easier and cleaner to change.





<?php


$authhost="{000.000.000.000:993/validate-cert/ssl}Drafts";





$user="sadasd";


$pass="sadasd";





if ($mbox=imap_open( $authhost, $user, $pass))


{


    $dmy=date("d-M-Y H:i:s");


    


    $filename="filename.pdf";


    $attachment = chunk_split(base64_encode($filestring));


    


    $boundary = "------=".md5(uniqid(rand()));


    


    $msg = ("From: Somebody\r\n"


        . "To: test@example.co.uk\r\n"


        . "Date: $dmy\r\n"


        . "Subject: This is the subject\r\n"


        . "MIME-Version: 1.0\r\n"


        . "Content-Type: multipart/mixed; boundary=\"$boundary\"\r\n"


        . "\r\n\r\n"


        . "--$boundary\r\n"


        . "Content-Type: text/html;\r\n\tcharset=\"ISO-8859-1\"\r\n"


        . "Content-Transfer-Encoding: 8bit \r\n"


        . "\r\n\r\n"


        . "Hello this is a test\r\n"


        . "\r\n\r\n"


        . "--$boundary\r\n"


        . "Content-Transfer-Encoding: base64\r\n"


        . "Content-Disposition: attachment; filename=\"$filename\"\r\n"


        . "\r\n" . $attachment . "\r\n"


        . "\r\n\r\n\r\n"


        . "--$boundary--\r\n\r\n");


        


    imap_append($mbox,$authhost,$msg, "\\Draft"); 





    imap_close($mbox);


}


else


{


    echo "<h1>FAIL!</h1>\n";


}





?>





Hope this helps someone.

Tigggger 08-Aug-2011 09:30


I encountered 3 problems when attempting to get my server to copy messages to the sent folder.





1. Wouldn't login until I added /novalidate-cert


2. No code example of getting the date sent


3. Including an attachment





Hope this code helps others





<?php


$dmy=date("d-M-Y H:i:s");


$dmy.= " +0100"; // Had to do this bit manually as server and me are in different timezones


$stream=@imap_open("{mail.example.com/novalidate-cert}INBOX.Sent", "username", "password");


$boundary = "------=".md5(uniqid(rand()));


$header = "MIME-Version: 1.0\r\n";


$header .= "Content-Type: multipart/mixed; boundary=\"$boundary\"\r\n";


$header .= "\r\n";


$file="../path_to/filename.pdf";


$filename="filename.pdf";


$ouv=fopen ("$file", "rb");$lir=fread ($ouv, filesize ("$file"));fclose


($ouv);


$attachment = chunk_split(base64_encode($lir));


$msg2 .= "--$boundary\r\n";


$msg2 .= "Content-Transfer-Encoding: base64\r\n";


$msg2 .= "Content-Disposition: attachment; filename=\"$filename\"\r\n";


$msg2 .= "\r\n";


$msg2 .= $attachment . "\r\n";


$msg2 .= "\r\n\r\n";


$msg3 .= "--$boundary--\r\n";


imap_append($stream,"{mail.example.com/novalidate-cert}INBOX.Sent","From: Somebody\r\n"."To: test@example.co.uk\r\n"."Date: $dmy\r\n"."Subject: This is the subject\r\n"."$header\r\n"."$msg2\r\n"."$msg3\r\n");


imap_close ($stream);


?>

kaminski at istori dot com 15-Aug-2010 08:52


The date format string to use when creating $internal_date is 'd-M-Y H:i:s O'.

chris at sma-sportsmgmt dot com 07-Feb-2008 11:06


I spend most of today refining the example to make it work properly when saving to the Inbox.Sent folder.



The append command now looks like:



    $return = imap_append($stream,$mailbox_addr

                       , "From: $fromReply\r\n"

                       . "To: $to\r\n"

                       . "Subject: $subject\r\n"

                       . "Date: $now  \r\n"

              . "X-Mailer: Cmail_v2.0 \r\n"

                       . "X-Originating-IP: $ip_addr \r\n"

                       . "MIME-Version: 1 \r\n"

                       . "Content-Type: text/html;\r\n\tcharset=\"ISO-8859-1\"\r\n"

                       . "Content-Transfer-Encoding: 8bit \r\n"

                       . "\r\n\r\n"

                       . "$wk_msg\r\n"

                       );



This inserts the current date into the email and lets it support html content. The one thing that I haven't got working yet is including attachments. I presumably have to make the boundaries and attachment content part of the message body.



Chris

jille at DIESPAMMERShexon dot cx 03-May-2007 07:36


The last argument, $options, are flags like for use with imap_setflag_full.

It took a while before I found out

svicentemolina at gmail dot com 17-Jan-2007 07:57


I have used this function to copy all the emails of one account from one server to another. The problem was that this function don't copy the original receiving date for each message.

To add a fifth field to provide the date, I have made some changes at some php source files following the steps described in http://www.zend.com/lists/php-dev/200303/msg00843.html and it has worked fine.

The correct date format is the returned by the function mail_date in c-client/mail.c source file, for instance: "17-Jan-2007 10:00:01 +0100"

bithive 23-Jun-2003 03:26


The parameter description is misleading.  You can pass a string of flags such as '\Seen' [see imap_setflag_full()] as the last argument.  In the other imap functions, 'options' seems to usually refer to a bitmask, not message flags.

michel dot jansens at ulb dot ac dot be 29-Apr-2003 07:29


I use imap_append() to decode message/rfc822 attachments type(embedded emails):



$attachment = imap_fetchbody($mbox,$mailuid,$atpos,FT_UID);

$attachment = imap_base64($attachment);

$res =  imap_append($mbox,mboxspec("INBOX"),$attachment);

//the embedded email is now a normal mail in my INBOX

bluebiru78 at hotmail dot com 12-Jun-2002 12:24


i used imap_append to copy any composed message into INBOX.Sent folder..



$app = imap_append($stream,"{" . $connectstring . "}INBOX.Sent","$header\r\n" ."$mbody\r\n");



if (!$app) {

 error("Email copying to Sent folder FAILED!");

}

owain at vaughan dot com 01-Aug-2001 06:49


With SIMS IMAP server you also need to use \r\n as a line terminator, otherwise you will be able to add all the header lines correctly, but the body of the message will not be saved.<br>


You can use \n by itself for each header line, but when creating the blank line between the headers and the body you must use \r\n\r\n

jesper at angelo dot dk 14-Sep-1999 09:13


Please observe that imap_append() do not support NNTP posting. Use fsockopen() instead, and do the work yourself.

add a note