PHP: imap_get_quota - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

imap_get_quotaroot imap_fetchstructure

Last updated: Sat, 27 Jan 2007

view this page in

# imap_get_quota

(PHP 4 >= 4.0.5, PHP 5)

imap_get_quota -- Retrieve the quota level settings, and usage statics per mailbox

## Описание

array imap_get_quota ( resource imap_stream, string quota_root )

Retrieve the quota level settings, and usage statics per mailbox.

For a non-admin user version of this function, please see the imap_get_quotaroot() function of PHP.

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

`imap_stream`

  An IMAP stream returned by imap_open().

`quota_root`

  `quota_root` should normally be in the form of `user.name` where name is the mailbox you wish to retrieve information about.

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

Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space allowed for this mailbox. The usage value represents the mailboxes current level of capacity. Will return `FALSE` in the case of failure.

As of PHP 4.3, the function more properly reflects the functionality as dictated by the RFC2087. The array return value has changed to support an unlimited number of returned resources (i.e. messages, or sub-folders) with each named resource receiving an individual array key. Each key value then contains an another array with the usage and limit values within it.

For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update.

## Примеры

Пример 1. imap_get_quota() example

`<?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() 4.3 or greater example

`<?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);
?>`

## Примечания

This function is currently only available to users of the c-client2000 or greater library.

The given `imap_stream` must be opened as the mail administrator, other wise this function will fail.

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

imap_open()
imap_set_quota()
imap_get_quotaroot()

add a note User Contributed Notes
imap_get_quota
Anti Veeranna
01-Mar-2007 11:26
`If you're using this (or probably any other imap functions) and getting "Notice: Unknown: Quota root does not exist (errflg=2) in Unknown on line 0" errors after the script finishes, then call imap_errors() function before you close the imap stream - this will clear the error stack and you don't get those annoying notices.
Took me a while to figure it out.`
Shiraz Esat
20-Dec-2004 09:40
`For this function to work your IMAP server must also have the 'getquota' capability!
Check this by logging in directly:
telnet <mail server> <port>
e.g. telnet mail.myserver.com 143
and then once you're connected to the server
0 CAPABILITY`
dc at aufruhr dot com
18-Jul-2003 04:26
`ok, this error just occurs if there are no quotas on your mailbox.
same with imap_get_quotaroot().`
add a note
imap_get_quotaroot imap_fetchstructure

Last updated: Sat, 27 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 09:32:46 2007 PST