imap_append

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_appendДобавляет строковое сообщение в указанный почтовый ящик

Описание

imap_append(
    IMAP\Connection$imap,
    string$folder,
    string$message,
    ?string$options = null,
    ?string$internal_date = null
): bool

Добавляет строку message в указанный folder.

Список параметров

imap

Экземпляр класса IMAP\Connection.

folder

Имя почтового ящика. Смотрите imap_open() для подробной информации.

Внимание

Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не проверенных данных не безопасна.

message

Добавляемое сообщение в виде строки

При обращении к серверу Cyrus IMAP следует использовать "\r\n" как завершающий символ строки вместо "\n", иначе операция будет неудачна.

options

Если указан, то параметр options также будет записан в folder

internal_date

Если этот параметр указан, он установит INTERNALDATE в добавляемом сообщении. Параметр должен содержать дату, представленную строкой, которая соответствует спецификации rfc2060 для значения date_time.

Возвращаемые значения

Возвращает true в случае успешного выполнения или false, если возникла ошибка.

Список изменений

ВерсияОписание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.
8.0.0options и internal_date теперь допускают значение null.

Примеры

Пример #1 Пример использования imap_append()

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

$check = imap_check($imap);
echo
"Кол-во сообщений до добавления: ". $check->Nmsgs . "\n";

imap_append($imap, "{imap.example.org}INBOX.Drafts"
, "From: me@example.com\r\n"
. "To: you@example.com\r\n"
. "Subject: test\r\n"
. "\r\n"
. "это проверочное сообщение, пожалуйста, игнорируйте его\r\n"
);

$check = imap_check($imap);
echo
"Кол-во сообщений после добавления : ". $check->Nmsgs . "\n";

imap_close($imap);
?>
To Top