函数:imap_get_quota()
适用版本:PHP 4 >= 4.0.5, PHP 5, PHP 7
用法:imap_get_quota(resource $imap_stream, string $mailbox)
说明:imap_get_quota() 函数用于获取指定邮箱的配额信息。
参数:
- $imap_stream:必需。一个有效的 IMAP 连接资源。
- $mailbox:必需。要获取配额信息的邮箱地址。
返回值:返回一个关联数组,包含配额信息。如果获取失败,则返回 false。
示例:
// 连接到 IMAP 服务器
$imap_stream = imap_open('{imap.example.com:993/ssl}', 'username', 'password');
// 获取邮箱的配额信息
$quota_info = imap_get_quota($imap_stream, 'INBOX');
if ($quota_info === false) {
echo '获取配额信息失败';
} else {
// 打印配额信息
echo '邮箱配额:' . $quota_info['STORAGE'] . ' bytes';
echo '已使用:' . $quota_info['USAGE'] . ' bytes';
}
// 关闭 IMAP 连接
imap_close($imap_stream);
注意事项:
- 在使用 imap_get_quota() 函数之前,需要先通过 imap_open() 函数建立与 IMAP 服务器的连接。
- 邮箱地址参数需要是完整的邮箱地址,如 'INBOX'。
- 返回的配额信息是一个关联数组,包含 'STORAGE'(存储配额)和 'USAGE'(已使用配额)两个键值对。
- 如果获取配额信息失败,函数会返回 false。
- 在使用完 imap_get_quota() 函数后,应使用 imap_close() 函数关闭与 IMAP 服务器的连接。