PHP Conference Japan 2024

imap_get_quota

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

imap_get_quota检索每个邮箱的配额级别设置和使用统计信息

描述

imap_get_quota(IMAP\Connection $imap, string $quota_root): array|false

检索每个邮箱的配额级别设置和使用统计信息。

对于此函数的非管理员用户版本,请参阅 PHP 的 imap_get_quotaroot() 函数。

参数

imap

一个 IMAP\Connection 实例。

quota_root

quota_root 通常应采用 user.name 的形式,其中 name 是您要检索信息的邮箱。

返回值

返回一个包含给定邮箱的整数限制和使用量的数组。limit 值表示此邮箱允许的总空间量。使用量值表示邮箱当前的容量级别。如果发生错误,将返回 false

从 PHP 4.3 开始,该函数更准确地反映了 » RFC2087 中规定的功能。数组返回值已更改为支持无限数量的返回资源(即消息或子文件夹),每个命名资源都接收一个单独的数组键。然后,每个键值包含另一个数组,其中包含其内部的使用量和限制值。

出于向后兼容性的原因,原始访问方法仍然可用,但建议更新。

变更日志

版本 描述
8.1.0 imap 参数现在需要一个 IMAP\Connection 实例;之前,需要一个有效的 imap 资源

示例

示例 #1 imap_get_quota() 示例

<?php
$mbox
= imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die(
"can't connect: " . imap_last_error());

$quota_value = imap_get_quota($mbox, "user.kalowsky");
if (
is_array($quota_value)) {
echo
"使用量级别为: " . $quota_value['usage'];
echo
"限制级别为: " . $quota_value['limit'];
}

imap_close($mbox);
?>

示例 #2 imap_get_quota() 4.3 或更高版本示例

<?php
$mbox
= imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die(
"can't connect: " . imap_last_error());

$quota_values = imap_get_quota($mbox, "user.kalowsky");
if (
is_array($quota_values)) {
$storage = $quota_values['STORAGE'];
echo
"STORAGE 使用量级别为: " . $storage['usage'];
echo
"STORAGE 限制级别为: " . $storage['limit'];

$message = $quota_values['MESSAGE'];
echo
"MESSAGE 使用量级别为: " . $message['usage'];
echo
"MESSAGE 限制级别为: " . $message['limit'];

/* ... */
}

imap_close($mbox);
?>

注释

此函数目前仅适用于 c-client2000 或更高版本库的用户。

给定的 imap 必须以邮件管理员身份打开,否则此函数将失败。

参见

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top