imap_getsubscribed()函式—用法及示例

函式名：imap_getsubscribed()

適用版本：PHP 4 >= 4.0.7, PHP 5, PHP 7

函式說明：imap_getsubscribed() 函式返回使用者訂閱的郵件資料夾列表。

用法：

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

引數：

• $imap_stream：IMAP 連線資源，透過 imap_open() 函式獲取。
• $ref：郵件資料夾的參考路徑。通常為根目錄（'INBOX'）或其他資料夾的完整路徑。
• $pattern：用於篩選資料夾的模式。可以是一個簡單的字串（如 '' 所有資料夾）或帶有萬用字元的字串（如 'INBOX.'）。

返回值：

返回一個包含使用者訂閱的郵件資料夾列表的陣列。如果沒有找到匹配的資料夾，則返回空陣列。

示例：

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

// 獲取使用者訂閱的資料夾列表
$folders = imap_getsubscribed($imap_stream, $imap_server, '*');

// 列印資料夾列表
foreach ($folders as $folder) {
    echo $folder . "\n";
}

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

以上示例中，我們首先透過 imap_open() 函式連線到 IMAP 伺服器。然後使用 imap_getsubscribed() 函式獲取使用者訂閱的資料夾列表，並使用 foreach 迴圈列印出每個資料夾的名稱。最後，使用 imap_close() 函式關閉連線。

請注意，示例中的 $imap_server 變數應替換為您實際的 IMAP 伺服器地址，$username 和 $password 變數應替換為您的登入憑據。