imap_lsub

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

imap_lsub列出所有已订阅的邮箱

说明

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

获取您已订阅的所有邮箱的数组。

参数

imap

一个 IMAP\Connection 实例。

reference

reference 通常应仅为 imap_open() 中描述的服务器规范。

警告

除非禁用 imap.enable_insecure_rsh,否则将不受信任的数据传递给此参数是不安全的

pattern

指定在邮箱层次结构中的何处开始搜索。

您可以将两个特殊字符作为 pattern 的一部分传递:'*' 和 '%'。'*' 表示返回所有邮箱。如果您将 pattern 作为 '*' 传递,您将获得整个邮箱层次结构的列表。'%' 表示仅返回当前级别。'%' 作为 pattern 参数将仅返回顶层邮箱;~/mail/%' 在 UW_IMAPD 上将返回 ~/mail 目录中的每个邮箱,但不返回该目录子文件夹中的任何邮箱。

返回值

返回所有已订阅邮箱的数组,或在失败时返回 false

变更日志

版本 说明
8.1.0 imap 参数现在期望一个 IMAP\Connection 实例;以前,期望一个有效的 imap 资源

参见

添加笔记

用户贡献的笔记

此页面没有用户贡献的笔记。
To Top