PHP Conference Japan 2024

imap_listscan

(PHP 4、PHP 5、PHP 7、PHP 8)

imap_listscan返回与给定文本匹配的邮箱列表

描述

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

返回一个数组,其中包含邮箱名称,这些邮箱的文本中包含 content

此函数类似于 imap_listmailbox(),但它还会额外检查邮箱数据内部是否存在字符串 content

参数

imap

一个 IMAP\Connection 实例。

reference

reference 通常应该只是 imap_open() 中描述的服务器规范。

警告

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

pattern

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

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

content

搜索字符串

返回值

返回一个数组,其中包含邮箱名称,这些邮箱的文本中包含 content,或者在失败时返回 false

变更日志

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

参见

添加注释

用户贡献的注释

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