<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieve the quota settings per user</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-get-quota.html">imap_get_quota</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-getacl.html">imap_getacl</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-get-quotaroot" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_get_quotaroot</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">imap_get_quotaroot</span> — <span class="dc-title">Retrieve the quota settings per user</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-get-quotaroot-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imap_get_quotaroot</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$quota_root</code></span>
)</div>
<p class="para rdfs-comment">
Retrieve the quota settings per user. 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.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-get-quotaroot-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
imap_stream</code></em></span><dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">quota_root</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">quota_root</code></em> should normally be in the form of
which mailbox (i.e. INBOX).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-get-quotaroot-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
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.
</p>
<p class="para">
This function will return <strong><code>FALSE</code></strong> in the case of call failure, and an
array of information about the connection upon an un-parsable response
from the server.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-get-quotaroot-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3360">
<p><strong>Example #1 <span class="function"><strong>imap_get_quotaroot()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"kalowsky"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">, </span><span style="color: #0000BB">OP_HALFOPEN</span><span style="color: #007700">)<br /> or die(</span><span style="color: #DD0000">"can't connect: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$quota </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_get_quotaroot</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"INBOX"</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$quota</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$storage </span><span style="color: #007700">= </span><span style="color: #0000BB">$quota_values</span><span style="color: #007700">[</span><span style="color: #DD0000">'STORAGE'</span><span style="color: #007700">];<br /> echo </span><span style="color: #DD0000">"STORAGE usage level is: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$storage</span><span style="color: #007700">[</span><span style="color: #DD0000">'usage'</span><span style="color: #007700">];<br /> echo </span><span style="color: #DD0000">"STORAGE limit level is: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$storage</span><span style="color: #007700">[</span><span style="color: #DD0000">'limit'</span><span style="color: #007700">];<br /><br /> </span><span style="color: #0000BB">$message </span><span style="color: #007700">= </span><span style="color: #0000BB">$quota_values</span><span style="color: #007700">[</span><span style="color: #DD0000">'MESSAGE'</span><span style="color: #007700">];<br /> echo </span><span style="color: #DD0000">"MESSAGE usage level is: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'usage'</span><span style="color: #007700">];<br /> echo </span><span style="color: #DD0000">"MESSAGE limit level is: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'limit'</span><span style="color: #007700">];<br /><br /> </span><span style="color: #FF8000">/* ... */<br /><br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imap-get-quotaroot-notes">
<h3 class="title">Notes</h3>
<p class="para">
This function is currently only available to users of the c-client2000
or greater library.
</p>
<p class="para">
The <em><code class="parameter">imap_stream</code></em> should be opened as the user whose
mailbox you wish to check.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-get-quotaroot-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imap-open.html" class="function" rel="rdfs-seeAlso">imap_open()</a> - Open an IMAP stream to a mailbox</span></li>
<li class="member"> <span class="function"><a href="function.imap-set-quota.html" class="function" rel="rdfs-seeAlso">imap_set_quota()</a> - Sets a quota for a given mailbox</span></li>
<li class="member"> <span class="function"><a href="function.imap-get-quota.html" class="function" rel="rdfs-seeAlso">imap_get_quota()</a> - Retrieve the quota level settings, and usage statics per mailbox</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-get-quota.html">imap_get_quota</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-getacl.html">imap_getacl</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
