函数名: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 连接。