elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Sync iredadmin-pro.restful.api.html.

This commit is contained in:
Zhang Huangbin 2016-04-20 15:11:50 +08:00
parent 1824676fac
commit fbd3d0e0ad
2 changed files with 42 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
en_US/faq/2-iredadmin-pro.restful.api.md
View File

@ -61,8 +61,15 @@ Parameter Name | Summary | Sample Usage
`cn` | display name | `cn=My New Name`
`preferredLanguage` | default preferred language for new user | `preferredLanguage=en_US`
`mailQuota` | mailbox quota for this user (in MB) | `mailQuota=1024`
`password` | Password | `password=Ww0nXVEV8iv4ap@p4b`
`transport` | Transport program | `transport=dovecot`
### Mailing List (OpenLDAP only)
### Mailing List
!!! note
This is applicable to OpenLDAP. For SQL backends, please use mail alias
account as mailing list.
URL | HTTP Method | Summary
--- |---| ---
@ -75,6 +82,7 @@ Possible `PUT` parameters used to update account profile:
Parameter Name | Summary | Sample Usage
--- |--- |---
`cn` | display name | `cn=My List Name`
`accessPolicy` | access policy | `accessPolicy=public`
### Mail Alias
@ -89,6 +97,9 @@ Possible `PUT` parameters used to update account profile:
Parameter Name | Summary | Sample Usage
--- |--- |---
`cn` | display name | `cn=My List Name`
`accessPolicy` | access policy | `accessPolicy=public`
> Note: `accessPolicy` is available for only SQL backends.
## Sample code to interact with iRedAdmin-Pro RESTful API

32
html/iredadmin-pro.restful.api.html
View File

@ -23,7 +23,7 @@
<li><a href="#apis">APIs</a><ul>
<li><a href="#domain">Domain</a></li>
<li><a href="#user">User</a></li>
<li><a href="#mailing-list-openldap-only">Mailing List (OpenLDAP only)</a></li>
<li><a href="#mailing-list">Mailing List</a></li>
<li><a href="#mail-alias">Mail Alias</a></li>
</ul>
</li>
@ -180,9 +180,24 @@
<td>mailbox quota for this user (in MB)</td>
<td><code>mailQuota=1024</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td>Password</td>
<td><code>password=Ww0nXVEV8iv4ap@p4b</code></td>
</tr>
<tr>
<td><code>transport</code></td>
<td>Transport program</td>
<td><code>transport=dovecot</code></td>
</tr>
</tbody>
</table>
<h3 id="mailing-list-openldap-only">Mailing List (OpenLDAP only)</h3>
<h3 id="mailing-list">Mailing List</h3>
<div class="admonition note">
<p class="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>
@ -224,6 +239,11 @@
<td>display name</td>
<td><code>cn=My List Name</code></td>
</tr>
<tr>
<td><code>accessPolicy</code></td>
<td>access policy</td>
<td><code>accessPolicy=public</code></td>
</tr>
</tbody>
</table>
<h3 id="mail-alias">Mail Alias</h3>
@ -268,8 +288,16 @@
<td>display name</td>
<td><code>cn=My List Name</code></td>
</tr>
<tr>
<td><code>accessPolicy</code></td>
<td>access policy</td>
<td><code>accessPolicy=public</code></td>
</tr>
</tbody>
</table>
<blockquote>
<p>Note: <code>accessPolicy</code> is available for only SQL backends.</p>
</blockquote>
<h2 id="sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</h2>
<ul>
<li><a href="./iredadmin-pro.restful.api.curl.html">iRedAdmin-Pro RESTful API (interact with <code>curl</code>)</a></li>