<p>Possible <code>PUT</code> parameters used to update passwords of all users under domain (<code>/api/users/<domain>/password</code>):</p>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>password</code></td>
<td>Update passwords of all users under domain</td>
<td><code>password=Ww0nXVEV8iv4ap@p4b</code></td>
</tr>
</tbody>
</table>
<h3id="mailing-list">Mailing List</h3>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This is applicable to OpenLDAP. For SQL backends, please use mail alias
account as mailing list.</p>
</div>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/maillist/<mail></td>
<td>POST</td>
<td>Create a new mailing list</td>
</tr>
<tr>
<td>/api/maillist/<mail></td>
<td>DELETE</td>
<td>Delete an existing mailing list</td>
</tr>
<tr>
<td>/api/maillist/<mail></td>
<td>PUT</td>
<td>Update profile of an existing mailing list</td>
</tr>
</tbody>
</table>
<p>Possible <code>PUT</code> parameters used to update account profile:</p>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cn</code></td>
<td>display name</td>
<td><code>cn=My List Name</code></td>
</tr>
<tr>
<td><code>accessPolicy</code></td>
<td>Defines who can send email to this mailing list</td>
<td><code>accessPolicy=public</code></td>
</tr>
</tbody>
</table>
<h3id="mail-alias">Mail Alias</h3>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/alias/<mail></td>
<td>POST</td>
<td>Create a new mail alias</td>
</tr>
<tr>
<td>/api/alias/<mail></td>
<td>DELETE</td>
<td>Delete an existing mail alias</td>
</tr>
<tr>
<td>/api/alias/<mail></td>
<td>PUT</td>
<td>Update profile of an existing mail alias</td>
</tr>
</tbody>
</table>
<p>Possible <code>PUT</code> parameters used to update account profile:</p>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cn</code></td>
<td>display name</td>
<td><code>cn=My List Name</code></td>
</tr>
<tr>
<td><code>accessPolicy</code></td>
<td>Defines who can send email to this mail alias account</td>
<td><code>accessPolicy=public</code></td>
</tr>
</tbody>
</table>
<blockquote>
<p>Note: <code>accessPolicy</code> for mail alias account is only available for SQL backends.</p>
</blockquote>
<h3id="throttling">Throttling</h3>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/throttle/global/inbound</td>
<td>GET</td>
<td>Get global inbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/global/outbound</td>
<td>GET</td>
<td>Get global outbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/global/inbound</td>
<td>POST</td>
<td>Set global inbound throttle setting</td>
</tr>
<tr>
<td>/api/throttle/global/outbound</td>
<td>POST</td>
<td>Set global outbound throttle setting</td>
</tr>
<tr>
<td>/api/throttle/<domain>/inbound</td>
<td>GET</td>
<td>Get domain inbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/<domain>/outbound</td>
<td>GET</td>
<td>Get domain outbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/<domain>/inbound</td>
<td>POST</td>
<td>Set domain inbound throttle setting</td>
</tr>
<tr>
<td>/api/throttle/<domain>/outbound</td>
<td>POST</td>
<td>Set domain outbound throttle setting</td>
</tr>
<tr>
<td>/api/throttle/<mail>/inbound</td>
<td>GET</td>
<td>Get user inbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/<mail>/outbound</td>
<td>GET</td>
<td>Get user outbound throttle settings</td>
</tr>
<tr>
<td>/api/throttle/<mail>/inbound</td>
<td>POST</td>
<td>Set user inbound throttle setting</td>
</tr>
<tr>
<td>/api/throttle/<mail>/outbound</td>
<td>POST</td>
<td>Set user outbound throttle setting</td>
</tr>
</tbody>
</table>
<p>Possible <code>POST</code> parameters used to set throttle setting:</p>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>period</code></td>
<td>Period of time (in seconds)</td>
<td><code>period=3600</code> (one hour)</td>
</tr>
<tr>
<td><code>msg_size</code></td>
<td>Max size of single email</td>
<td><code>msg_size=10485760</code> (10 MB)</td>
</tr>
<tr>
<td><code>max_msgs</code></td>
<td>Number of max inbound emails</td>
<td><code>max_msgs=20</code> (up to 20 messages)</td>
</tr>
<tr>
<td><code>max_quota</code></td>
<td>Cumulative size of all inbound emails</td>
<td><code>max_quota=1048576000</code> (1 GB)</td>
</tr>
</tbody>
</table>
<h2id="sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</h2>
<ul>
<li><ahref="./iredadmin-pro.restful.api.curl.html">iRedAdmin-Pro RESTful API (interact with <code>curl</code>)</a></li>
<li><ahref="./iredadmin-pro.restful.api.python.html">iRedAdmin-Pro RESTful API (interact with Python)</a></li>
</ul><pstyle="text-align: center; color: grey;">All documents are available in <ahref="https://bitbucket.org/zhb/iredmail-docs/src">BitBucket repository</a>, and published under <ahref="http://creativecommons.org/licenses/by-nd/3.0/us/"target="_blank">Creative Commons</a> license. If you found something wrong, please do <ahref="http://www.iredmail.org/contact.html">contact us</a> to fix it.<script>