imap_get_quota

Retrieve the quota level settings, and usage statics per mailbox (PHP 4 >= 4.0.5, PHP 5)
array imap_get_quota ( resource imap_stream, string quota_root )

Example 1049. imap_get_quota() example

copy to clipboard

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

Example 1050. imap_get_quota() 4.3 or greater example

copy to clipboard

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

Code Examples / Notes » imap_get_quota

ok, this error just occurs if there are no quotas on your mailbox. same with imap_get_quotaroot().

anti veeranna

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

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

Change Language

imap_8bit
imap_alerts
imap_append
imap_base64
imap_binary
imap_body
imap_bodystruct
imap_check
imap_clearflag_full
imap_close
imap_createmailbox
imap_delete
imap_deletemailbox
imap_errors
imap_expunge
imap_fetch_overview
imap_fetchbody
imap_fetchheader
imap_fetchstructure
imap_get_quota
imap_get_quotaroot
imap_getacl
imap_getmailboxes
imap_getsubscribed
imap_header
imap_headerinfo
imap_headers
imap_last_error
imap_list
imap_listmailbox
imap_listscan
imap_listsubscribed
imap_lsub
imap_mail_compose
imap_mail_copy
imap_mail_move
imap_mail
imap_mailboxmsginfo
imap_mime_header_decode
imap_msgno
imap_num_msg
imap_num_recent
imap_open
imap_ping
imap_qprint
imap_renamemailbox
imap_reopen
imap_rfc822_parse_adrlist
imap_rfc822_parse_headers
imap_rfc822_write_address
imap_savebody
imap_scanmailbox
imap_search
imap_set_quota
imap_setacl
imap_setflag_full
imap_sort
imap_status
imap_subscribe
imap_thread
imap_timeout
imap_uid
imap_undelete
imap_unsubscribe
imap_utf7_decode
imap_utf7_encode
imap_utf8