函式名:imap_list()
適用版本:PHP 4, PHP 5, PHP 7
函式描述:imap_list() 函式返回指定郵箱(mailbox)中的郵件列表。
語法:array imap_list ( resource $imap_stream , string $ref , string $pattern )
引數:
- imap_stream:連線到 IMAP 伺服器的 IMAP 流。
- ref:郵箱的參考名稱,例如:"{mail.example.com}"。
- pattern:匹配的郵箱名稱模式,例如:"*" 或者 "%"。
返回值:返回一個包含郵件列表的陣列,每個元素代表一個郵箱名稱。
示例:
// 連線到 IMAP 伺服器
$imap_stream = imap_open("{mail.example.com:143}", "username", "password");
// 獲取郵箱列表
$mailboxes = imap_list($imap_stream, "{mail.example.com}", "*");
if (is_array($mailboxes)) {
// 遍歷並輸出郵箱列表
foreach ($mailboxes as $mailbox) {
echo "郵箱名稱: " . $mailbox . "<br>";
}
}
// 關閉 IMAP 連線
imap_close($imap_stream);
以上示例中,首先使用 imap_open() 函式連線到 IMAP 伺服器。然後使用 imap_list() 函式獲取指定郵箱的郵件列表,引數中的參考名稱是 "{mail.example.com}",匹配的郵箱名稱模式是 "*",表示匹配所有郵箱。最後,使用 foreach 迴圈遍歷郵件列表,並輸出每個郵箱的名稱。最後,使用 imap_close() 函式關閉 IMAP 連線。