PHP 8.1.0 Beta 1 available for testing

imap_get_quotaroot

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

imap_get_quotarootПолучить настройки квоты для каждого пользователя

Описание

imap_get_quotaroot(resource $imap, string $mailbox): array|false

Возвращает настройки квоты для каждого пользователя. Число с ключом "limit" определяет максимальный допустимый размер ящика. Число с ключом "usage" определяет текущий уровень использования.

Список параметров

imap

Поток IMAP, полученный из imap_open().

mailbox

mailbox должно содержать имя ящика (например INBOX).

Возвращаемые значения

Возвращает массив целых чисел, относящихся к конкретному пользователю. В качестве ключей массива используются имена ресурсов, а в качестве значений массивы с ключами "limit" и "usage".

В случае ошибки эта функция вернёт false и массив информации о соединении в случае получения ответа, который она не сможет разобрать.

Примеры

Пример #1 Пример использования imap_get_quotaroot()

<?php
$mbox 
imap_open("{imap.example.org}""kalowsky""password"OP_HALFOPEN)
      or die(
"не удалось подключиться: " imap_last_error());

$quota imap_get_quotaroot($mbox"INBOX");
if (
is_array($quota)) {
   
$storage $quota['STORAGE'];
   echo 
"Уровень использования STORAGE: " .  $storage['usage'];
   echo 
"Максимальный размер STORAGE: " .  $storage['limit'];

   
$message $quota['MESSAGE'];
   echo 
"Уровень использования MESSAGE: " .  $message['usage'];
   echo 
"Максимальный размер MESSAGE: " .  $message['limit'];

   
/* ...  */

}

imap_close($mbox);
?>

Примечания

Эта функция доступна только при использовании библиотеки c-client2000 или новее.

Заданный поток imap должен быть открыт под пользователем, чей ящик вы хотите проверить.

Смотрите также

  • imap_open() - Открывает поток IMAP к почтовому ящику
  • imap_set_quota() - Установить квоту для заданного почтового ящика
  • imap_get_quota() - Получить настройку уровня квоты и статистику использования почтовых ящиков

add a note add a note

User Contributed Notes 3 notes

up
5
thomas dot hebinck at digionline dot de
17 years ago
['STORAGE']['usage'] and ['STORAGE']['limit'] are values in KB (1024 Bytes)
up
2
uphonesimon at gmail dot com
15 years ago
just to make a note for all the people that are wondering the differences between $quota['STORAGE'] and $quot['MESSAGE']
the $quot['STORAGE'] is the size of the mailbox in KB
but $quota['MESSAGE'] is actually the number of messages stored in the mailbox and the up limit of the total messages allowed
up
-3
rodrigo dot tsuru at tsuru dot net
16 years ago
The example above isn't right. Replace with this:

<?php
$mbox
= imap_open("{your.imap.host}", "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 usage level is: " $message['limit'];

  
/* ...  */

}

imap_close($mbox);
?>
To Top