From 60bc2f8a635dfb5026b6c658aa26e60e6c5a8aef Mon Sep 17 00:00:00 2001
From: Zhang Huangbin
Date: Fri, 8 Mar 2019 16:32:43 +0800
Subject: [PATCH] Sync doc of iRedAdmin-Pro RESTful API.
---
.../0-iredadmin-pro.restful.api.new.md | 14 ++++++-
html/iredadmin-pro.restful.api.new.html | 38 ++++++++++++++++++-
2 files changed, 50 insertions(+), 2 deletions(-)
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 236a076c..5392108c 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
@@ -389,7 +389,7 @@ Notes:
Parameter | Default Value | Comment | Sample Usage
--- |--- |--- |---
`email_only` | `no` | Return a list of mail users' email addresses instead of detailed profiles. | `email_only=yes`
- `disabled_only` | `no` | Return only disabled mail domains | `disabled_only=yes`
+ `disabled_only` | `no` | Return only disabled mail users. | `disabled_only=yes`
@@ -643,6 +643,7 @@ Notes:
Parameter | Summary | Sample Usage
--- |--- |---
`name` | Display name | `name=My List Name`
+ `accountStatus` | Enable or disable domain. Valid values: `active`, `disabled`. | `accountStatus=active`
`accessPolicy` | Defines who can send email to this mail alias account | `accessPolicy=public`
`members` | Members of mail alias. Multiple members must be separated by comma. Conflict with parameter `addMember` and `removeMember`. | `members=user1@domain.com,user2@domain.com`
`addMember` | Add new members of mail alias. Multiple members must be separated by comma. Conflict with parameter `members`. | `addMember=user1@domain.com,user2@domain.com`
@@ -652,6 +653,17 @@ Notes:
!!! api "`POST`{: .put } `/api/alias//change_email/`{: .url } `Change email address of alias account (from '' to '')`{: .comment }"
+!!! api "`GET`{: .get } `/api/aliases/`{: .url } `Get mail aliases' profiles under given domain`{: .comment } `Parameters`{: .has_params }"
+
+
+
+ Parameter | Default Value | Comment | Sample Usage
+ --- |--- |--- |---
+ `email_only` | `no` | Return a list of mail aliases' email addresses instead of detailed profiles. | `email_only=yes`
+ `disabled_only` | `no` | Return only disabled mail aliases. | `disabled_only=yes`
+
+
+
### Spam Policy {: .toggle }
!!! api "`GET`{: .get } `/api/spampolicy/global`{: .url } `Get global spam policy`{: .comment }"
diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html
index c6251ef5..1f99d8ad 100644
--- a/html/iredadmin-pro.restful.api.new.html
+++ b/html/iredadmin-pro.restful.api.new.html
@@ -1097,7 +1097,7 @@ to be a domain admin.
disabled_only |
no |
-Return only disabled mail domains |
+Return only disabled mail users. |
disabled_only=yes |
@@ -1964,6 +1964,11 @@ to be a domain admin.
name=My List Name |
+accountStatus |
+Enable or disable domain. Valid values: active , disabled . |
+accountStatus=active |
+
+
accessPolicy |
Defines who can send email to this mail alias account |
accessPolicy=public |
@@ -1990,6 +1995,37 @@ to be a domain admin.
POST
/api/alias/<mail>/change_email/<new_mail>
+
+
+
GET
/api/aliases/<domain>
Parameters
+
+
+
+
+
+Parameter |
+Default Value |
+Comment |
+Sample Usage |
+
+
+
+
+email_only |
+no |
+Return a list of mail aliases' email addresses instead of detailed profiles. |
+email_only=yes |
+
+
+disabled_only |
+no |
+Return only disabled mail aliases. |
+disabled_only=yes |
+
+
+
+
+
Spam Policy