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

函数名：imap_getsubscribed()

适用版本：PHP 4 >= 4.0.7, PHP 5, PHP 7

函数说明：imap_getsubscribed() 函数返回用户订阅的邮件文件夹列表。

用法：

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

参数：

• $imap_stream：IMAP 连接资源，通过 imap_open() 函数获取。
• $ref：邮件文件夹的参考路径。通常为根目录（'INBOX'）或其他文件夹的完整路径。
• $pattern：用于筛选文件夹的模式。可以是一个简单的字符串（如 '' 所有文件夹）或带有通配符的字符串（如 'INBOX.'）。

返回值：

返回一个包含用户订阅的邮件文件夹列表的数组。如果没有找到匹配的文件夹，则返回空数组。

示例：

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

// 获取用户订阅的文件夹列表
$folders = imap_getsubscribed($imap_stream, $imap_server, '*');

// 打印文件夹列表
foreach ($folders as $folder) {
    echo $folder . "\n";
}

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

以上示例中，我们首先通过 imap_open() 函数连接到 IMAP 服务器。然后使用 imap_getsubscribed() 函数获取用户订阅的文件夹列表，并使用 foreach 循环打印出每个文件夹的名称。最后，使用 imap_close() 函数关闭连接。

请注意，示例中的 $imap_server 变量应替换为您实际的 IMAP 服务器地址，$username 和 $password 变量应替换为您的登录凭据。