imap_mail_move

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

imap_mail_moveПереместить указанные сообщения в указанный почтовый ящик

Описание

imap_mail_move(
    IMAP\Connection $imap,
    string $message_nums,
    string $mailbox,
    int $flags = 0
): bool

Перемещает письма, заданные в message_nums в указанный почтовый ящик mailbox. Обратите внимание, что почтовые сообщения фактически копируются в mailbox, а исходные сообщения помечаются для удаления. Это означает, что сообщениям в mailbox назначаются новые UID.

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

imap

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

message_nums

message_nums - это диапазон, а не просто номера сообщений (как определено в » RFC2060).

mailbox

Имя почтового ящика. Более подробно читайте в разделе, посвящённом функции imap_open()

Внимание

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

flags

flags - битовая маска, которая может принимать всего одно значение:

  • CP_UID - означает, что в первом параметре не номера сообщений, а их UID

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

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

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

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

Примечания

Замечание:

Функция imap_mail_move() помечает оригинальное сообщение флагом удаления, так что не забудьте после неё вызвать функцию imap_expunge().

Смотрите также

  • imap_mail_copy() - Скопировать сообщения в указанный почтовый ящик