imap_get_quota

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

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

Описание

array imap_get_quota ( resource $imap_stream , string $quota_root )

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

Версия данной функции для использования обычными пользователями, не администраторами - 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(
"can't connect: " imap_last_error());

$quota_value imap_get_quota($mbox"user.kalowsky");
if (
is_array($quota_value)) {
    echo 
"Usage level is: " $quota_value['usage'];
    echo 
"Limit level is: " $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(
"can't connect: " imap_last_error());

$quota_values imap_get_quota($mbox"user.kalowsky");
if (
is_array($quota_values)) {
   
$storage $quota_values['STORAGE'];
   echo 
"STORAGE usage level is: " .  $storage['usage'];
   echo 
"STORAGE limit level is: " .  $storage['limit'];

   
$message $quota_values['MESSAGE'];
   echo 
"MESSAGE usage level is: " .  $message['usage'];
   echo 
"MESSAGE limit is: " .  $message['limit'];

   
/* ...  */
}

imap_close($mbox);
?>

Примечания

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

Заданный поток imap_stream должен быть открыт под административным пользователем.

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

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