[函数]imap_listmailbox()函数—用法及示例

函数名称：imap_listmailbox()

适用版本：PHP 4, PHP 5, PHP 7

函数描述：imap_listmailbox() 函数返回匹配指定邮件邮箱的邮箱名称列表。

用法：

array imap_listmailbox ( resource $imap_stream , string $ref , string $pattern )

参数：

• $imap_stream：必需。一个有效的 IMAP 流。
• $ref：必需。参考路径，例如 {imap.example.com:143}。
• $pattern：必需。匹配的邮箱名称模式。

返回值：

• 如果成功，则返回一个包含匹配的邮箱名称的数组，失败则返回 false。

示例：

// 连接到 IMAP 服务器
$imap_stream = imap_open("{imap.example.com:143}", "username", "password");

// 获取所有邮箱名称以 "INBOX" 为前缀的邮箱列表
$mailboxes = imap_listmailbox($imap_stream, "{imap.example.com:143}", "INBOX*");

if ($mailboxes) {
    foreach ($mailboxes as $mailbox) {
        echo $mailbox . "\n";
    }
} else {
    echo "无法获取邮箱列表";
}

// 关闭 IMAP 连接
imap_close($imap_stream);

注意事项：

• $pattern 参数可以使用通配符 * 或 %，用于匹配多个邮箱名称。
• $pattern 参数可以使用 { 和 } 包围，以指定具体的邮箱层次结构路径。
• 连接到 IMAP 服务器的用户名和密码应该替换为有效的凭据。
• 在使用此函数之前，需要确保已启用 PHP 的 IMAP 扩展模块。
• 在使用此函数之前，需要确保已建立与 IMAP 服务器的连接。