函式名:imap_expunge()
適用版本:PHP 4、PHP 5、PHP 7
函式說明:imap_expunge() 函式用於從當前郵箱中永久刪除所有標記為刪除的郵件。
語法:bool imap_expunge ( resource $imap_stream )
引數:
- $imap_stream:一個有效的 IMAP 流資源,透過 imap_open() 函式返回。
返回值:成功時返回 true,失敗時返回 false。
示例:
// 連線到 IMAP 伺服器
$imap_server = "{imap.example.com:993/imap/ssl}INBOX";
$imap_username = "your_username";
$imap_password = "your_password";
$imap_stream = imap_open($imap_server, $imap_username, $imap_password);
// 檢查連線是否成功
if (!$imap_stream) {
die("無法連線到 IMAP 伺服器");
}
// 標記郵件為刪除
imap_setflag_full($imap_stream, "1,2,3", "\\Deleted");
// 永久刪除標記為刪除的郵件
if (imap_expunge($imap_stream)) {
echo "成功刪除標記為刪除的郵件";
} else {
echo "刪除郵件失敗";
}
// 關閉 IMAP 連線
imap_close($imap_stream);
在上面的示例中,我們首先透過 imap_open() 函式連線到 IMAP 伺服器,併成功驗證使用者憑據。然後,我們使用 imap_setflag_full() 函式將郵件 1、2 和 3 標記為刪除。最後,我們使用 imap_expunge() 函式永久刪除所有標記為刪除的郵件。如果成功刪除郵件,將輸出 "成功刪除標記為刪除的郵件",否則輸出 "刪除郵件失敗"。最後,我們使用 imap_close() 函式關閉 IMAP 連線。
請注意,此函式只能在與 IMAP 伺服器的連線處於開啟狀態時使用。