imap_getmailboxes()函式—用法及示例

函式名：imap_getmailboxes()

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

用法：imap_getmailboxes(resource $imap_stream, string $ref, string $pattern)

說明：該函式用於獲取指定郵箱中的目錄列表。

引數：

• $imap_stream：必需，透過imap_open()函式返回的 IMAP 流。
• $ref：必需，郵箱的引用路徑，通常為根目錄。可以是空字串("")，表示根目錄，也可以是其他目錄路徑。
• $pattern：必需，匹配郵箱名稱的模式。可以使用萬用字元"*"和"%"。

返回值：返回一個包含郵箱目錄資訊的陣列，如果失敗則返回 FALSE。

示例：

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

if ($imap_stream) {
    // 獲取郵箱目錄列表
    $mailboxes = imap_getmailboxes($imap_stream, "{imap.example.com}", "*");

    if ($mailboxes) {
        foreach ($mailboxes as $mailbox) {
            echo "Mailbox name: " . $mailbox->name . "<br>";
            echo "Mailbox delimiter: " . $mailbox->delimiter . "<br>";
            echo "Mailbox attributes: " . $mailbox->attributes . "<br>";
            echo "Mailbox flags: " . $mailbox->flags . "<br><br>";
        }
    } else {
        echo "Failed to get mailboxes.";
    }

    // 關閉 IMAP 連線
    imap_close($imap_stream);
} else {
    echo "Failed to connect to IMAP server.";
}

注意事項：

• 在使用該函式之前，需要先使用 imap_open() 函式連線到 IMAP 伺服器。
• $ref 參數列示郵箱的引用路徑，通常為根目錄。可以是空字串("")，表示根目錄，也可以是其他目錄路徑。
• $pattern 引數用於匹配郵箱名稱的模式，可以使用萬用字元"*"和"%"。
• 返回的陣列中，每個元素都是一個物件，包含了郵箱的名稱、分隔符、屬性和標誌等資訊。
• 如果函式執行失敗，將返回 FALSE。