<li><ahref="#mailing-list-openldap-only">Mailing List (OpenLDAP only)</a></li>
<li><ahref="#mail-alias">Mail Alias</a></li>
</ul>
</li>
<li><ahref="#sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</a></li>
</ul>
</li>
</ul>
</div>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>If you need an API which has not yet been implemented, don't hesitate to
<ahref="../contact.html">contact us</a>.</p>
</div>
<h2id="summary">Summary</h2>
<p>iRedAdmin-Pro RESTful API will return message in JSON format.</p>
<ul>
<li>If operation succeed, it returns JSON <code>{'success': true}</code>.</li>
<li>If operation failed, it returns JSON <code>{'success': false, 'msg': '<error_reason>'}</code>.</li>
</ul>
<h2id="requirements">Requirements</h2>
<ul>
<li>At least iRedAdmin-Pro-SQL-2.4.0 or iRedAdmin-Pro-LDAP-2.6.0. Earlier releases
didn't offer RESTful API.</li>
</ul>
<h2id="apis">APIs</h2>
<p>Notes:</p>
<ul>
<li>replace <code><domain></code> in URL by the real domain name.</li>
<li>replace <code><mail></code> in URL by the real email address.</li>
</ul>
<h3id="domain">Domain</h3>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/domain/<domain></td>
<td>POST</td>
<td>Create a new domin</td>
</tr>
<tr>
<td>/api/domain/<domain></td>
<td>DELETE</td>
<td>Delete an existing domain</td>
</tr>
<tr>
<td>/api/domain/<domain></td>
<td>PUT</td>
<td>Update profile of an existing domain</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>the short description of this domain name. e.g. company name</td>
<td><code>cn=iRedMail Project</code></td>
</tr>
<tr>
<td><code>quota</code></td>
<td>a integer number for mailbox quota (for whole domain, in MB)</td>
<td><code>quota=20480</code></td>
</tr>
<tr>
<td><code>preferredLanguage</code></td>
<td>default preferred language for new user</td>
<td><code>preferredLanguage=en_US</code></td>
</tr>
<tr>
<td><code>defaultQuota</code></td>
<td>default mailbox quota for new user</td>
<td><code>defaultQuota=1024</code></td>
</tr>
<tr>
<td><code>maxUserQuota</code></td>
<td>Max mailbox quota of a single mail user</td>
<td><code>maxUserQuota=2048</code></td>
</tr>
<tr>
<td><code>numberOfUsers</code></td>
<td>Max number of mail user accounts</td>
<td><code>numberOfUsers=20</code></td>
</tr>
<tr>
<td><code>numberOfAliases</code></td>
<td>Max number of mail alias accounts</td>
<td><code>numberOfAliases=30</code></td>
</tr>
</tbody>
</table>
<h3id="user">User</h3>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/user/<mail></td>
<td>POST</td>
<td>Create a new mail user</td>
</tr>
<tr>
<td>/api/user/<mail></td>
<td>DELETE</td>
<td>Delete an existing mail user</td>
</tr>
<tr>
<td>/api/user/<mail></td>
<td>PUT</td>
<td>Update profile of an existing mail user</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 New Name</code></td>
</tr>
<tr>
<td><code>preferredLanguage</code></td>
<td>default preferred language for new user</td>
<td><code>preferredLanguage=en_US</code></td>
</tr>
<tr>
<td><code>mailQuota</code></td>
<td>mailbox quota for this user (in MB)</td>
<td><code>mailQuota=1024</code></td>
</tr>
</tbody>
</table>
<h3id="mailing-list-openldap-only">Mailing List (OpenLDAP only)</h3>
<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>
</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>
</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>