(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — 列出所有已訂閱的信箱
取得您已訂閱的所有信箱的陣列。
imap
一個 IMAP\Connection 實例。
reference
reference
通常應該只是 imap_open() 中描述的伺服器規格。
將不受信任的資料傳遞給此參數是*不安全的*,除非停用 imap.enable_insecure_rsh。
pattern
指定從信箱階層結構中的何處開始搜尋。
您可以傳遞兩個特殊字元作為 pattern
參數的一部分:'*
' 和 '%
'。'*
' 表示返回所有信箱。如果您將 pattern
傳遞為 '*
',您將獲得整個信箱階層結構的列表。'%
' 表示僅返回目前層級。以 '%
' 作為 pattern
參數將只返回頂層信箱;在 UW_IMAPD
上使用 '~/mail/%
' 將返回 ~/mail 目錄中的每個信箱,但不返回該目錄子資料夾中的任何信箱。
返回所有已訂閱信箱的陣列,如果失敗則返回 false
。
版本 | 說明 |
---|---|
8.1.0 | imap 參數現在需要一個 IMAP\Connection 實例;以前,需要一個有效的 imap 資源。 |