imap_get_quota
(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
imap_get_quota — Retrieve the quota level settings, and usage statics per mailbox
說明
$imap
, string $quota_root
): array|falseRetrieve the quota level settings, and usage statics per mailbox.
For a non-admin user version of this function, please see the imap_get_quotaroot() function of PHP.
參數
-
imap
-
IMAP\Connection 實例。
-
quota_root
-
quota_root
should normally be in the form ofuser.name
where name is the mailbox you wish to retrieve information about.
返回值
Returns an array with integer values limit and usage for the given
mailbox. The value of limit represents the total amount of space
allowed for this mailbox. The usage value represents the mailboxes
current level of capacity. Will return false
in the case of failure.
As of PHP 4.3, the function more properly reflects the functionality as dictated by the » RFC2087. The array return value has changed to support an unlimited number of returned resources (i.e. messages, or sub-folders) with each named resource receiving an individual array key. Each key value then contains an another array with the usage and limit values within it.
For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update.
更新日誌
版本 | 說明 |
---|---|
8.1.0 |
現在 imap 參數接受 IMAP\Connection
實例,之前接受 資源(resource)。
|
範例
示例 #1 imap_get_quota() example
<?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 "Usage level is: " . $quota_value['usage'];
echo "Limit level is: " . $quota_value['limit'];
}
imap_close($mbox);
?>
示例 #2 imap_get_quota() 4.3 or greater example
<?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 usage level is: " . $storage['usage'];
echo "STORAGE limit level is: " . $storage['limit'];
$message = $quota_values['MESSAGE'];
echo "MESSAGE usage level is: " . $message['usage'];
echo "MESSAGE limit is: " . $message['limit'];
/* ... */
}
imap_close($mbox);
?>
註釋
This function is currently only available to users of the c-client2000 or greater library.
The given imap
must be opened as the mail
administrator, otherwise this function will fail.
參見
- imap_open() - Open an IMAP stream to a mailbox
- imap_set_quota() - Sets a quota for a given mailbox
- imap_get_quotaroot() - Retrieve the quota settings per user