From f29215e1f4afac2893ae0aaec1fd8c60a638e173 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Thu, 25 May 2017 00:15:47 +0800 Subject: [PATCH] Sync iRedAdmin-Pro API document. --- .../0-iredadmin-pro.restful.api.upcoming.md | 19 +++++---- html/iredadmin-pro.restful.api.upcoming.html | 41 +++++++++++-------- 2 files changed, 36 insertions(+), 24 deletions(-) diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md b/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md index 9ae48728..affe8bcd 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md @@ -443,14 +443,14 @@ Notes: ### Spam Policy {: .toggle } !!! api "`GET`{: .get } `/api/spampolicy/global`{: .url } `Get global spam policy`{: .comment }" -!!! api "`PUT`{: .put } `/api/spampolicy/global`{: .url } `Set global spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }" -!!! api "`DELETE`{: .delete } `/api/spampolicy/global`{: .url } `Delete global spam policy`{: .comment }" !!! api "`GET`{: .get } `/api/spampolicy/domain/`{: .url } `Get per-domain spam policy`{: .comment }" -!!! api "`PUT`{: .put } `/api/spampolicy/domain/`{: .url } `Set per-domain spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }" -!!! api "`DELETE`{: .delete } `/api/spampolicy/domain/`{: .url } `Delete per-domain spam policy`{: .comment }" !!! api "`GET`{: .get } `/api/spampolicy/user/`{: .url } `Get per-user spam policy`{: .comment }" -!!! api "`PUT`{: .put } `/api/spampolicy/user/`{: .url } `Set per-user spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }" +!!! api "`DELETE`{: .delete } `/api/spampolicy/global`{: .url } `Delete global spam policy`{: .comment }" +!!! api "`DELETE`{: .delete } `/api/spampolicy/domain/`{: .url } `Delete per-domain spam policy`{: .comment }" !!! api "`DELETE`{: .delete } `/api/spampolicy/user/`{: .url } `Delete per-user spam policy`{: .comment }" +!!! api "`PUT`{: .put } `/api/spampolicy/global`{: .url } `Set global spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }" +!!! api "`PUT`{: .put } `/api/spampolicy/domain/`{: .url } `Set per-domain spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }" +!!! api "`PUT`{: .put } `/api/spampolicy/user/`{: .url } `Set per-user spam policy`{: .comment } `Parameters`{: .has_params_spampolicy }"
@@ -525,6 +525,7 @@ Notes: !!! api "`DELETE`{: .delete } `/api/greylisting/global`{: .url } `Delete global greylisting setting`{: .comment }" !!! api "`DELETE`{: .delete } `/api/greylisting/`{: .url } `Delete per-domain greylisting setting`{: .comment }" !!! api "`DELETE`{: .delete } `/api/greylisting/`{: .url } `Delete per-user greylisting setting`{: .comment }" +!!! api "`GET`{: .get } `/api/greylisting/global/whitelists`{: .url } `Get globally whitelisted senders for greylisting service`{: .comment }" !!! api "`POST`{: .post } `/api/greylisting/global/whitelists`{: .url } `Whitelist senders for greylisting service globally`{: .comment } `Parameters`{: .has_params }"
@@ -534,9 +535,9 @@ Notes: `whitelistSenderDomains` | Reset whitelisted sender domains for global greylisting service to given sender domains. __Note: given sender domain names are not used directly while checking whitelisting, instead, there's a cron job to query SPF and MX DNS records of given sender domains, then whitelist the IP addresses/networks listed in DNS records.__ Multiple domains must be separated by comma. | `whitelistSenderDomains=iredmail.org,gmail.com` `addWhitelistSenderDomain` | Add new whitelist sender domains for global greylisting service. __Note: given sender domain names are not used directly while checking whitelisting, instead, there's a cron job to query SPF and MX DNS records of given sender domains, then whitelist the IP addresses/networks listed in DNS records.__ Multiple domains must be separated by comma. | `addWhitelistSenderDomain=iredmail.org,gmail.com` `removeWhitelistSenderDomain` | Remove existing whitelisted sender domains for global greylisting service. __Note: given sender domain names are not used directly while checking whitelisting, instead, there's a cron job to query SPF and MX DNS records of given sender domains, then whitelist the IP addresses/networks listed in DNS records.__ Multiple domains must be separated by comma. | `removeWhitelistSenderDomain=iredmail.org,gmail.com` - `whitelistSenders` | Reset whitelisted senders for global greylisting service to given senders. Multiple addresses must be separated by comma. Conflicts with parameter `addWhitelistSender` and `removeWhitelistSender`. | `whitelistSenders=192.168.1.0/24,172.16.10.1` - `addWhitelistSender` | Whitelist new senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter `whitelistSenders`. | `addWhitelistSender=192.168.1.0/24` - `removeWhitelistSender` | Remove existing whitelisted senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter `whitelistSenders`. | `removeWhitelistSender=192.168.1.0/24` + `whitelistSenders` | Reset whitelisted senders for global greylisting service to given senders. Multiple addresses must be separated by comma. Conflicts with parameter `addWhitelistSender` and `removeWhitelistSender`. | `whitelistSenders=192.168.1.0/24,172.16.10.1,@example.com` + `addWhitelistSender` | Whitelist new senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter `whitelistSenders`. | `addWhitelistSender=192.168.1.0/24,@example.com` + `removeWhitelistSender` | Remove existing whitelisted senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter `whitelistSenders`. | `removeWhitelistSender=192.168.1.0/24,@example.com` Valid sender address formats: @@ -550,6 +551,7 @@ Notes:
+!!! api "`GET`{: .get } `/api/greylisting//whitelists`{: .url } `Get whitelisted senders for greylisting service for specified domain`{: .comment }" !!! api "`POST`{: .post } `/api/greylisting//whitelists`{: .url } `Whitelist senders for greylisting service for specified domain`{: .comment } `Parameters`{: .has_params }"
@@ -572,6 +574,7 @@ Notes:
+!!! api "`GET`{: .get } `/api/greylisting//whitelists`{: .url } `Get whitelisted senders for greylisting service for specified user`{: .comment }" !!! api "`POST`{: .post } `/api/greylisting//whitelists`{: .url } `Whitelist senders for greylisting services for specified user`{: .comment } `Parameters`{: .has_params }"
diff --git a/html/iredadmin-pro.restful.api.upcoming.html b/html/iredadmin-pro.restful.api.upcoming.html index 65777556..ada47659 100644 --- a/html/iredadmin-pro.restful.api.upcoming.html +++ b/html/iredadmin-pro.restful.api.upcoming.html @@ -1179,28 +1179,28 @@ please use mail alias account as mailing list.

