imap_unsubscribe()函式—用法及示例

函式名：imap_unsubscribe()

適用版本：PHP 4, PHP 5, PHP 7

用法：imap_unsubscribe() 函式用於取消訂閱指定郵箱中的郵件夾。取消訂閱後，使用者將不再接收該郵件夾中的新郵件。

語法：bool imap_unsubscribe ( resource $imap_stream , string $mailbox )

引數：

• imap_stream：必需，表示與伺服器的連線的 IMAP 流。
• mailbox：必需，表示要取消訂閱的郵件夾名稱。

返回值：如果取消訂閱成功，則返回 true，否則返回 false。

示例：

// 連線到 IMAP 伺服器
$imap_stream = imap_open("{imap.example.com:993/imap/ssl}INBOX", "username", "password");

// 取消訂閱 "Sent" 郵件夾
if (imap_unsubscribe($imap_stream, "Sent")) {
    echo "成功取消訂閱郵件夾 'Sent'";
} else {
    echo "取消訂閱郵件夾失敗";
}

// 關閉與伺服器的連線
imap_close($imap_stream);

注意事項：

• imap_unsubscribe() 函式只能用於取消訂閱使用者已經訂閱的郵件夾，而不能用於訂閱新的郵件夾。
• 該函式需要在與伺服器的連線上下文中呼叫，因此在呼叫之前必須先使用 imap_open() 函式建立與伺服器的連線。
• 取消訂閱郵件夾後，使用者將不再接收該郵件夾中的新郵件，但已經存在於郵件夾中的郵件不會被刪除。
• 在取消訂閱郵件夾後，如果使用者希望重新訂閱該郵件夾，可以使用 imap_subscribe() 函式。
• 取消訂閱郵件夾可能需要伺服器的支援，因此在使用該函式之前，建議先檢查伺服器是否支援該功能。可以使用 imap_capability() 函式獲取伺服器的功能列表。