imap_lsub

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

imap_lsubList all the subscribed mailboxes

說明

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

Gets an array of all the mailboxes that you have subscribed.

參數(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)。 '%' 是指只返回當(dāng)前級次。 '%' 作為 pattern 參數(shù)則只會返回頂層郵箱; '~/mail/%' 用于 UW_IMAPD 則會返回名為 ~/mail 的目錄, 但不包含其子目錄。

返回值

Returns an array of all the subscribed mailboxes, 或者在失敗時返回 false.

更新日志

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

參見