(PHP 4, PHP 5, PHP 7, PHP 8)
imap_listscan — 返回与给定文本匹配的邮箱列表
$imap
,$reference
,$pattern
,$content
返回一个数组,其中包含邮箱文本中包含 content
的邮箱名称。
此函数类似于 imap_listmailbox(),但它还会另外检查邮箱数据中是否存在字符串 content
。
imap
一个 IMAP\Connection 实例。
reference
reference
通常应该只是 imap_open() 中描述的服务器规范。
除非 imap.enable_insecure_rsh 被禁用,否则将不可信数据传递给此参数是不安全的。
pattern
指定在邮箱层次结构中的何处开始搜索。
您可以作为 pattern
的一部分传递两个特殊字符:'*
' 和 '%
'。'*
' 表示返回所有邮箱。如果您将 pattern
作为 '*
' 传递,您将获得整个邮箱层次结构的列表。'%
' 表示只返回当前级别。'%
' 作为 pattern
参数将只返回顶层邮箱;'~/mail/%
' 在 UW_IMAPD
上将返回 ~/mail 目录中的每个邮箱,但不会返回该目录子文件夹中的任何邮箱。
content
搜索的字符串
返回一个数组,其中包含邮箱文本中包含 content
的邮箱名称,或者在失败时返回 false
。
版本 | 描述 |
---|---|
8.1.0 | imap 参数现在期望一个 IMAP\Connection 实例;以前,期望一个有效的 imap 资源。 |