imap_get_quotaroot
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
imap_get_quotaroot — Retrieve the quota settings per user
說明
$imap, string $mailbox): array|falseRetrieve the quota settings per user. The limit value represents the total amount of space allowed for this user's total mailbox usage. The usage value represents the user's current total mailbox capacity.
參數
-
imap -
IMAP\Connection 實例。
-
mailbox -
mailboxshould normally be in the form of which mailbox (i.e. INBOX).
返回值
Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and a corresponding array with the usage and limit values within.
This function will return false in the case of call failure, and an
array of information about the connection upon an un-parsable response
from the server.
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 |
現在 imap 參數接受 IMAP\Connection
實例，之前接受 資源(resource)。
|
範例
示例 #1 imap_get_quotaroot() example
<?php
$mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
or die("can't connect: " . imap_last_error());
$quota = imap_get_quotaroot($mbox, "INBOX");
if (is_array($quota)) {
$storage = $quota['STORAGE'];
echo "STORAGE usage level is: " . $storage['usage'];
echo "STORAGE limit level is: " . $storage['limit'];
$message = $quota['MESSAGE'];
echo "MESSAGE usage level is: " . $message['usage'];
echo "MESSAGE limit level is: " . $message['limit'];
/* ... */
}
imap_close($mbox);
?>
註釋
This function is currently only available to users of the c-client2000 or greater library.
The imap should be opened as the user whose
mailbox you wish to check.
參見
- imap_open() - Open an IMAP stream to a mailbox
- imap_set_quota() - Sets a quota for a given mailbox
- imap_get_quota() - Retrieve the quota level settings, and usage statics per mailbox