From 017f4a20be99071cd9f0599709de72f728a255fc Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Thu, 13 Jul 2017 00:09:49 +0800 Subject: [PATCH] Update iRedAdmin-Pro API doc. --- .../0-iredadmin-pro.restful.api.new.md | 27 +++++++++++ html/iredadmin-pro.restful.api.new.html | 46 +++++++++++++++++++ 2 files changed, 73 insertions(+) diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md index ab6bf369..54c7d341 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md @@ -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` in SQL table + `vmail.mailbox` must be present, if not, specified service name will + be silently ignored. diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html index 956132d1..20ffd3f7 100644 --- a/html/iredadmin-pro.restful.api.new.html +++ b/html/iredadmin-pro.restful.api.new.html @@ -920,8 +920,54 @@ to be a domain admin.

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.

    +
    • +
+