Sync iRedAdmin-Pro API doc.

This commit is contained in:
Zhang Huangbin 2017-08-16 12:59:02 +08:00
parent 701334fd54
commit 3cc70ff7a2
4 changed files with 62 additions and 13 deletions

View File

@ -605,6 +605,23 @@ Notes:
## ChangeLog
### iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0
+ NEW: Able to list all managed domains (/domains).
+ NEW: Able to manage per-usre enabled mail services (/user/<mail>).
+ NEW: Able to promote mail user to be a global admin (/user/<mail>).
+ Enhancement: Return managed domain names while getting user (must
have admin privilege) or admin profile.
* Fixed issues:
* It always requires password while updating domain admin profile.
* iRedAdmin-Pro-LDAP-3.0:
* LDAP attribute 'accountSetting' is now converted to a Python dictionary in returned JSON.
* Old value: `{'accountSetting': ['create_new_domains:yes', 'create_max_domains:5', ...], ...}`
* New value: `{'accountSetting': {'create_new_domains': 'yes', 'create_max_domains': 5, ...}}`
### iRedAdmin-Pro-SQL-2.7.0, iRedAdmin-Pro-LDAP-2.9.0
* New: Able to manage global, per-domain and per-user greylisting settings,

View File

@ -4,7 +4,6 @@ Port | Service | Software | Comment | Allow Public Access?
--- |--- |--- |--- |---
25 | smtp | Postfix | Normal smtp service, used for server-to-server communication. | YES
587 | submission | Postfix | a.k.a. SMTP over TLS. Used by end users to send/submit email. | YES (open to your end users)
465 | smtps | Postfix | a.k.a. SMTP over SSL. Deprecated and disabled by default, please use port 587 instead. | YES (open to your end users)
110 | pop3 | Dovecot | Used by end users to retrieve emails via POP3 protocol, secure connection over STARTTLS is available by default. | YES (open to your end users)
995 | pop3s | Dovecot | Used by end users to restrieve emails via POP3 protocol over SSL. Port 110 with STARTTLS is recommended. | YES (open to your end users)
143 | imap |Dovecot | Used by end users to retrieve emails via IMAP protocol, secure connection over STARTTLS is available by default. | YES (open to your end users)
@ -23,6 +22,9 @@ Port | Service | Software | Comment | Allow Public Access?
!!! note
In iRedMail-0.9.2 and earlier releases, Policyd or Cluebringer listens on
port 10031. They have been removed in iRedMail-0.9.3, and replaced by
iRedAPD.
* In iRedMail-0.9.2 and earlier releases, Policyd or Cluebringer listens on
port 10031. They have been removed in iRedMail-0.9.3, and replaced by
iRedAPD.
* Port 465, a.k.a. SMTP over SSL, has been deprecated for years. Please use
port 587 instead.

View File

@ -39,6 +39,7 @@
</ul>
</li>
<li><a href="#changelog">ChangeLog</a><ul>
<li><a href="#iredadmin-pro-sql-280-iredadmin-pro-ldap-30">iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0</a></li>
<li><a href="#iredadmin-pro-sql-270-iredadmin-pro-ldap-290">iRedAdmin-Pro-SQL-2.7.0, iRedAdmin-Pro-LDAP-2.9.0</a></li>
<li><a href="#iredadmin-pro-sql-260-iredadmin-pro-ldap-280">iRedAdmin-Pro-SQL-2.6.0, iRedAdmin-Pro-LDAP-2.8.0</a></li>
</ul>
@ -1587,6 +1588,34 @@ please use mail alias account as mailing list.</p>
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/alias/&lt;mail&gt;</code> <code class="comment">Export mail alias account to LDIF</code></p>
</div>
<h2 id="changelog">ChangeLog</h2>
<h3 id="iredadmin-pro-sql-280-iredadmin-pro-ldap-30">iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0</h3>
<ul>
<li>NEW: Able to list all managed domains (/domains).</li>
<li>NEW: Able to manage per-usre enabled mail services (/user/<mail>).</li>
<li>NEW: Able to promote mail user to be a global admin (/user/<mail>).</li>
<li>
<p>Enhancement: Return managed domain names while getting user (must
have admin privilege) or admin profile.</p>
</li>
<li>
<p>Fixed issues:</p>
<ul>
<li>It always requires password while updating domain admin profile.</li>
</ul>
</li>
<li>
<p>iRedAdmin-Pro-LDAP-3.0:</p>
<ul>
<li>
<p>LDAP attribute 'accountSetting' is now converted to a Python dictionary in returned JSON.</p>
<ul>
<li>Old value: <code>{'accountSetting': ['create_new_domains:yes', 'create_max_domains:5', ...], ...}</code></li>
<li>New value: <code>{'accountSetting': {'create_new_domains': 'yes', 'create_max_domains': 5, ...}}</code></li>
</ul>
</li>
</ul>
</li>
</ul>
<h3 id="iredadmin-pro-sql-270-iredadmin-pro-ldap-290">iRedAdmin-Pro-SQL-2.7.0, iRedAdmin-Pro-LDAP-2.9.0</h3>
<ul>
<li>New: Able to manage global, per-domain and per-user greylisting settings,

View File

@ -42,13 +42,6 @@
<td>YES (open to your end users)</td>
</tr>
<tr>
<td>465</td>
<td>smtps</td>
<td>Postfix</td>
<td>a.k.a. SMTP over SSL. Deprecated and disabled by default, please use port 587 instead.</td>
<td>YES (open to your end users)</td>
</tr>
<tr>
<td>110</td>
<td>pop3</td>
<td>Dovecot</td>
@ -157,9 +150,17 @@
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul>
<li>
<p>In iRedMail-0.9.2 and earlier releases, Policyd or Cluebringer listens on
port 10031. They have been removed in iRedMail-0.9.3, and replaced by
iRedAPD.</p>
port 10031. They have been removed in iRedMail-0.9.3, and replaced by
iRedAPD.</p>
</li>
<li>
<p>Port 465, a.k.a. SMTP over SSL, has been deprecated for years. Please use
port 587 instead.</p>
</li>
</ul>
</div><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="http://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
</div>