<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/domain/<domain></code><codeclass="comment">Get profile of an existing domain</code><codeclass="upcoming">upcoming</code></p>
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/domain/<domain></code><codeclass="comment">Create a new domain</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="delete">DELETE</code><codeclass="url">/api/domain/<domain></code><codeclass="comment">Delete an existing domain</code></p>
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/domain/<domain></code><codeclass="comment">Update profile of an existing domain</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<td>Hostname or IP address of primary MX, smtp port number is optional. Must be used with parameter <code>is_backupmx</code>. Conflicts with parameter <code>transport</code>.</td>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/domain/services/<domain></code><codeclass="comment">Get/List all enabled per-domain services</code><codeclass="upcoming">upcoming</code></p>
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/domain/admins/<domain></code><codeclass="comment">Manage normal domain admins.</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/user/<mail></code><codeclass="comment">Get profile of an existing mail user</code><codeclass="upcoming">upcoming</code></p>
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/user/<mail></code><codeclass="comment">Create a new mail user</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="delete">DELETE</code><codeclass="url">/api/user/<mail></code><codeclass="comment">Delete an existing mail user</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/user/<mail></code><codeclass="comment">Update profile of an existing mail user</code><codeclass="has_params">Parameters</code></p>
<td>Per-user mail forwarding. Multiple addresses must be separated by comma. To save an email copy in mailbox, add original email address as one of forwarding addresses.</td>
<td>Per-user alias addresses. Multiple addresses must be separated by comma. If empty, all per-user alias addresses owned by this user will be removed. Conflicts with parameter <code>addAlias</code> and <code>removeAlias</code>.</td>
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/users/<domain></code><codeclass="comment">Update profiles of all users under domain</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/verify_password/user/<mail></code><codeclass="comment">Verify given (plain) password against the one stored in SQL/LDAP</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/maillist/<mail></code><codeclass="comment">Get profile of an existing mailing list account</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/maillist/<mail></code><codeclass="comment">Create a new mailing list</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<divclass="params">
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td>Display name</td>
<td><code>name=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>
<tr>
<td><code>members</code></td>
<td>Members of mailing list. Multiple members must be separated by comma.</td>
<pclass="admonition-title"><codeclass="delete">DELETE</code><codeclass="url">/api/maillist/<mail></code><codeclass="comment">Delete an existing mailing list</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/maillist/<mail></code><codeclass="comment">Update profile of an existing mailing list</code><codeclass="has_params">Parameters</code></p>
<td>Members of mailing list. Multiple members must be separated by comma. Conflict with parameter <code>addMember</code> and <code>removeMember</code>.</td>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/alias/<mail></code><codeclass="comment">Get profile of an existing mail alias</code><codeclass="upcoming">upcoming</code></p>
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/alias/<mail></code><codeclass="comment">Create a new mail alias</code><codeclass="upcoming">upcoming</code><codeclass="has_params">Parameters</code></p>
<pclass="admonition-title"><codeclass="delete">DELETE</code><codeclass="url">/api/alias/<mail></code><codeclass="comment">Delete an existing mail alias</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="put">PUT</code><codeclass="url">/api/alias/<mail></code><codeclass="comment">Update profile of an existing mail alias</code><codeclass="has_params">Parameters</code></p>
<td>Members of mail alias. Multiple members must be separated by comma. Conflict with parameter <code>addMember</code> and <code>removeMember</code>.</td>
<pclass="admonition-title"><codeclass="put">POST</code><codeclass="url">/api/alias/<mail>/change_email/<new_mail></code><codeclass="comment">Change email address of alias account (from '<mail>' to '<new_mail>')</code></p>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/throttle/global/inbound</code><codeclass="comment">Get global inbound throttle settings</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/throttle/global/inbound</code><codeclass="comment">Set global inbound throttle settings</code><codeclass="has_params_throttle">Parameters</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/throttle/global/outbound</code><codeclass="comment">Get global outbound throttle settings</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/throttle/global/outbound</code><codeclass="comment">Set global inbound throttle settings</code><codeclass="has_params_throttle">Parameters</code></p>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/throttle/<mail>/inbound</code><codeclass="comment">Get user inbound throttle settings</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/throttle/<mail>/inbound</code><codeclass="comment">Set user inbound throttle settings</code><codeclass="has_params_throttle">Parameters</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/throttle/<mail>/outbound</code><codeclass="comment">Get user outbound throttle settings</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="post">POST</code><codeclass="url">/api/throttle/<mail>/outbound</code><codeclass="comment">Set user outbound throttle settings</code><codeclass="has_params_throttle">Parameters</code></p>
<divclass="params params_throttle">
<p>Parameters available for global, per-domain, per-user throttle settings.</p>
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/domain/<domain></code><codeclass="comment">Export domain to LDIF</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/catchall/<domain></code><codeclass="comment">Export per-domain catch-all account to LDIF</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/admin/<mail></code><codeclass="comment">Export (separated) domain admin to LDIF</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/user/<mail></code><codeclass="comment">Export mail user to LDIF</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/maillist/<mail></code><codeclass="comment">Export mailing list account to LDIF</code><codeclass="upcoming">upcoming</code></p>
</div>
<divclass="admonition api">
<pclass="admonition-title"><codeclass="get">GET</code><codeclass="url">/api/ldif/alias/<mail></code><codeclass="comment">Export mail alias account to LDIF</code><codeclass="upcoming">upcoming</code></p>
<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. You can <ahref="https://bitbucket.org/zhb/iredmail-docs/get/tip.tar.bz2">download the latest version</a> for offline reading. If you found something wrong, please do <ahref="http://www.iredmail.org/contact.html">contact us</a> to fix it.</p>