imap_status()函式—用法及示例

函式名：imap_status()

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

函式說明：imap_status() 函式返回指定郵箱的狀態資訊，包括郵件總數、未讀郵件數和最近一封郵件的UID。此函式需要 IMAP 擴充套件的支援。

語法：imap_status ( resource $imap_stream , string $mailbox , int $options )

引數：

• $imap_stream：必需，表示一個有效的 IMAP 流。
• $mailbox：必需，表示郵箱的名稱，例如 INBOX。
• $options：可選，表示選項標誌。預設為 0。

返回值：

• 如果成功，返回一個包含狀態資訊的物件（stdClass）。
• 如果失敗，返回 FALSE。

示例：

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

// 獲取郵箱狀態資訊
$status = imap_status($imap_stream, "INBOX", SA_ALL);

// 輸出狀態資訊
if ($status) {
    echo "郵件總數：" . $status->messages . "<br>";
    echo "未讀郵件數：" . $status->unseen . "<br>";
    echo "最近一封郵件的UID：" . $status->uidnext . "<br>";
} else {
    echo "獲取狀態資訊失敗";
}

// 關閉 IMAP 連線
imap_close($imap_stream);

注意事項：

• 在使用 imap_status() 函式之前，必須先透過 imap_open() 函式連線到 IMAP 伺服器。
• $options 引數可以使用以下選項標誌的組合：
  • SA_MESSAGES：獲取郵件總數。
  • SA_RECENT：獲取最近一封郵件的 UID。
  • SA_UNSEEN：獲取未讀郵件數。
  • SA_UIDNEXT：獲取下一個可用的 UID 值。
  • SA_UIDVALIDITY：獲取 UID 的有效性。
  • SA_ALL：獲取所有狀態資訊（預設選項）。
• 更多關於 imap_status() 函式的詳細資訊，請參考 PHP 手冊。