imap_lsub
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — List all the subscribed mailboxes
說明
imap_lsub(IMAP\Connection
$imap, string $reference, string $pattern): array|falseGets an array of all the mailboxes that you have subscribed.
參數
-
imap -
IMAP\Connection 實例。
-
reference -
referenceshould normally be just the server specification as described in imap_open()警告Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
-
pattern -
指定在郵箱層級的何處開始查詢。
在組成
pattern的字元中可使用兩個特殊字元： '*' 和 '%'。 '*' 是指返回所有郵箱目錄. 如果將 '*' 作為pattern參數時, 則會返回整個郵箱層級結構。 '%' 是指只返回目前級次。 '%' 作為pattern參數則只會返回頂層郵箱； '~/mail/%' 用於UW_IMAPD則會返回名為 ~/mail 的目錄, 但不包含其子目錄。
返回值
Returns an array of all the subscribed mailboxes, 或者在失敗時返回 false.
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 |
現在 imap 參數接受 IMAP\Connection
實例，之前接受 資源(resource)。
|
參見
- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one