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(限制)和 usage(使用量)。 limit 值表示此信箱允許的總空間量。 usage 值表示信箱目前的容量級別。如果失敗,則返回 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(
"無法連線: " . 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(
"無法連線: " . 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