imap_lsub
(PHP 4, PHP 5)
imap_lsub — List all the subscribed mailboxes
說明
array imap_lsub
( resource
$imap_stream
, string $ref
, string $pattern
)Gets an array of all the mailboxes that you have subscribed.
參數
-
imap_stream -
由 imap_open() 傳回的 IMAP 串流。
-
ref -
refshould normally be just the server specification as described in imap_open() -
pattern -
指定在信箱層級的何處開始尋找。
在組成
pattern的字元中可使用兩個特殊字元： '*' 和 '%'。 '*' 是指回傳所有信箱目錄. 如果將 '*' 作為pattern參數時, 則會回傳整個信箱層級結構。 '%' 是指只回傳目前層級。 '%' 作為pattern參數則只會回傳頂層信箱； '~/mail/%' 用於 UW_IMAPD 則會回傳名為 ~/mail 的目錄, 但不包含其子目錄。
回傳值
Returns an array of all the subscribed mailboxes.
參見
- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one
add a note
User Contributed Notes
There are no user contributed notes for this page.
