函式名: imap_mail_move()
適用版本: PHP 4 >= 4.0.7, PHP 5, PHP 7
用法: imap_mail_move( resource $imap_stream, string $msglist, string $mailbox [, int $options = 0 ] ) : bool
函式描述:該函式用於將指定的郵件從一個郵箱移動到另一個郵箱。
引數:
- $imap_stream:必需,一個有效的IMAP流資源,透過imap_open()函式獲得。
- $msglist:必需,要移動的郵件識別符號列表,可以是單個識別符號或用逗號分隔的多個識別符號。
- $mailbox:必需,目標郵箱的名稱,可以是本地郵箱或遠端郵箱。
- $options:可選,移動選項。預設為0,表示不使用任何選項。
返回值:成功時返回true,失敗時返回false。
示例:
// 連線到IMAP伺服器
$imap_stream = imap_open("{mail.example.com:993/imap/ssl}", "username", "password");
// 將郵件識別符號為1的郵件移動到"Archive"郵箱
if (imap_mail_move($imap_stream, "1", "Archive")) {
echo "郵件移動成功!";
} else {
echo "郵件移動失敗!";
}
// 關閉IMAP連線
imap_close($imap_stream);
注意事項:
- 在使用此函式之前,必須先透過imap_open()函式連線到IMAP伺服器。
- 郵件識別符號可以透過其他IMAP函式(如imap_search())獲取。
- 目標郵箱可以是本地郵箱(例如"Inbox"、"Sent")或遠端郵箱(例如"[email protected]/Archive")。
- 可以透過設定$options引數來使用不同的選項,如IMAP_OP_MOVE(使用MOVE命令進行移動而不是COPY命令)。
- 如果移動成功,源郵箱中的郵件將被刪除,如果移動失敗,源郵箱中的郵件將保持不變。
- 在使用完imap_mail_move()函式後,建議使用imap_expunge()函式來徹底刪除已標記為刪除的郵件。
更多資訊和示例,請參考PHP官方文件:https://www.php.net/manual/en/function.imap-mail-move.php