imap_getsubscribed

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_getsubscribed — List all the subscribed mailboxes

說明

imap_getsubscribed(IMAP\Connection $imap, string $reference, string $pattern): array|false

Gets information about the subscribed mailboxes.

Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.

參數(shù)

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 參數(shù)時, 則會返回整個郵箱層級結(jié)構(gòu)。 '%' 是指只返回當前級次。 '%' 作為 pattern 參數(shù)則只會返回頂層郵箱； '~/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.
The function returns false on failure.

更新日志

版本 說明
8.1.0 現(xiàn)在 imap 參數(shù)接受 IMAP\Connection 實例，之前接受 資源(resource)。