imap_listmailbox()函式—用法及示例

函式名稱：imap_listmailbox()

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

函式描述：imap_listmailbox() 函式返回匹配指定郵件郵箱的郵箱名稱列表。

用法：

array imap_listmailbox ( resource $imap_stream , string $ref , string $pattern )

引數：

• $imap_stream：必需。一個有效的 IMAP 流。
• $ref：必需。參考路徑，例如 {imap.example.com:143}。
• $pattern：必需。匹配的郵箱名稱模式。

返回值：

• 如果成功，則返回一個包含匹配的郵箱名稱的陣列，失敗則返回 false。

示例：

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

// 獲取所有郵箱名稱以 "INBOX" 為字首的郵箱列表
$mailboxes = imap_listmailbox($imap_stream, "{imap.example.com:143}", "INBOX*");

if ($mailboxes) {
    foreach ($mailboxes as $mailbox) {
        echo $mailbox . "\n";
    }
} else {
    echo "無法獲取郵箱列表";
}

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

注意事項：

• $pattern 引數可以使用萬用字元 * 或 %，用於匹配多個郵箱名稱。
• $pattern 引數可以使用 { 和 } 包圍，以指定具體的郵箱層次結構路徑。
• 連線到 IMAP 伺服器的使用者名稱和密碼應該替換為有效的憑據。
• 在使用此函式之前，需要確保已啟用 PHP 的 IMAP 擴充套件模組。
• 在使用此函式之前，需要確保已建立與 IMAP 伺服器的連線。