PHP Manual
Prev |  | Next

# imap_append

(PHP 3 <= 3.0.18, PHP 4 >= 4.0.0)

imap_append -- Append a string message to a specified mailbox

## Description

``int imap_append` (int imap_stream, string mbox, string message [, string flags])`

Returns `TRUE` on sucess, `FALSE` on error.

imap_append() appends a string message to the specified mailbox `mbox`. If the optional `flags` is specified, writes the `flags` to that mailbox also.

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.

Example 1. imap_append() example
    $stream = imap_open("{your.imap.host}INBOX.Drafts","username", "password");

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

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

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

    imap_close($stream);

Prev | Home | Next
imap_alerts | Up | imap_base64