From 2c0ec022c89f31256f83eb92d69973506c138985 Mon Sep 17 00:00:00 2001
From: Zhang Huangbin
Date: Tue, 6 Mar 2018 08:17:44 +0800
Subject: [PATCH] Fix typo in mlmmj integration docs.
---
.../integrations/0-integration.mlmmj.ldap.md | 2 +-
.../integrations/0-integration.mlmmj.mysql.md | 2 +-
.../integrations/0-integration.mlmmj.pgsql.md | 2 +-
.../0-iredadmin-pro.restful.api.new.md | 28 +++++++++--
html/integration.mlmmj.ldap.html | 2 +-
html/integration.mlmmj.mysql.html | 2 +-
html/integration.mlmmj.pgsql.html | 2 +-
html/iredadmin-pro.restful.api.new.html | 47 +++++++++++++++++--
8 files changed, 74 insertions(+), 13 deletions(-)
diff --git a/en_US/integrations/0-integration.mlmmj.ldap.md b/en_US/integrations/0-integration.mlmmj.ldap.md
index f8bb4000..d81e3409 100644
--- a/en_US/integrations/0-integration.mlmmj.ldap.md
+++ b/en_US/integrations/0-integration.mlmmj.ldap.md
@@ -300,7 +300,7 @@ iredmail_ldap_bind_password = 'xxxxxxxx'
```
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
```
diff --git a/en_US/integrations/0-integration.mlmmj.mysql.md b/en_US/integrations/0-integration.mlmmj.mysql.md
index 276fb55c..cffabc5b 100644
--- a/en_US/integrations/0-integration.mlmmj.mysql.md
+++ b/en_US/integrations/0-integration.mlmmj.mysql.md
@@ -330,7 +330,7 @@ iredmail_sql_db_password = ''
```
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
```
diff --git a/en_US/integrations/0-integration.mlmmj.pgsql.md b/en_US/integrations/0-integration.mlmmj.pgsql.md
index 0d3d6258..6164d342 100644
--- a/en_US/integrations/0-integration.mlmmj.pgsql.md
+++ b/en_US/integrations/0-integration.mlmmj.pgsql.md
@@ -332,7 +332,7 @@ iredmail_sql_db_password = ''
```
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
```
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 a33cd42e..e545ee4b 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
@@ -392,12 +392,34 @@ Notes:
-### Mailing List {: .toggle }
+### Subscribable Mailing List {: .toggle }
!!! attention
- Mailing list is only available in OpenLDAP backend. For SQL backends,
- please use mail alias account as mailing list.
+ This subscribable mailing list is available for both SQL and LDAP backends,
+ it requires iRedMail-0.9.8 and later releases (it's implemented with
+ [`mlmmj`](http://mlmmj.org) mailing list manager).
+
+!!! api "`GET`{: .get } `/api/ml/`{: .url } `Get profile of an existing mailing list account`{: .comment }"
+!!! api "`POST`{: .post } `/api/ml/`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
+
+!!! api "`DELETE`{: .delete } `/api/ml/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
+
+
+
+ Parameter | Summary | Sample Usage
+ --- |--- |---
+ `keep_archive` | Archive subscribable mailing list before deleting the account. | `keep_archive=no`
+
+
+
+!!! api "`PUT`{: .put } `/api/ml/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
+
+### Mailing List (Unsubscribable, deprecated) {: .toggle }
+
+!!! attention
+
+ This unsubscribable mailing list is only available in __LDAP__ backend.
!!! api "`GET`{: .get } `/api/maillist/`{: .url } `Get profile of an existing mailing list account`{: .comment }"
!!! api "`POST`{: .post } `/api/maillist/`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
diff --git a/html/integration.mlmmj.ldap.html b/html/integration.mlmmj.ldap.html
index 48708511..909c144c 100644
--- a/html/integration.mlmmj.ldap.html
+++ b/html/integration.mlmmj.ldap.html
@@ -317,7 +317,7 @@ iredmail_ldap_bind_password = 'xxxxxxxx'
directory used to store mailing lists:
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
diff --git a/html/integration.mlmmj.mysql.html b/html/integration.mlmmj.mysql.html
index b86972c9..ec011e8c 100644
--- a/html/integration.mlmmj.mysql.html
+++ b/html/integration.mlmmj.mysql.html
@@ -345,7 +345,7 @@ iredmail_sql_db_password = '<password>'
directory used to store mailing lists:
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
diff --git a/html/integration.mlmmj.pgsql.html b/html/integration.mlmmj.pgsql.html
index 0bec229f..076d6f1a 100644
--- a/html/integration.mlmmj.pgsql.html
+++ b/html/integration.mlmmj.pgsql.html
@@ -347,7 +347,7 @@ iredmail_sql_db_password = '<password>'
directory used to store mailing lists:
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
-MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
+MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html
index 54831c4b..5c19365f 100644
--- a/html/iredadmin-pro.restful.api.new.html
+++ b/html/iredadmin-pro.restful.api.new.html
@@ -27,7 +27,8 @@
Domain
Domain Admin
Mail User
-Mailing List
+Subscribable Mailing List
+Mailing List (Unsubscribable, deprecated)
Mail Alias
Spam Policy
Throttling
@@ -1087,11 +1088,49 @@ to be a domain admin.
-Mailing List
+Subscribable Mailing List
Attention
-
Mailing list is only available in OpenLDAP backend. For SQL backends,
-please use mail alias account as mailing list.
+
This subscribable mailing list is available for both SQL and LDAP backends,
+it requires iRedMail-0.9.8 and later releases (it's implemented with
+mlmmj
mailing list manager).
+
+
+
+
POST
/api/ml/<mail>
Parameters
+
+
+
DELETE
/api/ml/<mail>
Parameters
+
+
+
+
+
+Parameter |
+Summary |
+Sample Usage |
+
+
+
+
+keep_archive |
+Archive subscribable mailing list before deleting the account. |
+keep_archive=no |
+
+
+
+
+
+
+
+
PUT
/api/ml/<mail>
Parameters
+
+Mailing List (Unsubscribable, deprecated)
+
+
Attention
+
This unsubscribable mailing list is only available in LDAP backend.