<!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>Sets the ACL for a given mailbox</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-set-quota.html">imap_set_quota</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-setflag-full.html">imap_setflag_full</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-setacl" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_setacl</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_setacl</span> — <span class="dc-title">Sets the ACL for a given mailbox</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-setacl-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imap_setacl</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">$mailbox</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$rights</code></span>
)</div>
<p class="para rdfs-comment">
Sets the ACL for a giving mailbox.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-setacl-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
imap_stream</code></dt>
<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>
<code class="parameter">mailbox</code></dt>
<dd>
<p class="para">
The mailbox name, see <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span> for more
information
</p>
</dd>
<dt>
<code class="parameter">id</code></dt>
<dd>
<p class="para">
The user to give the rights to.
</p>
</dd>
<dt>
<code class="parameter">rights</code></dt>
<dd>
<p class="para">
The rights to give to the user. Passing an empty string will delete
acl.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-setacl-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imap-setacl-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>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-setacl-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.imap-getacl.html" class="function" rel="rdfs-seeAlso">imap_getacl()</a> - Gets the ACL for a given 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-set-quota.html">imap_set_quota</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-setflag-full.html">imap_setflag_full</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>
