From 9bc34c7e67fef0a127028035c25e155f4f9ecdcb Mon Sep 17 00:00:00 2001
From: Zhang Huangbin <Zhang Huangbin@localhost>
Date: Thu, 8 Mar 2018 12:33:43 +0800
Subject: [PATCH] Sync iRedAdmin-Pro RESTful API doc.

---
 .../0-iredadmin-pro.restful.api.new.md        |  4 ++++
 html/iredadmin-pro.restful.api.new.html       | 24 +++++++++++++++++++
 2 files changed, 28 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 2556005b..6ccad9e3 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
@@ -411,6 +411,8 @@ Notes:
     `accountStatus` | `accountStatus=active` | | Enable or disable account. Possible values: `active`, `disabled`.
     `maxMailSize` | `maxMailSize=1048576` (1M) | | Max message size (in bytes).
     `accessPolicy` | `accessPolicy=membersonly` | | Defines who can send email to this mailing list. Possible values: `public`, `domain`, `subdomain`, `membersonly`, `moderatorsonly`.
+    `is_newsletter` | `is_newsletter=yes` | `no` | Mark this mailing list as a newsletter, to enable subscription/unsubscription from web site.
+    `newsletter_description` | `newsletter_description=short description text` | | The short description text displayed on newsletter subscription page.
     `close_list` | `close_list=yes` | `no` | If set to `yes`, subscription and unsubscription via mail is disabled.
     `only_moderator_can_post` | `only_moderator_can_post=yes` | `no` | If set to `yes`, only moderators are allowed to post to it. The check is made against the `From:` header.
     `only_subscriber_can_post` | `only_subscriber_can_post=yes` | `yes` | If set to `yes`, only subscribed members are allowed to post to it. The check is made against the `From:` header.
@@ -463,6 +465,8 @@ Notes:
     `accountStatus` | `accountStatus=active` | | Enable or disable account. Possible values: `active`, `disabled`.
     `maxMailSize` | `maxMailSize=1048576` (1M) | | Max message size (in bytes).
     `accessPolicy` | `accessPolicy=membersonly` | | Defines who can send email to this mailing list. Possible values: `public`, `domain`, `subdomain`, `membersonly`, `moderatorsonly`.
+    `is_newsletter` | `is_newsletter=yes` | `no` | Mark this mailing list as a newsletter, to enable subscription/unsubscription from web site.
+    `newsletter_description` | `newsletter_description=short description text` | | The short description text displayed on newsletter subscription page.
     `close_list` | `close_list=yes` | `no` | If set to `yes`, subscription and unsubscription via mail is disabled.
     `only_moderator_can_post` | `only_moderator_can_post=yes` | `no` | If set to `yes`, only moderators are allowed to post to it. The check is made against the `From:` header.
     `only_subscriber_can_post` | `only_subscriber_can_post=yes` | `yes` | If set to `yes`, only subscribed members are allowed to post to it. The check is made against the `From:` header.
diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html
index 16dee485..b2b3b7d0 100644
--- a/html/iredadmin-pro.restful.api.new.html
+++ b/html/iredadmin-pro.restful.api.new.html
@@ -1139,6 +1139,18 @@ to be a domain admin.</p>
 <td>Defines who can send email to this mailing list. Possible values: <code>public</code>, <code>domain</code>, <code>subdomain</code>, <code>membersonly</code>, <code>moderatorsonly</code>.</td>
 </tr>
 <tr>
+<td><code>is_newsletter</code></td>
+<td><code>is_newsletter=yes</code></td>
+<td><code>no</code></td>
+<td>Mark this mailing list as a newsletter, to enable subscription/unsubscription from web site.</td>
+</tr>
+<tr>
+<td><code>newsletter_description</code></td>
+<td><code>newsletter_description=short description text</code></td>
+<td></td>
+<td>The short description text displayed on newsletter subscription page.</td>
+</tr>
+<tr>
 <td><code>close_list</code></td>
 <td><code>close_list=yes</code></td>
 <td><code>no</code></td>
@@ -1379,6 +1391,18 @@ to be a domain admin.</p>
 <td>Defines who can send email to this mailing list. Possible values: <code>public</code>, <code>domain</code>, <code>subdomain</code>, <code>membersonly</code>, <code>moderatorsonly</code>.</td>
 </tr>
 <tr>
+<td><code>is_newsletter</code></td>
+<td><code>is_newsletter=yes</code></td>
+<td><code>no</code></td>
+<td>Mark this mailing list as a newsletter, to enable subscription/unsubscription from web site.</td>
+</tr>
+<tr>
+<td><code>newsletter_description</code></td>
+<td><code>newsletter_description=short description text</code></td>
+<td></td>
+<td>The short description text displayed on newsletter subscription page.</td>
+</tr>
+<tr>
 <td><code>close_list</code></td>
 <td><code>close_list=yes</code></td>
 <td><code>no</code></td>