imap_lsub()函式—用法及示例

函式名：imap_lsub()

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

函式說明：imap_lsub() 函式用於列出指定郵箱中的所有訂閱的資料夾。

語法：array imap_lsub ( resource $imap_stream , string $ref , string $pattern )

引數：

• $imap_stream：必需，一個有效的 IMAP 流。
• $ref：必需，郵箱路徑字首。例如，如果郵箱路徑為 "{mail.example.com}"，則 ref 引數應為 "{mail.example.com}"。
• $pattern：必需，用於匹配資料夾的模式。例如，"*" 表示匹配所有資料夾。

返回值：返回一個包含所有訂閱資料夾名稱的陣列，如果出錯則返回 false。

示例：

// 連線到 IMAP 伺服器
$imap_server = "{mail.example.com:993/imap/ssl}INBOX";
$imap_user = "[email protected]";
$imap_password = "your_password";

$imap_stream = imap_open($imap_server, $imap_user, $imap_password);

if ($imap_stream) {
    // 列出 INBOX 資料夾的所有訂閱資料夾
    $folders = imap_lsub($imap_stream, "{mail.example.com}", "*");

    if ($folders) {
        echo "訂閱的資料夾列表：\n";
        foreach ($folders as $folder) {
            echo $folder . "\n";
        }
    } else {
        echo "無法列出訂閱的資料夾。\n";
    }

    // 關閉 IMAP 連線
    imap_close($imap_stream);
} else {
    echo "無法連線到 IMAP 伺服器。\n";
}

注意事項：

• 在使用 imap_lsub() 函式之前，需要先透過 imap_open() 函式連線到 IMAP 伺服器。
• 要確保提供正確的郵箱路徑字首和模式，以獲取正確的訂閱資料夾列表。
• 若連線到 IMAP 伺服器失敗，可以透過 imap_last_error() 函式獲取錯誤資訊。