Php/docs/function.imap-listscan
imap_listscan
(PHP 4, PHP 5, PHP 7)
imap_listscan — Returns the list of mailboxes that matches the given text
说明
imap_listscan
( resource $imap_stream
, string $ref
, string $pattern
, string $content
) : array
Returns an array containing the names of the mailboxes that have
content in the text of the mailbox.
This function is similar to imap_listmailbox(),
but it will additionally check for the presence of the string
content inside the mailbox data.
参数
imap_stream由 imap_open() 返回的 IMAP 流。
refrefshould normally be just the server specification as described in imap_open()Warning
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
pattern指定在邮箱层级的何处开始查找。
在组成
pattern的字符中可使用两个特殊字符： '*' 和 '%'。 '*' 是指返回所有邮箱目录. 如果将 '*' 作为pattern参数时, 则会返回整个邮箱层级结构。 '%' 是指只返回当前级次。 '%' 作为pattern参数则只会返回顶层邮箱； '~/mail/%' 用于UW_IMAPD则会返回名为~/mail的目录, 但不包含其子目录。contentThe searched string
返回值
Returns an array containing the names of the mailboxes that have
content in the text of the mailbox.
参见
- imap_listmailbox() - 别名 imap_list
- imap_search() - This function returns an array of messages matching the given search criteria
