(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — List all the subscribed mailboxes
$imap, string $reference, string $pattern): array|falseGets information about the subscribed mailboxes.
Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.
imapIMAP\Connection 實(shí)例。
reference
reference should 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指定在郵箱層級的何處開(kāi)始查找。
在組成 pattern 的字符中可使用兩個(gè)特殊字符：
'*' 和 '%'。
'*' 是指返回所有郵箱目錄. 如果將 '*' 作為
pattern 參數時(shí), 則會(huì )返回整個(gè)郵箱層級結構。
'%' 是指只返回當前級次。
'%' 作為 pattern 參數則只會(huì )返回頂層郵箱；
'~/mail/%' 用于 UW_IMAPD
則會(huì )返回名為 ~/mail 的目錄, 但不包含其子目錄。
Returns an array of objects containing mailbox information. Each
object has the attributes name, specifying
the full name of the mailbox; delimiter,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
attributes. Attributes
is a bitmask that can be tested against:
LATT_NOINFERIORS - This mailbox has no
"children" (there are no mailboxes below this one).
LATT_NOSELECT - This is only a container,
not a mailbox - you cannot open it.
LATT_MARKED - This mailbox is marked.
Only used by UW-IMAPD.
LATT_UNMARKED - This mailbox is not marked.
Only used by UW-IMAPD.
LATT_REFERRAL - This container has a referral to a remote mailbox.
LATT_HASCHILDREN - This mailbox has selectable inferiors.
LATT_HASNOCHILDREN - This mailbox has no selectable inferiors.
false on failure.
| 版本 | 說(shuō)明 |
|---|---|
| 8.1.0 |
現在 imap 參數接受 IMAP\Connection
實(shí)例，之前接受 資源(resource)。
|