imap_mail_move

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

imap_mail_moveMove specified messages to a mailbox

Опис

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

Moves mail messages specified by message_nums to the specified mailbox. Note that the mail messages are actually copied to the mailbox, and the original messages are flagged for deletion. That implies that the messages in mailbox are assigned new UIDs.

Параметри

imap

Примірник IMAP\Connection.

message_nums

message_nums is a range not just message numbers (as described in » RFC2060).

mailbox

The mailbox name, see imap_open() for more information

Увага

Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.

flags

flags is a bitmask and may contain the single option:

  • CP_UID - the sequence numbers contain UIDS

Значення, що повертаються

Повертає true у разі успіху або false в разі помилки.

Журнал змін

Версія Опис
8.1.0 Тепер параметр imap має бути примірником IMAP\Connection; раніше очікувався дійсний resource imap.

Примітки

Зауваження:

imap_mail_move() will flag the original mail with a delete flag, to successfully delete it a call to the imap_expunge() function must be made.

Прогляньте також