From 0adb0d4762bdead8014414eb390c4919f1489b58 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Tue, 30 Jan 2018 01:43:14 +0800 Subject: [PATCH] Update iRedAdmin-Pro API document: able to manage alias domains with new parameters: - addAliasDomain: Add new alias domains. - removeAliasDomain: Remove existing alias domains. - aliasDomains: Reset all alias domains. If empty, all existing alias domains will be removed. --- .../iredadmin/0-iredadmin-pro.restful.api.new.md | 3 +++ html/iredadmin-pro.restful.api.new.html | 15 +++++++++++++++ 2 files changed, 18 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 feedd327..8055b182 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md @@ -138,6 +138,9 @@ Notes: `primarymx` | Hostname or IP address of primary MX, smtp port number is optional. Must be used with parameter `is_backupmx`. Conflicts with parameter `transport`. | `primarymx=202.96.134.133`, `primarymx=[mail.iredmail.org]:25` `catchall` | Per-domain catch-all account (a list of email addresses used to receive emails sent to non-existing addresses under same domain). Multiple addresses must be separated by comma. Set an empty value to disable catch-all support. | `catchall=user@domain.com,user2@domain.com` or `catchall=` (disable catch-all) `outboundRelay` | Per-domain outbound relay. Set an empty value to disable outbound relay. | `outboundRelay=smtp:[192.168.1.2]:25` or `outboundRelay=` (disable outbound relay) + `addAliasDomain` | Add new alias domains. Multiple services must be separated by comma. | `addAliasDomain=alias1.com,alias2.com` + `removeAliasDomain` | Remove existing alias domains. Multiple services must be separated by comma. | `removeAllServices=alias1.com,alias2.com` + `aliasDomains` | Reset all alias domains. If empty, all existing alias domains will be removed. Conflicts with parameter `addAliasDomain` and `removeAliasDomain`. | `aliasDomains=alias1.com,alias2.com` `addService` | Enable new services. Multiple services must be separated by comma. Available services are listed below. | `addService=self-service` `removeService` | Disable existing services. Multiple services must be separated by comma. Available services are listed below. | `removeService=self-service` `services` | Reset all services. If empty, all existing services will be removed. | `services=mail,self-service` diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html index 71c14e8f..bf4fce49 100644 --- a/html/iredadmin-pro.restful.api.new.html +++ b/html/iredadmin-pro.restful.api.new.html @@ -349,6 +349,21 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] outboundRelay=smtp:[192.168.1.2]:25 or outboundRelay= (disable outbound relay) +addAliasDomain +Add new alias domains. Multiple services must be separated by comma. +addAliasDomain=alias1.com,alias2.com + + +removeAliasDomain +Remove existing alias domains. Multiple services must be separated by comma. +removeAllServices=alias1.com,alias2.com + + +aliasDomains +Reset all alias domains. If empty, all existing alias domains will be removed. Conflicts with parameter addAliasDomain and removeAliasDomain. +aliasDomains=alias1.com,alias2.com + + addService Enable new services. Multiple services must be separated by comma. Available services are listed below. addService=self-service