PHP Conference Japan 2024

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参数将仅返回顶级邮箱;在UW_IMAPD上使用'~/mail/%' 将返回~/mail目录中的每个邮箱,但不返回该目录子文件夹中的任何邮箱。

返回值

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

变更日志

版本 描述
8.1.0 imap 参数现在需要一个IMAP\Connection 实例;以前,需要一个有效的imap 资源

参见

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top