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

函数名称：imap_listsubscribed()

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

函数描述：imap_listsubscribed() 函数返回一个数组，包含了用户订阅的邮箱文件夹列表。

用法：

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

参数：

• $imap_stream：必需。有效的 IMAP 连接资源。
• $ref：必需。参考路径，用于指定邮箱文件夹的起始位置。通常是邮箱的根目录，可以是空字符串或者是一个邮箱文件夹路径。
• $pattern：必需。一个通配符模式，用于筛选出订阅的邮箱文件夹。可以使用 * 代表任意字符，使用 % 代表任意字符串。

返回值： 如果成功，该函数返回一个包含订阅邮箱文件夹的数组。如果失败，则返回 FALSE。

示例：

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

// 获取用户订阅的邮箱文件夹列表
$mailbox_list = imap_listsubscribed($imap_stream, "", "*");

// 遍历输出邮箱文件夹列表
if ($mailbox_list) {
    foreach ($mailbox_list as $mailbox) {
        echo $mailbox . "<br>";
    }
} else {
    echo "获取邮箱文件夹列表失败";
}

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

注意事项：

• 请确保已经正确设置了 IMAP 服务器的连接参数。
• 请确保用户的 IMAP 账户具有订阅邮箱文件夹的权限。
• 请根据实际情况修改连接参数、用户名和密码。