PHP Conference Japan 2024

imap_listscan

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

imap_listscan傳回符合指定文字的郵件匣列表

說明

imap_listscan(
    IMAP\連線 $imap,
    字串 $reference,
    字串 $pattern,
    字串 $content
): 陣列|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