PHP Manual
Функции IMAP
Получить настройку уровня квоты и статистику использования почтовых ящиков

imap_get_quota

(PHP 4 >= 4.0.5, PHP 5, PHP 7)

imap_get_quota — Получить настройку уровня квоты и статистику использования почтовых ящиков

Описание

imap_get_quota ( resource $imap_stream , string $quota_root ) : array

Возвращает настройку уровня квоты и статистику использования почтовых ящиков.

Версия данной функции для использования обычными пользователями, не администраторами - imap_get_quotaroot().

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

imap_stream: Поток IMAP, полученный из imap_open().
quota_root: quota_root должно соответствовать формату user.name, где name - имя ящика, информация по которому нужна.

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

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

Начиная с PHP 4.3 и выше, функция более точно соответствует стандарту, описанному в » RFC2087. Значение возвращаемого массива изменилось для поддержки неограниченного количества возвращаемых ресурсов (т.е. сообщений или подпапок), где каждый именованный ресурс будет представлен индивидуальным массивом. Каждый элемент массива будет содержать другой массив к ключами "limit" и "usage".

Для обеспечения обратной совместимости, оригинальный метод доступа все еще доступен, хотя предполагается это поправить.

Примеры

Пример #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() в PHP 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_stream должен быть открыт под административным пользователем.

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

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