函式名:imap_undelete()
適用版本:PHP 4, PHP 5, PHP 7
用法:imap_undelete(resource $imap_stream, int $msg_number, int $options = 0) : bool
說明:imap_undelete() 函式用於取消刪除已標記為刪除的郵件。
引數:
- $imap_stream:必需,一個有效的 IMAP 流。
- $msg_number:必需,要取消刪除的郵件的訊息號。
- $options:可選,選項引數,預設為0。可以是以下值的按位或:
- 0:不執行任何操作。
- FT_UID:msg_number 是 UID。
- FT_PEEK:返回訊息而不將其標記為已讀。
返回值:成功時返回 true,失敗時返回 false。
示例:
// 連線到 IMAP 伺服器
$imap_stream = imap_open("{imap.example.com:993/imap/ssl}INBOX", "username", "password");
// 取消刪除郵件
$msg_number = 5;
if (imap_undelete($imap_stream, $msg_number)) {
echo "郵件已成功取消刪除!";
} else {
echo "取消刪除郵件失敗!";
}
// 關閉 IMAP 連線
imap_close($imap_stream);
注意事項:
- 在使用該函式之前,必須透過 imap_open() 函式建立與 IMAP 伺服器的連線。
- 取消刪除郵件只是將郵件從標記為刪除的狀態恢復為正常狀態,並沒有真正地將郵件從郵箱中刪除。要徹底刪除郵件,可以使用 imap_delete() 函式。
- 如果使用 FT_PEEK 選項,函式將返回郵件內容,但不會將郵件標記為已讀。