查詢

imap_listsubscribed()函式—用法及示例

「 返回一個陣列,包含了使用者訂閱的郵箱資料夾列表 」


函式名稱:imap_listsubscribed()

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

函式描述:imap_listsubscribed() 函式返回一個陣列,包含了使用者訂閱的郵箱資料夾列表。

用法:

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

引數:

  • $imap_stream:必需。有效的 IMAP 連線資源。
  • $ref:必需。參考路徑,用於指定郵箱資料夾的起始位置。通常是郵箱的根目錄,可以是空字串或者是一個郵箱資料夾路徑。
  • $pattern:必需。一個萬用字元模式,用於篩選出訂閱的郵箱資料夾。可以使用 * 代表任意字元,使用 % 代表任意字串。

返回值: 如果成功,該函式返回一個包含訂閱郵箱資料夾的陣列。如果失敗,則返回 FALSE。

示例:

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

// 獲取使用者訂閱的郵箱資料夾列表
$mailbox_list = imap_listsubscribed($imap_stream, "", "*");

// 遍歷輸出郵箱資料夾列表
if ($mailbox_list) {
    foreach ($mailbox_list as $mailbox) {
        echo $mailbox . "<br>";
    }
} else {
    echo "獲取郵箱資料夾列表失敗";
}

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

注意事項:

  • 請確保已經正確設定了 IMAP 伺服器的連線引數。
  • 請確保使用者的 IMAP 賬戶具有訂閱郵箱資料夾的許可權。
  • 請根據實際情況修改連線引數、使用者名稱和密碼。
補充糾錯
上一個函式: imap_lsub()函式
下一個函式: imap_listscan()函式
熱門PHP函式
分享連結