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

Update iRedAdmin-Pro API doc.

This commit is contained in:
Zhang Huangbin 2017-07-13 00:09:49 +08:00
parent cb3d04d850
commit 017f4a20be
2 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
View File

@ -323,6 +323,33 @@ Notes:
`aliases` | 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 `addAlias` and `removeAlias`. | `aliases=user1@domain.com,user2@domain.com,user3@domain.com`
`addAlias` | Add new per-user alias addresses. Multiple addresses must be separated by comma. Conflicts with parameter `aliases`. | `aliases=user1@domain.com,user2@domain.com,user3@domain.com`
`removeAlias` | Remove existing per-user alias addresses. Multiple addresses must be separated by comma. Conflicts with parameter `aliases`. | `aliases=user1@domain.com,user2@domain.com,user3@domain.com`
`services` | Reset per-user enabled mail services to given values. Conflicts with parameter `addService` and `removeService`. See additional notes below. | `services=mail,smtp,pop3,imap`
`addService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `addService=vpn,owncloud`
`removeService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `removeService=forward,senderbcc`
!!! attention
Notes about `services`, `addService`, `removeService` parameters:
* Available service names in iRedMail:
* smtp
* smtpsecured (SMTP over TLS or SSL)
* pop3
* pop3secured (POP3 over TLS or SSL)
* imap
* imapsecured (IMAP over TLS or SSL)
* managesieve
* managesievesecured (Managesieve over TLS or SSL)
* deliver (deliver received email to local mailbox)
* sogo (SOGo groupware)
* For LDAP backends, you're free to add custom service names, because
the LDAP attribute name used to store service names supports storing
multiple values and we don't need to change LDAP schema.
* For SQL backends, column `enable<service>` in SQL table
`vmail.mailbox` must be present, if not, specified service name will
be silently ignored.
</div>

46
html/iredadmin-pro.restful.api.new.html
View File

@ -920,8 +920,54 @@ to be a domain admin.</p>
<td>Remove existing per-user alias addresses. Multiple addresses must be separated by comma. Conflicts with parameter <code>aliases</code>.</td>
<td><code>aliases=user1@domain.com,user2@domain.com,user3@domain.com</code></td>
</tr>
<tr>
<td><code>services</code></td>
<td>Reset per-user enabled mail services to given values. Conflicts with parameter <code>addService</code> and <code>removeService</code>. See additional notes below.</td>
<td><code>services=mail,smtp,pop3,imap</code></td>
</tr>
<tr>
<td><code>addService</code></td>
<td>Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter <code>services</code>. See additional notes below.</td>
<td><code>addService=vpn,owncloud</code></td>
</tr>
<tr>
<td><code>removeService</code></td>
<td>Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter <code>services</code>. See additional notes below.</td>
<td><code>removeService=forward,senderbcc</code></td>
</tr>
</tbody>
</table>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Notes about <code>services</code>, <code>addService</code>, <code>removeService</code> parameters:</p>
<ul>
<li>
<p>Available service names in iRedMail:</p>
<ul>
<li>smtp</li>
<li>smtpsecured (SMTP over TLS or SSL)</li>
<li>pop3</li>
<li>pop3secured (POP3 over TLS or SSL)</li>
<li>imap</li>
<li>imapsecured (IMAP over TLS or SSL)</li>
<li>managesieve</li>
<li>managesievesecured (Managesieve over TLS or SSL)</li>
<li>deliver (deliver received email to local mailbox)</li>
<li>sogo (SOGo groupware)</li>
</ul>
</li>
<li>
<p>For LDAP backends, you're free to add custom service names, because
the LDAP attribute name used to store service names supports storing
multiple values and we don't need to change LDAP schema.</p>
</li>
<li>
<p>For SQL backends, column <code>enable&lt;service&gt;</code> in SQL table
<code>vmail.mailbox</code> must be present, if not, specified service name will
be silently ignored.</p>
</li>
</ul>
</div>
</div>
</div>