diff --git a/reference/imap/functions/imap-get-quota.xml b/reference/imap/functions/imap-get-quota.xml index 4aa7dcb599..bd728c230c 100644 --- a/reference/imap/functions/imap-get-quota.xml +++ b/reference/imap/functions/imap-get-quota.xml @@ -1,5 +1,5 @@ - + @@ -27,9 +27,10 @@ NOTE: For this function to work, the mail stream is required to be opened - as the mail-admin user. + as the mail-admin user. For a non-admin user version of this function, + please see the imap_get_quotaroot function of PHP. + + imap_stream should be the value returned from an imap_open call. NOTE: This stream is required to be opened as the mail admin user for the get_quota function to work. @@ -65,6 +66,9 @@ imap_close($mbox); and limit values within it. The example below shows the updated returned output. + + For backwards compatibility reasons, the originial access methods are + still available for use, although it is suggested to update. <function>imap_get_quota</function> 4.3 or greater @@ -93,7 +97,7 @@ imap_close($mbox); </example> </para> <para> - See also <function>imap_open</function>, <function>imap_set_quota</function><!-- To be uncommented when imap_get_quotaroot works --><!-- , <function>imap_get_quotaroot</function> -->. + See also <function>imap_open</function>, <function>imap_set_quota</function>, <function>imap_get_quotaroot</function>. </para> </refsect1> </refentry> diff --git a/reference/imap/functions/imap-get-quotaroot.xml b/reference/imap/functions/imap-get-quotaroot.xml new file mode 100644 index 0000000000..cfd574a13a --- /dev/null +++ b/reference/imap/functions/imap-get-quotaroot.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.1 $ --> + <refentry id="function.imap-get-quotaroot"> + <refnamediv> + <refname>imap_get_quotaroot</refname> + <refpurpose> + Retrieve the quota settings per user + </refpurpose> + </refnamediv> + <refsect1> + <title>Description + + arrayimap_get_quotaroot + intimap_stream + stringquota_root + + + Returns an array of integer values pertaining to the specified user + mailbox. All values contain a key based upon the resource name, and a + corresponding array with the usage and limit values within. + + + The limit value represents the total amount of space + allowed for this user's total mailbox usage. The usage value represents + the user's current total mailbox capacity. This function will return + &false; in the case of call failure, and an array of information about + the connection upon an un-parsable response from the server. + + + This function is currently only available to users of the c-client2000 + or greater library. + + + imap_stream should be the value returned from + an imap_open call. This stream should be opened + as the user whose mailbox you wish to check. + quota_root should normally be in the form of + which mailbox (i.e. INBOX). + + + + <function>imap_get_quotaroot</function> example + + + + + + + See also imap_open, imap_set_quota, imap_get_quota. + + + + +