From 6c40ebfc89b830f4dcd5b233df3ed12750f694f6 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Thu, 21 Apr 2016 00:08:59 +0800 Subject: [PATCH] Update iredadmin-pro.restful.api.html with some new APIs. --- en_US/faq/2-iredadmin-pro.restful.api.md | 23 ++++++--- html/iredadmin-pro.restful.api.html | 61 ++++++++++++++++++++---- 2 files changed, 69 insertions(+), 15 deletions(-) diff --git a/en_US/faq/2-iredadmin-pro.restful.api.md b/en_US/faq/2-iredadmin-pro.restful.api.md index 28d24bb7..e8759469 100644 --- a/en_US/faq/2-iredadmin-pro.restful.api.md +++ b/en_US/faq/2-iredadmin-pro.restful.api.md @@ -82,7 +82,7 @@ Possible `PUT` parameters used to update account profile: Parameter Name | Summary | Sample Usage --- |--- |--- `cn` | display name | `cn=My List Name` -`accessPolicy` | access policy | `accessPolicy=public` +`accessPolicy` | Defines who can send email to this mailing list | `accessPolicy=public` ### Mail Alias @@ -97,19 +97,28 @@ Possible `PUT` parameters used to update account profile: Parameter Name | Summary | Sample Usage --- |--- |--- `cn` | display name | `cn=My List Name` -`accessPolicy` | access policy | `accessPolicy=public` +`accessPolicy` | Defines who can send email to this mail alias account | `accessPolicy=public` -> Note: `accessPolicy` is available for only SQL backends. +> Note: `accessPolicy` for mail alias account is available for only SQL backends. ### Throttling URL | HTTP Method | Summary --- |---| --- -/api/throttle/global | GET | Get global inbound and outbound throttle settings -/api/throttle/inbound | POST | Set global inbound throttle setting -/api/throttle/outbound | POST | Set global outbound throttle setting +/api/throttle/global/inbound | GET | Get global inbound throttle settings +/api/throttle/global/outbound | GET | Get global outbound throttle settings +/api/throttle/global/inbound | POST | Set global inbound throttle setting +/api/throttle/global/outbound | POST | Set global outbound throttle setting +/api/throttle//inbound | GET | Get domain inbound throttle settings +/api/throttle//outbound | GET | Get domain outbound throttle settings +/api/throttle//inbound | POST | Set domain inbound throttle setting +/api/throttle//outbound | POST | Set domain outbound throttle setting +/api/throttle//inbound | GET | Get user inbound throttle settings +/api/throttle//outbound | GET | Get user outbound throttle settings +/api/throttle//inbound | POST | Set user inbound throttle setting +/api/throttle//outbound | POST | Set user outbound throttle setting -Possible `POST` parameters used to set throttling: +Possible `POST` parameters used to set throttle setting: Parameter Name | Summary | Sample Usage --- |--- |--- diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index cb926749..06aa1e45 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -242,7 +242,7 @@ account as mailing list.

accessPolicy -access policy +Defines who can send email to this mailing list accessPolicy=public @@ -291,13 +291,13 @@ account as mailing list.

accessPolicy -access policy +Defines who can send email to this mail alias account accessPolicy=public
-

Note: accessPolicy is available for only SQL backends.

+

Note: accessPolicy for mail alias account is available for only SQL backends.

Throttling

@@ -310,23 +310,68 @@ account as mailing list.

- + - + - + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
/api/throttle/global/api/throttle/global/inbound GETGet global inbound and outbound throttle settingsGet global inbound throttle settings
/api/throttle/inbound/api/throttle/global/outboundGETGet global outbound throttle settings
/api/throttle/global/inbound POST Set global inbound throttle setting
/api/throttle/outbound/api/throttle/global/outbound POST Set global outbound throttle setting
/api/throttle/<domain>/inboundGETGet domain inbound throttle settings
/api/throttle/<domain>/outboundGETGet domain outbound throttle settings
/api/throttle/<domain>/inboundPOSTSet domain inbound throttle setting
/api/throttle/<domain>/outboundPOSTSet domain outbound throttle setting
/api/throttle/<mail>/inboundGETGet user inbound throttle settings
/api/throttle/<mail>/outboundGETGet user outbound throttle settings
/api/throttle/<mail>/inboundPOSTSet user inbound throttle setting
/api/throttle/<mail>/outboundPOSTSet user outbound throttle setting
-

Possible POST parameters used to set throttling:

+

Possible POST parameters used to set throttle setting: