(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — 列出所有已訂閱的信箱
imap一個 IMAP\Connection 實例。
reference
reference 通常應為伺服器規格，如 imap_open() 中所述。
除非已停用 imap.enable_insecure_rsh，否則將不受信任的資料傳遞給此參數是*不安全的*。
pattern指定在信箱階層結構中開始搜尋的位置。
您可以將兩個特殊字元作為 pattern 的一部分傳遞：'*' 和 '%'。'*' 表示返回所有信箱。如果您將 pattern 傳遞為 '*'，您將獲得整個信箱階層結構的清單。'%' 表示僅返回目前的層級。將 '%' 作為 pattern 參數將僅返回頂層信箱；在 UW_IMAPD 上使用 '~/mail/%' 將返回 ~/mail 目錄中的每個信箱，但不返回該目錄子資料夾中的任何信箱。
返回一個包含信箱資訊的物件陣列。每個物件都具有屬性 name，指定信箱的全名；delimiter，它是此信箱所在階層結構部分的階層分隔符號；以及 attributes。Attributes 是一個位元遮罩，可以根據以下內容進行測試：
LATT_NOINFERIORS - 此信箱沒有「子項」（在此信箱下沒有其他信箱）。
LATT_NOSELECT - 這只是一個容器，而不是信箱 - 您無法開啟它。
LATT_MARKED - 此信箱已標記。僅供 UW-IMAPD 使用。
LATT_UNMARKED - 此信箱未標記。僅供 UW-IMAPD 使用。
LATT_REFERRAL - 此容器具有指向遠端信箱的參照。
LATT_HASCHILDREN - 此信箱具有可選的子項。
LATT_HASNOCHILDREN - 此信箱沒有可選的子項。
false。
| 版本 | 說明 |
|---|---|
| 8.1.0 | imap 參數現在需要一個 IMAP\Connection 實例；先前，需要一個有效的 imap 資源。 |