Sync iRedAdmin-Pro RESTful API doc.
This commit is contained in:
Zhang Huangbin
parent
2c0ec022c8
commit
5baaa2b7ea
|
|
@ -392,34 +392,116 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
### Subscribable Mailing List {: .toggle }
|
||||
### [NEW] Subscribable Mailing List {: .toggle }
|
||||
|
||||
!!! attention
|
||||
|
||||
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).
|
||||
* Subscribable mailing list requires iRedMail-0.9.8 and later releases,
|
||||
it's implemented with [`mlmmj`](http://mlmmj.org) mailing list manager.
|
||||
* It's available for both SQL and LDAP backends.
|
||||
|
||||
!!! api "`GET`{: .get } `/api/ml/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment }"
|
||||
!!! api "`POST`{: .post } `/api/ml/<mail>`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`name` | `name=Sales Team` | | Display name of the mailing list.
|
||||
`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`.
|
||||
`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.
|
||||
`disable_subscription` | `disable_subscription=yes` | `no` | If set to `yes`, subscription is disabled, but unsubscription is still possible.
|
||||
`disable_subscription_confirm` | `disable_subscription_confirm=yes` | | If set to `yes`, mlmmj won't send mail to subscriber to ask for confirmation to subscribe to the list. __WARNING__: This should in principle never ever be used, but there are times on local lists etc. where this is useful. HANDLE WITH CARE!
|
||||
`disable_digest_subscription` | `disable_digest_subscription=yes` | | If set to `yes`, subscription to the digest version of the mailing list is disabled. Useful if you don't want to allow digests and notify users about it.
|
||||
`disable_digest_text` | `disable_digest_text=yes` | | If set to `yes`, digest mails won't have a text part with a thread summary.
|
||||
`disable_nomail_subscription` | `disable_nomail_subscription=yes` | | If set to `yes`, subscription to the 'nomail' version of the mailing list is disabled. Useful if you don't want to allow 'nomail' and notify users about it.
|
||||
`moderated` | `moderated=yes` | `no` | If set to `yes`. Parameter `owner` __or__ `moderators` is required to specify the moderators. Note: `moderators` has higher priority (means only addresses specified by `moderators` are act as moderators).
|
||||
`moderate_non_subscriber_post` | `moderate_non_subscriber_post=no` | `no` | If set to `yes`, all postings from people who are not allowed to post to the list will be moderated. Default (set to `no`) is denied.
|
||||
`disable_retrieving_old_posts` | `disable_retrieving_old_posts=yes` | | If set to `yes`, retrieving old posts by sending email to address `<listname>+get-N@` is disabled.
|
||||
`only_subscriber_can_get_old_posts` | `only_subscriber_can_get_old_posts=no` | `yes` | If set to `yes`, only subscribers can retrieve old posts by sending email to `LISTNAME+get-N@`
|
||||
`disable_retrieving_subscribers` | `disable_retrieving_subscribers=yes` | `yes` | If set to `yes`, (owner) retrieving subscribers by sending email to `LISTNAME+list@` is disabled. Note: only owner can send to such address.
|
||||
`disable_send_copy_to_sender` | `disable_send_copy_to_sender=yes` | `yes` | If set to `yes`, senders won't receive copies of their own posts.
|
||||
`notify_owner_when_sub_unsub` | `notify_owner_when_sub_unsub=no` | `no` | Notify the owner(s) when someone sub/unsubscribing to a mailing list.
|
||||
`notify_sender_when_moderated` | `notify_sender_when_moderated=no` | `no` | Notify sender (based on the envelope from) when their post is being moderated.
|
||||
`disable_archive` | `disable_archive=yes` | `no` | If set to `yes`, emails won't be saved in the archive but simply deleted.
|
||||
`moderate_subscription` | `moderate_subscription=yes` | `no` | If set to `yes`, subscription will be moderated by owner(s) or moderators specified by `subscription_moderators`. Moderators specified by `subscription_moderators` has higher priority. If set to `no`, subscription is not moderated, also, all moderators which were specified by `subscription_moderators` will be removed.
|
||||
`extra_addresses` | `extra_addresses=extra1@domain.com,extra2@domain.com` | | Define extra addresses of the mailing list.
|
||||
`subscription_moderators` | `subscription_moderators=<mail1>,<mail2>,<mail3>` | | Specify subscription moderators. Note: if `subscription_moderators` is given, `moderate_subscription` will be set to `yes` automatically. If no valid moderators are given, subscription will be moderated by owner(s).
|
||||
`owner` | `owner=<mail1>,<mail2>,<mail3>` | | Define owner(s) of the mailing list. Owners will get mails sent to `<listname>+owner@<domain.com>`.
|
||||
`moderators` | `moderators=<mail1>,<mail2>` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
|
||||
`maxmailsize` | `maxmailsize=10240` | | Specify max mail message size in __bytes__.
|
||||
`subject_prefix` | `subject_prefix=[prefix text]` | | Add a prefix in the `Subject:` line of mails sent to the list. Set to empty value to remove it.
|
||||
`custom_headers` | `custom_headers=<header1>:<value1>\n<header2>:<value2>` | | Add custom headers to every mail coming through. Multiple headers must be separated by `\n`. Set empty value to remove it. Note: mlmmjadmin will always add `X-Mailing-List: <mail>` and `Reply-To: <mail>` for each mailing list account.
|
||||
`remove_headers` | `remove_headers=Message-ID,Received` | | Remove given mail headers. NOTE: either `header:` or `header` (without `:`) is ok. Note: mlmmjadmin will always remove `DKIM-Signature:` and `Authentication-Results:`.
|
||||
`name` | `name=Short description of list` | | Set a short description of the mailing list account.
|
||||
`footer_text` | `footer_text=footer in plain text` | | Append footer (in plain text format) to every email sent to the list.
|
||||
`footer_html` | `footer_text=<p>footer in html</p>` | | Append footer (in html format) to every email sent to the list.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`DELETE`{: .delete } `/api/ml/<mail>`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`keep_archive` | Archive subscribable mailing list before deleting the account. | `keep_archive=no`
|
||||
`keep_archive` | Archive account settings and messages before deleting the mailing list. | `keep_archive=no`
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`PUT`{: .put } `/api/ml/<mail>`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
### Mailing List (Unsubscribable, deprecated) {: .toggle }
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`name` | `name=Sales Team` | | Display name of the mailing list.
|
||||
`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`.
|
||||
`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.
|
||||
`disable_subscription` | `disable_subscription=yes` | `no` | If set to `yes`, subscription is disabled, but unsubscription is still possible.
|
||||
`disable_subscription_confirm` | `disable_subscription_confirm=yes` | | If set to `yes`, mlmmj won't send mail to subscriber to ask for confirmation to subscribe to the list. __WARNING__: This should in principle never ever be used, but there are times on local lists etc. where this is useful. HANDLE WITH CARE!
|
||||
`disable_digest_subscription` | `disable_digest_subscription=yes` | | If set to `yes`, subscription to the digest version of the mailing list is disabled. Useful if you don't want to allow digests and notify users about it.
|
||||
`disable_digest_text` | `disable_digest_text=yes` | | If set to `yes`, digest mails won't have a text part with a thread summary.
|
||||
`disable_nomail_subscription` | `disable_nomail_subscription=yes` | | If set to `yes`, subscription to the 'nomail' version of the mailing list is disabled. Useful if you don't want to allow 'nomail' and notify users about it.
|
||||
`moderated` | `moderated=yes` | `no` | If set to `yes`. Parameter `owner` __or__ `moderators` is required to specify the moderators. Note: `moderators` has higher priority (means only addresses specified by `moderators` are act as moderators).
|
||||
`moderate_non_subscriber_post` | `moderate_non_subscriber_post=no` | `no` | If set to `yes`, all postings from people who are not allowed to post to the list will be moderated. Default (set to `no`) is denied.
|
||||
`disable_retrieving_old_posts` | `disable_retrieving_old_posts=yes` | | If set to `yes`, retrieving old posts by sending email to address `<listname>+get-N@` is disabled.
|
||||
`only_subscriber_can_get_old_posts` | `only_subscriber_can_get_old_posts=no` | `yes` | If set to `yes`, only subscribers can retrieve old posts by sending email to `LISTNAME+get-N@`
|
||||
`disable_retrieving_subscribers` | `disable_retrieving_subscribers=yes` | `yes` | If set to `yes`, (owner) retrieving subscribers by sending email to `LISTNAME+list@` is disabled. Note: only owner can send to such address.
|
||||
`disable_send_copy_to_sender` | `disable_send_copy_to_sender=yes` | `yes` | If set to `yes`, senders won't receive copies of their own posts.
|
||||
`notify_owner_when_sub_unsub` | `notify_owner_when_sub_unsub=no` | `no` | Notify the owner(s) when someone sub/unsubscribing to a mailing list.
|
||||
`notify_sender_when_moderated` | `notify_sender_when_moderated=no` | `no` | Notify sender (based on the envelope from) when their post is being moderated.
|
||||
`disable_archive` | `disable_archive=yes` | `no` | If set to `yes`, emails won't be saved in the archive but simply deleted.
|
||||
`moderate_subscription` | `moderate_subscription=yes` | `no` | If set to `yes`, subscription will be moderated by owner(s) or moderators specified by `subscription_moderators`. Moderators specified by `subscription_moderators` has higher priority. If set to `no`, subscription is not moderated, also, all moderators which were specified by `subscription_moderators` will be removed.
|
||||
`extra_addresses` | `extra_addresses=extra1@domain.com,extra2@domain.com` | | Define extra addresses of the mailing list.
|
||||
`subscription_moderators` | `subscription_moderators=<mail1>,<mail2>,<mail3>` | | Specify subscription moderators. Note: if `subscription_moderators` is given, `moderate_subscription` will be set to `yes` automatically. If no valid moderators are given, subscription will be moderated by owner(s).
|
||||
`owner` | `owner=<mail1>,<mail2>,<mail3>` | | Define owner(s) of the mailing list. Owners will get mails sent to `<listname>+owner@<domain.com>`.
|
||||
`moderators` | `moderators=<mail1>,<mail2>` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
|
||||
`maxmailsize` | `maxmailsize=10240` | | Specify max mail message size in __bytes__.
|
||||
`subject_prefix` | `subject_prefix=[prefix text]` | | Add a prefix in the `Subject:` line of mails sent to the list. Set to empty value to remove it.
|
||||
`custom_headers` | `custom_headers=<header1>:<value1>\n<header2>:<value2>` | | Add custom headers to every mail coming through. Multiple headers must be separated by `\n`. Set empty value to remove it. Note: mlmmjadmin will always add `X-Mailing-List: <mail>` and `Reply-To: <mail>` for each mailing list account.
|
||||
`remove_headers` | `remove_headers=Message-ID,Received` | | Remove given mail headers. NOTE: either `header:` or `header` (without `:`) is ok. Note: mlmmjadmin will always remove `DKIM-Signature:` and `Authentication-Results:`.
|
||||
`name` | `name=Short description of list` | | Set a short description of the mailing list account.
|
||||
`footer_text` | `footer_text=footer in plain text` | | Append footer (in plain text format) to every email sent to the list.
|
||||
`footer_html` | `footer_text=<p>footer in html</p>` | | Append footer (in html format) to every email sent to the list.
|
||||
|
||||
</div>
|
||||
|
||||
### Mailing List (Unsubscribable) {: .toggle }
|
||||
|
||||
!!! attention
|
||||
|
||||
This unsubscribable mailing list is only available in __LDAP__ backend.
|
||||
* This unsubscribable mailing list is only available in __LDAP__ backend.
|
||||
* It's recommended to use the Subscribable Mailing List instead, you're
|
||||
free to disable public subscribable.
|
||||
|
||||
!!! api "`GET`{: .get } `/api/maillist/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment }"
|
||||
!!! api "`POST`{: .post } `/api/maillist/<mail>`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
|
@ -648,11 +730,27 @@ Notes:
|
|||
|
||||
### iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1
|
||||
|
||||
* Parameter names changed:
|
||||
* While updating domain profile (`PUT /api/domain/<domain>`):
|
||||
* `enableService` was renamed to `addService`
|
||||
* `disableService` was renamed to `removeService`
|
||||
* `removeAllServices` was renamed to `services`
|
||||
* New: subscribable mailing list.
|
||||
* Show allocated domain quota while getting domain profile
|
||||
(`GET /api/domain/<domain>`).
|
||||
* Able to manage alias domains while updating domain profile
|
||||
(`GET /api/domain/<domain>`):
|
||||
* `aliasDomains`: reset all alias domains
|
||||
* `addAliasDomain`: add new alias domains
|
||||
* `removeAliasDomain`: remove existing alias domains
|
||||
* Parameter names changed while updating domain profile
|
||||
(`PUT /api/domain/<domain>`):
|
||||
* `enableService` was renamed to `addService`
|
||||
* `disableService` was renamed to `removeService`
|
||||
* `removeAllServices` was renamed to `services`
|
||||
|
||||
* iRedAdmin-Pro-LDAP-3.1:
|
||||
* New user profile parameters (`PUT /api/user/<mail>`):
|
||||
* `gn` - given name
|
||||
* `sn` - surname
|
||||
* Fixed:
|
||||
- Not correctly detect existing mail accounts while updating
|
||||
per-user mail forwarding addresses.
|
||||
|
||||
### iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0
|
||||
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@
|
|||
<li><a href="#domain">Domain</a></li>
|
||||
<li><a href="#domain-admin">Domain Admin</a></li>
|
||||
<li><a href="#mail-user">Mail User</a></li>
|
||||
<li><a href="#subscribable-mailing-list">Subscribable Mailing List</a></li>
|
||||
<li><a href="#mailing-list-unsubscribable-deprecated">Mailing List (Unsubscribable, deprecated)</a></li>
|
||||
<li><a href="#new-subscribable-mailing-list">[NEW] Subscribable Mailing List</a></li>
|
||||
<li><a href="#mailing-list-unsubscribable">Mailing List (Unsubscribable)</a></li>
|
||||
<li><a href="#mail-alias">Mail Alias</a></li>
|
||||
<li><a href="#spam-policy">Spam Policy</a></li>
|
||||
<li><a href="#throttling">Throttling</a></li>
|
||||
|
|
@ -1088,18 +1088,234 @@ to be a domain admin.</p>
|
|||
</div>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="subscribable-mailing-list">Subscribable Mailing List</h3>
|
||||
<h3 class="toggle" id="new-subscribable-mailing-list">[NEW] Subscribable Mailing List</h3>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>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
|
||||
<a href="http://mlmmj.org"><code>mlmmj</code></a> mailing list manager).</p>
|
||||
<ul>
|
||||
<li>Subscribable mailing list requires iRedMail-0.9.8 and later releases,
|
||||
it's implemented with <a href="http://mlmmj.org"><code>mlmmj</code></a> mailing list manager.</li>
|
||||
<li>It's available for both SQL and LDAP backends.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ml/<mail></code> <code class="comment">Get profile of an existing mailing list account</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/ml/<mail></code> <code class="comment">Create a new mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params">
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Sample Usage</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>name</code></td>
|
||||
<td><code>name=Sales Team</code></td>
|
||||
<td></td>
|
||||
<td>Display name of the mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accountStatus</code></td>
|
||||
<td><code>accountStatus=active</code></td>
|
||||
<td></td>
|
||||
<td>Enable or disable account. Possible values: <code>active</code>, <code>disabled</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maxMailSize</code></td>
|
||||
<td><code>maxMailSize=1048576</code> (1M)</td>
|
||||
<td></td>
|
||||
<td>Max message size (in bytes).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accessPolicy</code></td>
|
||||
<td><code>accessPolicy=membersonly</code></td>
|
||||
<td></td>
|
||||
<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>close_list</code></td>
|
||||
<td><code>close_list=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription and unsubscription via mail is disabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_moderator_can_post</code></td>
|
||||
<td><code>only_moderator_can_post=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, only moderators are allowed to post to it. The check is made against the <code>From:</code> header.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_subscriber_can_post</code></td>
|
||||
<td><code>only_subscriber_can_post=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, only subscribed members are allowed to post to it. The check is made against the <code>From:</code> header.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_subscription</code></td>
|
||||
<td><code>disable_subscription=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription is disabled, but unsubscription is still possible.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_subscription_confirm</code></td>
|
||||
<td><code>disable_subscription_confirm=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, mlmmj won't send mail to subscriber to ask for confirmation to subscribe to the list. <strong>WARNING</strong>: This should in principle never ever be used, but there are times on local lists etc. where this is useful. HANDLE WITH CARE!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_digest_subscription</code></td>
|
||||
<td><code>disable_digest_subscription=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, subscription to the digest version of the mailing list is disabled. Useful if you don't want to allow digests and notify users about it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_digest_text</code></td>
|
||||
<td><code>disable_digest_text=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, digest mails won't have a text part with a thread summary.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_nomail_subscription</code></td>
|
||||
<td><code>disable_nomail_subscription=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, subscription to the 'nomail' version of the mailing list is disabled. Useful if you don't want to allow 'nomail' and notify users about it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderated</code></td>
|
||||
<td><code>moderated=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>. Parameter <code>owner</code> <strong>or</strong> <code>moderators</code> is required to specify the moderators. Note: <code>moderators</code> has higher priority (means only addresses specified by <code>moderators</code> are act as moderators).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderate_non_subscriber_post</code></td>
|
||||
<td><code>moderate_non_subscriber_post=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, all postings from people who are not allowed to post to the list will be moderated. Default (set to <code>no</code>) is denied.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_retrieving_old_posts</code></td>
|
||||
<td><code>disable_retrieving_old_posts=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, retrieving old posts by sending email to address <code><listname>+get-N@</code> is disabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_subscriber_can_get_old_posts</code></td>
|
||||
<td><code>only_subscriber_can_get_old_posts=no</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, only subscribers can retrieve old posts by sending email to <code>LISTNAME+get-N@</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_retrieving_subscribers</code></td>
|
||||
<td><code>disable_retrieving_subscribers=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, (owner) retrieving subscribers by sending email to <code>LISTNAME+list@</code> is disabled. Note: only owner can send to such address.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_send_copy_to_sender</code></td>
|
||||
<td><code>disable_send_copy_to_sender=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, senders won't receive copies of their own posts.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>notify_owner_when_sub_unsub</code></td>
|
||||
<td><code>notify_owner_when_sub_unsub=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Notify the owner(s) when someone sub/unsubscribing to a mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>notify_sender_when_moderated</code></td>
|
||||
<td><code>notify_sender_when_moderated=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Notify sender (based on the envelope from) when their post is being moderated.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_archive</code></td>
|
||||
<td><code>disable_archive=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, emails won't be saved in the archive but simply deleted.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderate_subscription</code></td>
|
||||
<td><code>moderate_subscription=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription will be moderated by owner(s) or moderators specified by <code>subscription_moderators</code>. Moderators specified by <code>subscription_moderators</code> has higher priority. If set to <code>no</code>, subscription is not moderated, also, all moderators which were specified by <code>subscription_moderators</code> will be removed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>extra_addresses</code></td>
|
||||
<td><code>extra_addresses=extra1@domain.com,extra2@domain.com</code></td>
|
||||
<td></td>
|
||||
<td>Define extra addresses of the mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subscription_moderators</code></td>
|
||||
<td><code>subscription_moderators=<mail1>,<mail2>,<mail3></code></td>
|
||||
<td></td>
|
||||
<td>Specify subscription moderators. Note: if <code>subscription_moderators</code> is given, <code>moderate_subscription</code> will be set to <code>yes</code> automatically. If no valid moderators are given, subscription will be moderated by owner(s).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>owner</code></td>
|
||||
<td><code>owner=<mail1>,<mail2>,<mail3></code></td>
|
||||
<td></td>
|
||||
<td>Define owner(s) of the mailing list. Owners will get mails sent to <code><listname>+owner@<domain.com></code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderators</code></td>
|
||||
<td><code>moderators=<mail1>,<mail2></code></td>
|
||||
<td></td>
|
||||
<td>Specify moderators of the mailing list. Set to empty value will remove all existing moderators.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maxmailsize</code></td>
|
||||
<td><code>maxmailsize=10240</code></td>
|
||||
<td></td>
|
||||
<td>Specify max mail message size in <strong>bytes</strong>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subject_prefix</code></td>
|
||||
<td><code>subject_prefix=[prefix text]</code></td>
|
||||
<td></td>
|
||||
<td>Add a prefix in the <code>Subject:</code> line of mails sent to the list. Set to empty value to remove it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>custom_headers</code></td>
|
||||
<td><code>custom_headers=<header1>:<value1>\n<header2>:<value2></code></td>
|
||||
<td></td>
|
||||
<td>Add custom headers to every mail coming through. Multiple headers must be separated by <code>\n</code>. Set empty value to remove it. Note: mlmmjadmin will always add <code>X-Mailing-List: <mail></code> and <code>Reply-To: <mail></code> for each mailing list account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>remove_headers</code></td>
|
||||
<td><code>remove_headers=Message-ID,Received</code></td>
|
||||
<td></td>
|
||||
<td>Remove given mail headers. NOTE: either <code>header:</code> or <code>header</code> (without <code>:</code>) is ok. Note: mlmmjadmin will always remove <code>DKIM-Signature:</code> and <code>Authentication-Results:</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>name</code></td>
|
||||
<td><code>name=Short description of list</code></td>
|
||||
<td></td>
|
||||
<td>Set a short description of the mailing list account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>footer_text</code></td>
|
||||
<td><code>footer_text=footer in plain text</code></td>
|
||||
<td></td>
|
||||
<td>Append footer (in plain text format) to every email sent to the list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>footer_html</code></td>
|
||||
<td><code>footer_text=<p>footer in html</p></code></td>
|
||||
<td></td>
|
||||
<td>Append footer (in html format) to every email sent to the list.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/ml/<mail></code> <code class="comment">Delete an existing mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
|
|
@ -1116,7 +1332,7 @@ it requires iRedMail-0.9.8 and later releases (it's implemented with
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><code>keep_archive</code></td>
|
||||
<td>Archive subscribable mailing list before deleting the account.</td>
|
||||
<td>Archive account settings and messages before deleting the mailing list.</td>
|
||||
<td><code>keep_archive=no</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -1126,11 +1342,229 @@ it requires iRedMail-0.9.8 and later releases (it's implemented with
|
|||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/ml/<mail></code> <code class="comment">Update profile of an existing mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params">
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Sample Usage</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>name</code></td>
|
||||
<td><code>name=Sales Team</code></td>
|
||||
<td></td>
|
||||
<td>Display name of the mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accountStatus</code></td>
|
||||
<td><code>accountStatus=active</code></td>
|
||||
<td></td>
|
||||
<td>Enable or disable account. Possible values: <code>active</code>, <code>disabled</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maxMailSize</code></td>
|
||||
<td><code>maxMailSize=1048576</code> (1M)</td>
|
||||
<td></td>
|
||||
<td>Max message size (in bytes).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accessPolicy</code></td>
|
||||
<td><code>accessPolicy=membersonly</code></td>
|
||||
<td></td>
|
||||
<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>close_list</code></td>
|
||||
<td><code>close_list=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription and unsubscription via mail is disabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_moderator_can_post</code></td>
|
||||
<td><code>only_moderator_can_post=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, only moderators are allowed to post to it. The check is made against the <code>From:</code> header.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_subscriber_can_post</code></td>
|
||||
<td><code>only_subscriber_can_post=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, only subscribed members are allowed to post to it. The check is made against the <code>From:</code> header.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_subscription</code></td>
|
||||
<td><code>disable_subscription=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription is disabled, but unsubscription is still possible.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_subscription_confirm</code></td>
|
||||
<td><code>disable_subscription_confirm=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, mlmmj won't send mail to subscriber to ask for confirmation to subscribe to the list. <strong>WARNING</strong>: This should in principle never ever be used, but there are times on local lists etc. where this is useful. HANDLE WITH CARE!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_digest_subscription</code></td>
|
||||
<td><code>disable_digest_subscription=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, subscription to the digest version of the mailing list is disabled. Useful if you don't want to allow digests and notify users about it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_digest_text</code></td>
|
||||
<td><code>disable_digest_text=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, digest mails won't have a text part with a thread summary.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_nomail_subscription</code></td>
|
||||
<td><code>disable_nomail_subscription=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, subscription to the 'nomail' version of the mailing list is disabled. Useful if you don't want to allow 'nomail' and notify users about it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderated</code></td>
|
||||
<td><code>moderated=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>. Parameter <code>owner</code> <strong>or</strong> <code>moderators</code> is required to specify the moderators. Note: <code>moderators</code> has higher priority (means only addresses specified by <code>moderators</code> are act as moderators).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderate_non_subscriber_post</code></td>
|
||||
<td><code>moderate_non_subscriber_post=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, all postings from people who are not allowed to post to the list will be moderated. Default (set to <code>no</code>) is denied.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_retrieving_old_posts</code></td>
|
||||
<td><code>disable_retrieving_old_posts=yes</code></td>
|
||||
<td></td>
|
||||
<td>If set to <code>yes</code>, retrieving old posts by sending email to address <code><listname>+get-N@</code> is disabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>only_subscriber_can_get_old_posts</code></td>
|
||||
<td><code>only_subscriber_can_get_old_posts=no</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, only subscribers can retrieve old posts by sending email to <code>LISTNAME+get-N@</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_retrieving_subscribers</code></td>
|
||||
<td><code>disable_retrieving_subscribers=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, (owner) retrieving subscribers by sending email to <code>LISTNAME+list@</code> is disabled. Note: only owner can send to such address.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_send_copy_to_sender</code></td>
|
||||
<td><code>disable_send_copy_to_sender=yes</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>If set to <code>yes</code>, senders won't receive copies of their own posts.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>notify_owner_when_sub_unsub</code></td>
|
||||
<td><code>notify_owner_when_sub_unsub=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Notify the owner(s) when someone sub/unsubscribing to a mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>notify_sender_when_moderated</code></td>
|
||||
<td><code>notify_sender_when_moderated=no</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Notify sender (based on the envelope from) when their post is being moderated.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disable_archive</code></td>
|
||||
<td><code>disable_archive=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, emails won't be saved in the archive but simply deleted.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderate_subscription</code></td>
|
||||
<td><code>moderate_subscription=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>If set to <code>yes</code>, subscription will be moderated by owner(s) or moderators specified by <code>subscription_moderators</code>. Moderators specified by <code>subscription_moderators</code> has higher priority. If set to <code>no</code>, subscription is not moderated, also, all moderators which were specified by <code>subscription_moderators</code> will be removed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>extra_addresses</code></td>
|
||||
<td><code>extra_addresses=extra1@domain.com,extra2@domain.com</code></td>
|
||||
<td></td>
|
||||
<td>Define extra addresses of the mailing list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subscription_moderators</code></td>
|
||||
<td><code>subscription_moderators=<mail1>,<mail2>,<mail3></code></td>
|
||||
<td></td>
|
||||
<td>Specify subscription moderators. Note: if <code>subscription_moderators</code> is given, <code>moderate_subscription</code> will be set to <code>yes</code> automatically. If no valid moderators are given, subscription will be moderated by owner(s).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>owner</code></td>
|
||||
<td><code>owner=<mail1>,<mail2>,<mail3></code></td>
|
||||
<td></td>
|
||||
<td>Define owner(s) of the mailing list. Owners will get mails sent to <code><listname>+owner@<domain.com></code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>moderators</code></td>
|
||||
<td><code>moderators=<mail1>,<mail2></code></td>
|
||||
<td></td>
|
||||
<td>Specify moderators of the mailing list. Set to empty value will remove all existing moderators.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maxmailsize</code></td>
|
||||
<td><code>maxmailsize=10240</code></td>
|
||||
<td></td>
|
||||
<td>Specify max mail message size in <strong>bytes</strong>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subject_prefix</code></td>
|
||||
<td><code>subject_prefix=[prefix text]</code></td>
|
||||
<td></td>
|
||||
<td>Add a prefix in the <code>Subject:</code> line of mails sent to the list. Set to empty value to remove it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>custom_headers</code></td>
|
||||
<td><code>custom_headers=<header1>:<value1>\n<header2>:<value2></code></td>
|
||||
<td></td>
|
||||
<td>Add custom headers to every mail coming through. Multiple headers must be separated by <code>\n</code>. Set empty value to remove it. Note: mlmmjadmin will always add <code>X-Mailing-List: <mail></code> and <code>Reply-To: <mail></code> for each mailing list account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>remove_headers</code></td>
|
||||
<td><code>remove_headers=Message-ID,Received</code></td>
|
||||
<td></td>
|
||||
<td>Remove given mail headers. NOTE: either <code>header:</code> or <code>header</code> (without <code>:</code>) is ok. Note: mlmmjadmin will always remove <code>DKIM-Signature:</code> and <code>Authentication-Results:</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>name</code></td>
|
||||
<td><code>name=Short description of list</code></td>
|
||||
<td></td>
|
||||
<td>Set a short description of the mailing list account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>footer_text</code></td>
|
||||
<td><code>footer_text=footer in plain text</code></td>
|
||||
<td></td>
|
||||
<td>Append footer (in plain text format) to every email sent to the list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>footer_html</code></td>
|
||||
<td><code>footer_text=<p>footer in html</p></code></td>
|
||||
<td></td>
|
||||
<td>Append footer (in html format) to every email sent to the list.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<h3 class="toggle" id="mailing-list-unsubscribable-deprecated">Mailing List (Unsubscribable, deprecated)</h3>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="mailing-list-unsubscribable">Mailing List (Unsubscribable)</h3>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>This unsubscribable mailing list is only available in <strong>LDAP</strong> backend.</p>
|
||||
<ul>
|
||||
<li>This unsubscribable mailing list is only available in <strong>LDAP</strong> backend.</li>
|
||||
<li>It's recommended to use the Subscribable Mailing List instead, you're
|
||||
free to disable public subscribable.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/maillist/<mail></code> <code class="comment">Get profile of an existing mailing list account</code></p>
|
||||
|
|
@ -1696,13 +2130,38 @@ it requires iRedMail-0.9.8 and later releases (it's implemented with
|
|||
<h2 id="changelog">ChangeLog</h2>
|
||||
<h3 id="iredadmin-pro-sql-290-iredadmin-pro-ldap-31">iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1</h3>
|
||||
<ul>
|
||||
<li>Parameter names changed:<ul>
|
||||
<li>While updating domain profile (<code>PUT /api/domain/<domain></code>):<ul>
|
||||
<li>New: subscribable mailing list.</li>
|
||||
<li>Show allocated domain quota while getting domain profile
|
||||
(<code>GET /api/domain/<domain></code>).</li>
|
||||
<li>Able to manage alias domains while updating domain profile
|
||||
(<code>GET /api/domain/<domain></code>):<ul>
|
||||
<li><code>aliasDomains</code>: reset all alias domains</li>
|
||||
<li><code>addAliasDomain</code>: add new alias domains</li>
|
||||
<li><code>removeAliasDomain</code>: remove existing alias domains</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>Parameter names changed while updating domain profile
|
||||
(<code>PUT /api/domain/<domain></code>):</p>
|
||||
<ul>
|
||||
<li><code>enableService</code> was renamed to <code>addService</code></li>
|
||||
<li><code>disableService</code> was renamed to <code>removeService</code></li>
|
||||
<li><code>removeAllServices</code> was renamed to <code>services</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>iRedAdmin-Pro-LDAP-3.1:</p>
|
||||
<ul>
|
||||
<li>New user profile parameters (<code>PUT /api/user/<mail></code>):<ul>
|
||||
<li><code>gn</code> - given name</li>
|
||||
<li><code>sn</code> - surname</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Fixed:<ul>
|
||||
<li>Not correctly detect existing mail accounts while updating
|
||||
per-user mail forwarding addresses.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue