From 6be62b9068d219f0c9d174d093ffe147feb16b64 Mon Sep 17 00:00:00 2001
From: Zhang Huangbin
Date: Sat, 3 Nov 2018 22:46:04 +0100
Subject: [PATCH] Sync iRedAdmin-Pro API document.
---
en_US/cloud/cloud-changelog.md | 2 +-
en_US/iredadmin/0-iredadmin-pro.restful.api-new.md | 2 ++
html/cloud-changelog.html | 2 +-
html/iredadmin-pro.restful.api-new.html | 10 ++++++++++
4 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/en_US/cloud/cloud-changelog.md b/en_US/cloud/cloud-changelog.md
index d73cd0d0..d5621bd0 100644
--- a/en_US/cloud/cloud-changelog.md
+++ b/en_US/cloud/cloud-changelog.md
@@ -1,6 +1,6 @@
# Release Notes of iRedMail Cloud Platform
-## Changes in upcoming release (20181201)
+## Upcoming release (20181201)
* Add rc script and firewall rule for ipv6 on Debian/Ubuntu:
- /etc/init.d/ip6tables
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 e4f5ce23..3ec322fc 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
@@ -311,6 +311,7 @@ Notes:
`quota` | Mailbox quota (in MB) | `quota=1024`
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: . __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
+ `maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
@@ -342,6 +343,7 @@ Notes:
`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`
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: . __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
+ `maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
!!! attention
diff --git a/html/cloud-changelog.html b/html/cloud-changelog.html
index b4528e80..9a5c0cf3 100644
--- a/html/cloud-changelog.html
+++ b/html/cloud-changelog.html
@@ -16,7 +16,7 @@
iRedMail
// Document Index
-Changes in upcoming release (20181201)
+Upcoming release (20181201)
Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to Maildir . It's useful if you need to migrate to different mailbox folder. WARNING: New email will be stored in new mailbox folder immediately. |
mailboxFolder=Maildir |
+
+maildir |
+Absolute path of the mailbox. All characters will be converted to lower cases. |
+maildir=/var/vmail/vmail1/example.com/username |
+
@@ -1014,6 +1019,11 @@ to be a domain admin.
Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to Maildir . It's useful if you need to migrate to different mailbox folder. WARNING: New email will be stored in new mailbox folder immediately. |
mailboxFolder=Maildir |
+
+maildir |
+Absolute path of the mailbox. All characters will be converted to lower cases. |
+maildir=/var/vmail/vmail1/example.com/username |
+