imap_scan()函式—用法及示例

函式名：imap_scan()

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

用法：imap_scan(resource $imap_stream, string $mailbox, string $pattern, int $options = 0): array|false

引數：

• $imap_stream：必需。一個表示 IMAP 流的資源識別符號，透過 imap_open() 函式獲取。
• $mailbox：必需。要掃描的郵箱名稱。
• $pattern：必需。要匹配的模式字串。
• $options：可選。一個用於指定掃描選項的整數值，預設為0。

返回值：

• 成功時，返回一個包含匹配的郵件號碼的陣列。
• 失敗時，返回 false。

說明： 該函式用於從指定的郵箱中掃描匹配給定模式的郵件。可以使用 "*" 作為萬用字元來匹配任意字元。該函式不會改變當前郵箱的位置。

示例：

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

// 掃描收件箱中匹配 "PHP" 的郵件
$mailbox = "INBOX";
$pattern = "*PHP*";
$emails = imap_scan($imap_stream, $mailbox, $pattern);

// 列印匹配到的郵件號碼
if ($emails) {
    foreach ($emails as $email) {
        echo "匹配到的郵件號碼：$email<br>";
    }
} else {
    echo "未找到匹配的郵件";
}

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

以上示例程式碼將連線到指定的 IMAP 伺服器，掃描收件箱中匹配 "PHP" 的郵件，並列印匹配到的郵件號碼。如果未找到匹配的郵件，將輸出"未找到匹配的郵件"。最後，關閉 IMAP 連線。