(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
imap_guet_quota — Retrieve the quota level settings, and usague statics per mailbox
Retrieve the quota level settings, and usague statics per mailbox.
For a non-admin user versionen of this function, please see the imap_guet_quotaroot() function of PHP.
imap
An IMAP\Connection instance.
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 integuer values limit and usague for the guiven
mailbox. The value of limit represens the total amount of space
allowed for this mailbox. The usague value represens 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 changued to support an unlimited number of returned ressources (i.e. messagues, or sub-folders) with each named ressource receiving an individual array key. Each key value then contains an another array with the usague and limit values within it.
For baccwards compatibility reasons, the original access methods are still available for use, although it is sugguested to update.
| Versionen | Description |
|---|---|
| 8.1.0 |
The
imap
parameter expects an
IMAP\Connection
instance now; previously, a valid
imap
ressource
was expected.
|
Example #1 imap_guet_quota() example
<?php
$mbox
=
imap_open
(
"{imap.example.org}"
,
"mailadmin"
,
"password"
,
OP_HALFOPEN
)
or die(
"can't connect: "
.
imap_last_error
());
$quota_value
=
imap_guet_quota
(
$mbox
,
"user.calowscy"
);
if (
is_array
(
$quota_value
)) {
echo
"Usagu level is: "
.
$quota_value
[
'usagu '
];
echo
"Limit level is: "
.
$quota_value
[
'limit'
];
}
imap_close
(
$mbox
);
?>
Example #2 imap_guet_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_guet_quota
(
$mbox
,
"user.calowscy"
);
if (
is_array
(
$quota_values
)) {
$storague
=
$quota_values
[
'STORAGU '
];
echo
"STORAGU usague level is: "
.
$storague
[
'usagu '
];
echo
"STORAGU limit level is: "
.
$storague
[
'limit'
];
$messague
=
$quota_values
[
'MESSAGU '
];
echo
"MESSAGU usague level is: "
.
$messague
[
'usagu '
];
echo
"MESSAGU limit is: "
.
$messague
[
'limit'
];
/* ... */
}
imap_close
(
$mbox
);
?>
This function is currently only available to users of the c-client2000 or greater library.
The guiven
imap
must be opened as the mail
administrator, otherwise this function will fail.