Update iRedAdmin-Pro API doc.

This commit is contained in:
Zhang Huangbin 2017-12-11 16:01:26 +08:00
parent 92def9a077
commit 43c365e63d
4 changed files with 38 additions and 4 deletions

View File

@ -66,6 +66,10 @@ Features listed below have been implemented in latest development edition.
* Updated packages:
+ Roundcube -> 1.3.3
## Planned changes in next iRedMail / iRedAdmin-Pro release
* HIGH: [#14 Allow domain admin to set vacation message for mail user](https://bitbucket.org/zhb/iredmail/issues/14/allow-admin-to-set-vacation-for-user-with)
## Planned changes in future iRedMail release
* A (new) RESTful API server for general administration (core of API server has
@ -85,4 +89,9 @@ Features listed below have been implemented in latest development edition.
* Enable plugin `imap_sieve` for spam learning while user moving message to
Junk folder. Requires Dovecot-2.2.24+ (dovecot-pigeonhole-0.4.14+).
* Enable plugin `mail_crypt` to encrypts and decrypts mail. (requires Dovecot-2.2.27+).
* OpenLDAP: [Configure OpenLDAP with slapd.d instead of slapd.conf](https://bitbucket.org/zhb/iredmail/issue/31/switch-to-slapdd)
* LDAP backends:
* Migrate old mailing list (`objectClass=mailList`) to new mlmmj mailing
list, convert all old mailing lists to be groups which have ldap dn of
all members defined in ldap attribute `member` (or `memberdn`).
* [Configure OpenLDAP with slapd.d instead of slapd.conf](https://bitbucket.org/zhb/iredmail/issue/31/switch-to-slapdd)

View File

@ -313,7 +313,9 @@ Notes:
Parameter | Summary | Sample Usage
--- |--- |---
`name` | Display name | `name=My New Name`
`name` | Display name | `name=Michael Jordon`
`gn` | Given name | `gn=Jordon`
`sn` | Surname | `sn=Jeffery`
`password` | Password | `password=u0tBF82cIV@vi8Gme`
`quota` | Mailbox quota (in MB) | `quota=1024`
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`

View File

@ -871,7 +871,17 @@ to be a domain admin.</p>
<tr>
<td><code>name</code></td>
<td>Display name</td>
<td><code>name=My New Name</code></td>
<td><code>name=Michael Jordon</code></td>
</tr>
<tr>
<td><code>gn</code></td>
<td>Given name</td>
<td><code>gn=Jordon</code></td>
</tr>
<tr>
<td><code>sn</code></td>
<td>Surname</td>
<td><code>sn=Jeffery</code></td>
</tr>
<tr>
<td><code>password</code></td>

View File

@ -24,6 +24,7 @@
<li><a href="#done">DONE</a></li>
</ul>
</li>
<li><a href="#planned-changes-in-next-iredmail-iredadmin-pro-release">Planned changes in next iRedMail / iRedAdmin-Pro release</a></li>
<li><a href="#planned-changes-in-future-iredmail-release">Planned changes in future iRedMail release</a></li>
</ul>
</li>
@ -117,6 +118,10 @@
</ul>
</li>
</ul>
<h2 id="planned-changes-in-next-iredmail-iredadmin-pro-release">Planned changes in next iRedMail / iRedAdmin-Pro release</h2>
<ul>
<li>HIGH: <a href="https://bitbucket.org/zhb/iredmail/issues/14/allow-admin-to-set-vacation-for-user-with">#14 Allow domain admin to set vacation message for mail user</a></li>
</ul>
<h2 id="planned-changes-in-future-iredmail-release">Planned changes in future iRedMail release</h2>
<ul>
<li>
@ -145,7 +150,15 @@
<li>Enable plugin <code>mail_crypt</code> to encrypts and decrypts mail. (requires Dovecot-2.2.27+).</li>
</ul>
</li>
<li>OpenLDAP: <a href="https://bitbucket.org/zhb/iredmail/issue/31/switch-to-slapdd">Configure OpenLDAP with slapd.d instead of slapd.conf</a></li>
<li>
<p>LDAP backends:</p>
<ul>
<li>Migrate old mailing list (<code>objectClass=mailList</code>) to new mlmmj mailing
list, convert all old mailing lists to be groups which have ldap dn of
all members defined in ldap attribute <code>member</code> (or <code>memberdn</code>).</li>
<li><a href="https://bitbucket.org/zhb/iredmail/issue/31/switch-to-slapdd">Configure OpenLDAP with slapd.d instead of slapd.conf</a></li>
</ul>
</li>
</ul><div class="footer">
<p style="text-align: center; color: grey;">All documents are available in <a href="https://bitbucket.org/zhb/iredmail-docs/src">BitBucket repository</a>, and published under <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">Creative Commons</a> license. You can <a href="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 <a href="https://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
</div>