imap_mail_move
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_mail_move — Move specified messages to a mailbox
說明
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_numsis a range not just message numbers (as described in » RFC2060). -
mailbox -
The mailbox name, see imap_open() for more information
警告Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
-
flags -
flagsis 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_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.