(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — List all the subscribed mailboxes
Gets information about the subscribed mailboxes.
Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.
imap
IMAP\Connection 实例。
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
指定在邮箱层级的何处开始查找。
在组成 pattern
的字符中可使用两个特殊字符: '*
' 和 '%
'。 '*
' 是指返回所有邮箱目录. 如果将 '*
' 作为 pattern
参数时, 则会返回整个邮箱层级结构。 '%
' 是指只返回当前级次。 '%
' 作为 pattern
参数则只会返回顶层邮箱; '~/mail/%
' 用于 UW_IMAPD
则会返回名为 ~/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. 版本 | 说明 |
---|---|
8.1.0 | 现在 imap 参数接受 IMAP\Connection 实例,之前接受有效的 imap resource。 |