函式: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 伺服器的連線。