GET /api/spampolicy/global Get global spam policy

-

PUT /api/spampolicy/global Set global spam policy Parameters

-
-
-

DELETE /api/spampolicy/global Delete global spam policy

-
-

GET /api/spampolicy/domain/<domain> Get per-domain spam policy

-

PUT /api/spampolicy/domain/<domain> Set per-domain spam policy Parameters

-
-
-

DELETE /api/spampolicy/domain/<domain> Delete per-domain spam policy

-
-

GET /api/spampolicy/user/<mail> Get per-user spam policy

-

PUT /api/spampolicy/user/<mail> Set per-user spam policy Parameters

+

DELETE /api/spampolicy/global Delete global spam policy

+
+
+

DELETE /api/spampolicy/domain/<domain> Delete per-domain spam policy

DELETE /api/spampolicy/user/<mail> Delete per-user spam policy

+
+
+

PUT /api/spampolicy/global Set global spam policy Parameters

+
+
+

PUT /api/spampolicy/domain/<domain> Set per-domain spam policy Parameters

+
+
+

PUT /api/spampolicy/user/<mail> Set per-user spam policy Parameters

Parameters available for global, per-domain, per-user spam policies.

@@ -1402,6 +1402,9 @@ please use mail alias account as mailing list.

DELETE /api/greylisting/<mail> Delete per-user greylisting setting

+

GET /api/greylisting/global/whitelists Get globally whitelisted senders for greylisting service

+
+

POST /api/greylisting/global/whitelists Whitelist senders for greylisting service globally Parameters

@@ -1432,17 +1435,17 @@ please use mail alias account as mailing list.

whitelistSenders Reset whitelisted senders for global greylisting service to given senders. Multiple addresses must be separated by comma. Conflicts with parameter addWhitelistSender and removeWhitelistSender. -whitelistSenders=192.168.1.0/24,172.16.10.1 +whitelistSenders=192.168.1.0/24,172.16.10.1,@example.com addWhitelistSender Whitelist new senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter whitelistSenders. -addWhitelistSender=192.168.1.0/24 +addWhitelistSender=192.168.1.0/24,@example.com removeWhitelistSender Remove existing whitelisted senders for greylisting service globally. Multiple addresses must be separated by comma. Conflicts with parameter whitelistSenders. -removeWhitelistSender=192.168.1.0/24 +removeWhitelistSender=192.168.1.0/24,@example.com @@ -1479,6 +1482,9 @@ please use mail alias account as mailing list.

+
+
+

GET /api/greylisting/<domain>/whitelists Get whitelisted senders for greylisting service for specified domain

POST /api/greylisting/<domain>/whitelists Whitelist senders for greylisting service for specified domain Parameters

@@ -1543,6 +1549,9 @@ please use mail alias account as mailing list.

+
+
+

GET /api/greylisting/<mail>/whitelists Get whitelisted senders for greylisting service for specified user

POST /api/greylisting/<mail>/whitelists Whitelist senders for greylisting services for specified user Parameters