imap_append
imap_append
(PHP 4, PHP 5, PHP 7)
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
optionswill also be written to themailbox -
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);
?>
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.imap-append.php
