PHP 日本大会 2024

imap_getsubscribed

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

imap_getsubscribed列出所有已订阅的邮箱

描述

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

获取已订阅邮箱的信息。

imap_getmailboxes() 相同,只是它只返回用户已订阅的邮箱。

参数

imap

一个 IMAP\Connection 实例。

reference

reference 通常只需要服务器规范,如 imap_open() 中所述。

警告

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

pattern

指定在邮箱层次结构中的哪个位置开始搜索。

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

返回值

返回一个包含邮箱信息的数组对象。每个对象都有属性 name,指定邮箱的全名;delimiter,它是此邮箱所在的层次结构部分的层次结构分隔符;以及 attributesAttributes 是一个位掩码,可以针对其进行测试

函数在失败时返回 false

变更日志

版本 描述
8.1.0 imap 参数现在期望一个 IMAP\Connection 实例;以前,期望一个有效的 imap 资源
添加注释

用户贡献的注释

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