diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md b/en_US/iredadmin/0-iredadmin-pro.restful.api-20180403.md
similarity index 69%
rename from en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
rename to en_US/iredadmin/0-iredadmin-pro.restful.api-20180403.md
index 6ccad9e3..8db5f7c6 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api-20180403.md
@@ -4,8 +4,8 @@
!!! attention
- * This document is applicable to `iRedAdmin-Pro-SQL-2.9.0` and
- `iRedAdmin-Pro-LDAP-3.1`. If you're running an old release, please
+ * This document is applicable to `iRedAdmin-Pro-SQL-2.8.0` and
+ `iRedAdmin-Pro-LDAP-3.0`. If you're running an old release, please
upgrade iRedAdmin-Pro to the latest release, or check
[document for old releases](./iredadmin-pro.releases.html).
* If you need an API which has not yet been implemented, don't hesitate to
@@ -138,12 +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`
+ `enableService` | Enable new services. Multiple services must be separated by comma. Available services are listed below. | `enableService=self-service`
+ `disableService` | Disable existing services. Multiple services must be separated by comma. Available services are listed below. | `disableService=self-service`
+ `removeAllServices` | Disable all services (including mail service) | `removeAllServices=` (empty value)
`disableDomainProfile` | disable given domain profiles. Normal admin cannot view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `disableDomainProfile=bcc,relay,aliases`
`enableDomainProfile` | enable given domain profiles. Normal admin can view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `enableDomainProfile=bcc,relay,aliases`
`disableUserProfile` | disable given user profiles. Normal admin cannot view and update disabled profiles in user profile page. Available user profiles are listed below. | `disableUserProfile=bcc,relay,aliases`
@@ -156,10 +153,10 @@ Notes:
Profile | Comment
--- |---
self-service | Enable self-service for the mail domain.
- mail | All mail services. (__LDAP backends only__)
- domainalias | Alias domain support. (__LDAP backends only__)
- senderbcc | Per-domain sender bcc. (__LDAP backends only__)
- recipientbcc | Per-domain recipient bcc. (__LDAP backends only__)
+ mail | All mail services. (LDAP backends only)
+ domainalias | Alias domain support. (LDAP backends only)
+ senderbcc | Per-domain sender bcc. (LDAP backends only)
+ recipientbcc | Per-domain recipient bcc. (LDAP backends only)
Available domain profiles:
@@ -249,8 +246,6 @@ Notes:
`maxUsers` | how many mail users this admin can create. It's shared by all domains created/managed by this admin. | `maxUsers=100`
`maxAliases` | how many mail aliases this admin can create. It's shared by all domains created/managed by this admin. | `maxAliases=200`
`maxLists` | how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. | `maxLists=300`
- `disableViewingMailLog` | Disallow this admin to view log of inbound/outbound mails. | `disableViewingMailLog=yes` (or `no`)
- `disableManagingQuarantinedMails` | Disallow this admin to manage quarantined mails. | `disableManagingQuarantinedMails=yes` (or `no`)
@@ -277,8 +272,6 @@ Notes:
`maxUsers` | how many mail users this admin can create. It's shared by all domains created/managed by this admin. | `maxUsers=100`
`maxAliases` | how many mail aliases this admin can create. It's shared by all domains created/managed by this admin. | `maxAliases=200`
`maxLists` | how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. | `maxLists=300`
- `disableViewingMailLog` | Disallow this admin to view log of inbound/outbound mails. | `disableViewingMailLog=yes` (or `no`)
- `disableManagingQuarantinedMails` | Disallow this admin to manage quarantined mails. | `disableManagingQuarantinedMails=yes` (or `no`)
@@ -320,9 +313,7 @@ Notes:
Parameter | Summary | Sample Usage
--- |--- |---
- `name` | Display name | `name=Michael Jordon`
- `gn` | Given name | `gn=Jordon`
- `sn` | Surname | `sn=Jeffery`
+ `name` | Display name | `name=My New Name`
`password` | Password | `password=u0tBF82cIV@vi8Gme`
`quota` | Mailbox quota (in MB) | `quota=1024`
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`
@@ -392,120 +383,12 @@ Notes:
-### [NEW] Subscribable Mailing List {: .toggle }
+### Mailing List {: .toggle }
!!! attention
- * 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/`{: .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 }"
-
-
-
- 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`.
- `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.
- `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 `
+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=,,` | | 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=,,` | | Define owner(s) of the mailing list. Owners will get mails sent to `+owner@`.
- `moderators` | `moderators=,` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
- `max_message_size` | `max_message_size=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=:\n:` | | 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: ` and `Reply-To: ` 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=footer in html
` | | Append footer (in html format) to every email sent to the list.
-
-
-
-!!! api "`DELETE`{: .delete } `/api/ml/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
-
-
-
- Parameter | Summary | Sample Usage
- --- |--- |---
- `keep_archive` | Archive account settings and messages before deleting the mailing list. | `keep_archive=no`
-
-
-
-!!! api "`PUT`{: .put } `/api/ml/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_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`.
- `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.
- `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 `
+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=,,` | | 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=,,` | | Define owner(s) of the mailing list. Owners will get mails sent to `+owner@`.
- `moderators` | `moderators=,` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
- `max_message_size` | `max_message_size=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=:\n:` | | 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: ` and `Reply-To: ` 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=footer in html
` | | Append footer (in html format) to every email sent to the list.
-
-
-
-### Mailing List (Unsubscribable) {: .toggle }
-
-!!! attention
-
- * 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.
+ Mailing list is only available in OpenLDAP backend. For SQL backends,
+ please use mail alias account as mailing list.
!!! 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 }"
@@ -519,16 +402,7 @@ Notes:
-!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
-
-
-
- Parameter | Summary | Sample Usage
- --- |--- |---
- `archive` | Archive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account. | `archive=no`
-
-
-
+!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment }"
!!! api "`PUT`{: .put } `/api/maillist/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
@@ -732,30 +606,6 @@ Notes:
## ChangeLog
-### iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1
-
-* New: subscribable mailing list.
-* Show allocated domain quota while getting domain profile
- (`GET /api/domain/`).
-* Able to manage alias domains while updating domain profile
- (`GET /api/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/`):
- * `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/`):
- * `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
* NEW: Able to list all managed domains (`/domains`).
diff --git a/en_US/iredadmin/2-iredadmin-pro.restful.api.md b/en_US/iredadmin/2-iredadmin-pro.restful.api.md
index 8db5f7c6..6ccad9e3 100644
--- a/en_US/iredadmin/2-iredadmin-pro.restful.api.md
+++ b/en_US/iredadmin/2-iredadmin-pro.restful.api.md
@@ -4,8 +4,8 @@
!!! attention
- * This document is applicable to `iRedAdmin-Pro-SQL-2.8.0` and
- `iRedAdmin-Pro-LDAP-3.0`. If you're running an old release, please
+ * This document is applicable to `iRedAdmin-Pro-SQL-2.9.0` and
+ `iRedAdmin-Pro-LDAP-3.1`. If you're running an old release, please
upgrade iRedAdmin-Pro to the latest release, or check
[document for old releases](./iredadmin-pro.releases.html).
* If you need an API which has not yet been implemented, don't hesitate to
@@ -138,9 +138,12 @@ 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)
- `enableService` | Enable new services. Multiple services must be separated by comma. Available services are listed below. | `enableService=self-service`
- `disableService` | Disable existing services. Multiple services must be separated by comma. Available services are listed below. | `disableService=self-service`
- `removeAllServices` | Disable all services (including mail service) | `removeAllServices=` (empty value)
+ `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`
`disableDomainProfile` | disable given domain profiles. Normal admin cannot view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `disableDomainProfile=bcc,relay,aliases`
`enableDomainProfile` | enable given domain profiles. Normal admin can view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `enableDomainProfile=bcc,relay,aliases`
`disableUserProfile` | disable given user profiles. Normal admin cannot view and update disabled profiles in user profile page. Available user profiles are listed below. | `disableUserProfile=bcc,relay,aliases`
@@ -153,10 +156,10 @@ Notes:
Profile | Comment
--- |---
self-service | Enable self-service for the mail domain.
- mail | All mail services. (LDAP backends only)
- domainalias | Alias domain support. (LDAP backends only)
- senderbcc | Per-domain sender bcc. (LDAP backends only)
- recipientbcc | Per-domain recipient bcc. (LDAP backends only)
+ mail | All mail services. (__LDAP backends only__)
+ domainalias | Alias domain support. (__LDAP backends only__)
+ senderbcc | Per-domain sender bcc. (__LDAP backends only__)
+ recipientbcc | Per-domain recipient bcc. (__LDAP backends only__)
Available domain profiles:
@@ -246,6 +249,8 @@ Notes:
`maxUsers` | how many mail users this admin can create. It's shared by all domains created/managed by this admin. | `maxUsers=100`
`maxAliases` | how many mail aliases this admin can create. It's shared by all domains created/managed by this admin. | `maxAliases=200`
`maxLists` | how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. | `maxLists=300`
+ `disableViewingMailLog` | Disallow this admin to view log of inbound/outbound mails. | `disableViewingMailLog=yes` (or `no`)
+ `disableManagingQuarantinedMails` | Disallow this admin to manage quarantined mails. | `disableManagingQuarantinedMails=yes` (or `no`)
@@ -272,6 +277,8 @@ Notes:
`maxUsers` | how many mail users this admin can create. It's shared by all domains created/managed by this admin. | `maxUsers=100`
`maxAliases` | how many mail aliases this admin can create. It's shared by all domains created/managed by this admin. | `maxAliases=200`
`maxLists` | how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. | `maxLists=300`
+ `disableViewingMailLog` | Disallow this admin to view log of inbound/outbound mails. | `disableViewingMailLog=yes` (or `no`)
+ `disableManagingQuarantinedMails` | Disallow this admin to manage quarantined mails. | `disableManagingQuarantinedMails=yes` (or `no`)
@@ -313,7 +320,9 @@ Notes:
Parameter | Summary | Sample Usage
--- |--- |---
- `name` | Display name | `name=My New Name`
+ `name` | Display name | `name=Michael Jordon`
+ `gn` | Given name | `gn=Jordon`
+ `sn` | Surname | `sn=Jeffery`
`password` | Password | `password=u0tBF82cIV@vi8Gme`
`quota` | Mailbox quota (in MB) | `quota=1024`
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`
@@ -383,12 +392,120 @@ Notes:
-### Mailing List {: .toggle }
+### [NEW] Subscribable Mailing List {: .toggle }
!!! attention
- Mailing list is only available in OpenLDAP backend. For SQL backends,
- please use mail alias account as mailing list.
+ * 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/`{: .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 }"
+
+
+
+ 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`.
+ `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.
+ `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 `
+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=,,` | | 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=,,` | | Define owner(s) of the mailing list. Owners will get mails sent to `+owner@`.
+ `moderators` | `moderators=,` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
+ `max_message_size` | `max_message_size=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=:\n:` | | 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: ` and `Reply-To: ` 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=footer in html
` | | Append footer (in html format) to every email sent to the list.
+
+
+
+!!! api "`DELETE`{: .delete } `/api/ml/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
+
+
+
+ Parameter | Summary | Sample Usage
+ --- |--- |---
+ `keep_archive` | Archive account settings and messages before deleting the mailing list. | `keep_archive=no`
+
+
+
+!!! api "`PUT`{: .put } `/api/ml/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_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`.
+ `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.
+ `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 `
+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=,,` | | 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=,,` | | Define owner(s) of the mailing list. Owners will get mails sent to `+owner@`.
+ `moderators` | `moderators=,` | | Specify moderators of the mailing list. Set to empty value will remove all existing moderators.
+ `max_message_size` | `max_message_size=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=:\n:` | | 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: ` and `Reply-To: ` 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=footer in html
` | | Append footer (in html format) to every email sent to the list.
+
+
+
+### Mailing List (Unsubscribable) {: .toggle }
+
+!!! attention
+
+ * 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/`{: .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 }"
@@ -402,7 +519,16 @@ Notes:
-!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment }"
+!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
+
+
+
+ Parameter | Summary | Sample Usage
+ --- |--- |---
+ `archive` | Archive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account. | `archive=no`
+
+
+
!!! api "`PUT`{: .put } `/api/maillist/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
@@ -606,6 +732,30 @@ Notes:
## ChangeLog
+### iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1
+
+* New: subscribable mailing list.
+* Show allocated domain quota while getting domain profile
+ (`GET /api/domain/
`).
+* Able to manage alias domains while updating domain profile
+ (`GET /api/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/`):
+ * `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/`):
+ * `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
* NEW: Able to list all managed domains (`/domains`).
diff --git a/en_US/upgrade/1-iredmail.releases.md b/en_US/upgrade/1-iredmail.releases.md
index 3f048f03..9c4ec6bb 100644
--- a/en_US/upgrade/1-iredmail.releases.md
+++ b/en_US/upgrade/1-iredmail.releases.md
@@ -36,6 +36,7 @@
Version | Release Date | Upgrade tutorial | Comment
---|---|---|---
+[0.9.8](https://forum.iredmail.org/) | Apr 3, 2018 | [Upgrade from iRedMail-0.9.7](./upgrade.iredmail.0.9.7-0.9.8.html) | Contains SQL/LDAP structure change
[0.9.7](https://forum.iredmail.org/topic12944.html) | Jul 1, 2017 | [Upgrade from iRedMail-0.9.6](./upgrade.iredmail.0.9.6-0.9.7.html) | Contains SQL structure change
[0.9.6](https://forum.iredmail.org/topic12262.html) | Jan 23, 2017 | [Upgrade from iRedMail-0.9.5-1](./upgrade.iredmail.0.9.5.1-0.9.6.html) | Contains SQL/LDAP structure changes
[0.9.5-1](https://forum.iredmail.org/topic11049.html) | May 10, 2016 | [Upgrade from iRedMail-0.9.5](./upgrade.iredmail.0.9.5-0.9.5-1.html) | Small bug fix release
diff --git a/en_US/upgrade/2-iredadmin-pro.releases.md b/en_US/upgrade/2-iredadmin-pro.releases.md
index d3a4f458..d2c13026 100644
--- a/en_US/upgrade/2-iredadmin-pro.releases.md
+++ b/en_US/upgrade/2-iredadmin-pro.releases.md
@@ -22,7 +22,8 @@ this tutorial with just one shell command:
Version | Release Date | Comment | Extra
---|---|---|---
-[3.0](https://forum.iredmail.org/topic13212.html) | Aug 24, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api.html)
+[3.1](https://forum.iredmail.org/) | Apr 3, 2018 | | [RESTful API document](./iredadmin-pro.restful.api.html)
+[3.0](https://forum.iredmail.org/topic13212.html) | Aug 24, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20180403.html)
[2.9.0](https://forum.iredmail.org/topic12946.html) | Jul 1, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20170824.html)
[2.8.0](https://forum.iredmail.org/topic12499.html) | Mar 21, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20170123.html)
[2.7.0](https://forum.iredmail.org/topic12266.html) | Jan 23, 2017 | Improved RESTful API support. | [RESTful API document](./iredadmin-pro.restful.api-20170123.html)
@@ -56,7 +57,8 @@ Version | Release Date | Comment | Extra
Version | Release Date | Comment | RESTful API Document
---|---|---|---
-[2.8.0](https://forum.iredmail.org/topic13213.html) | Aug 24, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api.html)
+[2.9.0](https://forum.iredmail.org/topic13213.html) | Apr 3, 2018 | | [RESTful API document](./iredadmin-pro.restful.api.html)
+[2.8.0](https://forum.iredmail.org/topic13213.html) | Aug 24, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20180403.html)
[2.7.0](https://forum.iredmail.org/topic12945.html) | Jul 1, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20170824.html)
[2.6.0](https://forum.iredmail.org/topic12498.html) | Mar 21, 2017 | Bug fix release. | [RESTful API document](./iredadmin-pro.restful.api-20170123.html)
[2.5.0](https://forum.iredmail.org/topic12267.html) | Jan 23, 2017 | Improved RESTful API support. | [RESTful API document](./iredadmin-pro.restful.api-20170123.html)
diff --git a/html/iredadmin-pro.releases.html b/html/iredadmin-pro.releases.html
index d4690b98..c3312629 100644
--- a/html/iredadmin-pro.releases.html
+++ b/html/iredadmin-pro.releases.html
@@ -56,10 +56,16 @@ this tutorial with just one shell command:
+3.1 |
+Apr 3, 2018 |
+ |
+RESTful API document |
+
+
3.0 |
Aug 24, 2017 |
Bug fix release. |
-RESTful API document |
+RESTful API document |
2.9.0 |
@@ -243,10 +249,16 @@ this tutorial with just one shell command:
+2.9.0 |
+Apr 3, 2018 |
+ |
+RESTful API document |
+
+
2.8.0 |
Aug 24, 2017 |
Bug fix release. |
-RESTful API document |
+RESTful API document |
2.7.0 |
diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api-20180403.html
similarity index 70%
rename from html/iredadmin-pro.restful.api.new.html
rename to html/iredadmin-pro.restful.api-20180403.html
index b2b3b7d0..5e55fd02 100644
--- a/html/iredadmin-pro.restful.api.new.html
+++ b/html/iredadmin-pro.restful.api-20180403.html
@@ -27,8 +27,7 @@
Domain
Domain Admin
Mail User
-[NEW] Subscribable Mailing List
-Mailing List (Unsubscribable)
+Mailing List
Mail Alias
Spam Policy
Throttling
@@ -40,7 +39,6 @@
ChangeLog
-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 |
+enableService |
Enable new services. Multiple services must be separated by comma. Available services are listed below. |
-addService=self-service |
+enableService=self-service |
-removeService |
+disableService |
Disable existing services. Multiple services must be separated by comma. Available services are listed below. |
-removeService=self-service |
+disableService=self-service |
-services |
-Reset all services. If empty, all existing services will be removed. |
-services=mail,self-service |
+removeAllServices |
+Disable all services (including mail service) |
+removeAllServices= (empty value) |
disableDomainProfile |
@@ -426,19 +409,19 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
mail |
-All mail services. (LDAP backends only) |
+All mail services. (LDAP backends only) |
domainalias |
-Alias domain support. (LDAP backends only) |
+Alias domain support. (LDAP backends only) |
senderbcc |
-Per-domain sender bcc. (LDAP backends only) |
+Per-domain sender bcc. (LDAP backends only) |
recipientbcc |
-Per-domain recipient bcc. (LDAP backends only) |
+Per-domain recipient bcc. (LDAP backends only) |
@@ -703,16 +686,6 @@ to be a domain admin.
how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. |
maxLists=300 |
-
-disableViewingMailLog |
-Disallow this admin to view log of inbound/outbound mails. |
-disableViewingMailLog=yes (or no ) |
-
-
-disableManagingQuarantinedMails |
-Disallow this admin to manage quarantined mails. |
-disableManagingQuarantinedMails=yes (or no ) |
-
@@ -801,16 +774,6 @@ to be a domain admin.
how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. |
maxLists=300 |
-
-disableViewingMailLog |
-Disallow this admin to view log of inbound/outbound mails. |
-disableViewingMailLog=yes (or no ) |
-
-
-disableManagingQuarantinedMails |
-Disallow this admin to manage quarantined mails. |
-disableManagingQuarantinedMails=yes (or no ) |
-
@@ -907,17 +870,7 @@ to be a domain admin.
name |
Display name |
-name=Michael Jordon |
-
-
-gn |
-Given name |
-gn=Jordon |
-
-
-sn |
-Surname |
-sn=Jeffery |
+name=My New Name |
password |
@@ -1088,507 +1041,11 @@ to be a domain admin.
-[NEW] Subscribable Mailing List
+Mailing List
Attention
-
-- Subscribable mailing list requires iRedMail-0.9.8 and later releases,
- it's implemented with
mlmmj
mailing list manager.
-- It's available for both SQL and LDAP backends.
-
-
-
-
-
POST
/api/ml/<mail>
Parameters
-
-
-
-
-
-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 . |
-
-
-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. |
-
-
-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. |
-
-
-max_message_size |
-max_message_size=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. |
-
-
-
-
-
-
-
-
DELETE
/api/ml/<mail>
Parameters
-
-
-
-
-
-Parameter |
-Summary |
-Sample Usage |
-
-
-
-
-keep_archive |
-Archive account settings and messages before deleting the mailing list. |
-keep_archive=no |
-
-
-
-
-
-
-
-
PUT
/api/ml/<mail>
Parameters
-
-
-
-
-
-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 . |
-
-
-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. |
-
-
-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. |
-
-
-max_message_size |
-max_message_size=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. |
-
-
-
-
-
-
-Mailing List (Unsubscribable)
-
-
Attention
-
-- 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.
-
+
Mailing list is only available in OpenLDAP backend. For SQL backends,
+please use mail alias account as mailing list.
GET
/api/maillist/<mail>
@@ -1627,27 +1084,7 @@ to be a domain admin.
-
DELETE
/api/maillist/<mail>
Parameters
-
-
-
-
-
-Parameter |
-Summary |
-Sample Usage |
-
-
-
-
-archive |
-Archive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account. |
-archive=no |
-
-
-
-
-
+
DELETE
/api/maillist/<mail>
PUT
/api/maillist/<mail>
Parameters
@@ -2152,43 +1589,6 @@ to be a domain admin.
GET
/api/ldif/alias/<mail>
ChangeLog
-iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1
-
iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0
ChangeLog
-enableService |
+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. |
-enableService=self-service |
+addService=self-service |
-disableService |
+removeService |
Disable existing services. Multiple services must be separated by comma. Available services are listed below. |
-disableService=self-service |
+removeService=self-service |
-removeAllServices |
-Disable all services (including mail service) |
-removeAllServices= (empty value) |
+services |
+Reset all services. If empty, all existing services will be removed. |
+services=mail,self-service |
disableDomainProfile |
@@ -409,19 +426,19 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
mail |
-All mail services. (LDAP backends only) |
+All mail services. (LDAP backends only) |
domainalias |
-Alias domain support. (LDAP backends only) |
+Alias domain support. (LDAP backends only) |
senderbcc |
-Per-domain sender bcc. (LDAP backends only) |
+Per-domain sender bcc. (LDAP backends only) |
recipientbcc |
-Per-domain recipient bcc. (LDAP backends only) |
+Per-domain recipient bcc. (LDAP backends only) |
@@ -686,6 +703,16 @@ to be a domain admin.
how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. |
maxLists=300 |
+
+disableViewingMailLog |
+Disallow this admin to view log of inbound/outbound mails. |
+disableViewingMailLog=yes (or no ) |
+
+
+disableManagingQuarantinedMails |
+Disallow this admin to manage quarantined mails. |
+disableManagingQuarantinedMails=yes (or no ) |
+
@@ -774,6 +801,16 @@ to be a domain admin.
how many mailing lists this admin can create. It's shared by all domains created/managed by this admin. |
maxLists=300 |
+
+disableViewingMailLog |
+Disallow this admin to view log of inbound/outbound mails. |
+disableViewingMailLog=yes (or no ) |
+
+
+disableManagingQuarantinedMails |
+Disallow this admin to manage quarantined mails. |
+disableManagingQuarantinedMails=yes (or no ) |
+
@@ -870,7 +907,17 @@ to be a domain admin.
name |
Display name |
-name=My New Name |
+name=Michael Jordon |
+
+
+gn |
+Given name |
+gn=Jordon |
+
+
+sn |
+Surname |
+sn=Jeffery |
password |
@@ -1041,11 +1088,507 @@ to be a domain admin.
-Mailing List
+[NEW] Subscribable Mailing List
Attention
-
Mailing list is only available in OpenLDAP backend. For SQL backends,
-please use mail alias account as mailing list.
+
+- Subscribable mailing list requires iRedMail-0.9.8 and later releases,
+ it's implemented with
mlmmj
mailing list manager.
+- It's available for both SQL and LDAP backends.
+
+
+
+
+
POST
/api/ml/<mail>
Parameters
+
+
+
+
+
+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 . |
+
+
+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. |
+
+
+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. |
+
+
+max_message_size |
+max_message_size=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. |
+
+
+
+
+
+
+
+
DELETE
/api/ml/<mail>
Parameters
+
+
+
+
+
+Parameter |
+Summary |
+Sample Usage |
+
+
+
+
+keep_archive |
+Archive account settings and messages before deleting the mailing list. |
+keep_archive=no |
+
+
+
+
+
+
+
+
PUT
/api/ml/<mail>
Parameters
+
+
+
+
+
+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 . |
+
+
+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. |
+
+
+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. |
+
+
+max_message_size |
+max_message_size=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. |
+
+
+
+
+
+
+Mailing List (Unsubscribable)
+
+
Attention
+
+- 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.
+
GET
/api/maillist/<mail>
@@ -1084,7 +1627,27 @@ please use mail alias account as mailing list.
-
DELETE
/api/maillist/<mail>
+
DELETE
/api/maillist/<mail>
Parameters
+
+
+
+
+
+Parameter |
+Summary |
+Sample Usage |
+
+
+
+
+archive |
+Archive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account. |
+archive=no |
+
+
+
+
+
PUT
/api/maillist/<mail>
Parameters
@@ -1589,6 +2152,43 @@ please use mail alias account as mailing list.
GET
/api/ldif/alias/<mail>
ChangeLog
+iRedAdmin-Pro-SQL-2.9.0, iRedAdmin-Pro-LDAP-3.1
+
iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0
- NEW: Able to list all managed domains (
/domains
).
diff --git a/html/iredmail.releases.html b/html/iredmail.releases.html
index f10cdfd8..279af245 100644
--- a/html/iredmail.releases.html
+++ b/html/iredmail.releases.html
@@ -74,6 +74,12 @@ check the details and
+0.9.8 |
+Apr 3, 2018 |
+Upgrade from iRedMail-0.9.7 |
+Contains SQL/LDAP structure change |
+
+
0.9.7 |
Jul 1, 2017 |
Upgrade from iRedMail-0.9.6 |