Sync link of iRedAdmin-Pro-LDAP-3.2 release notes.
This commit is contained in:
Zhang Huangbin
parent
ffb575288d
commit
390efc7cc5
|
|
@ -4,8 +4,8 @@
|
|||
|
||||
!!! attention
|
||||
|
||||
* This document is applicable to `iRedAdmin-Pro-SQL-3.0` and
|
||||
`iRedAdmin-Pro-LDAP-3.2`. 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
|
||||
|
|
@ -309,9 +309,6 @@ Notes:
|
|||
`password` | Password| `password=AsTr0ng@`
|
||||
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
|
||||
`quota` | Mailbox quota (in MB) | `quota=1024`
|
||||
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat>. __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
|
||||
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
|
||||
`maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -326,8 +323,7 @@ Notes:
|
|||
`name` | Display name | `name=Michael Jordon`
|
||||
`gn` | Given name | `gn=Jordon`
|
||||
`sn` | Surname | `sn=Jeffery`
|
||||
`password` | Set user password to the given one. | `password=u0tBF82cIV@vi8Gme`
|
||||
`password_hash` | Set user password to the given hashed password. Conflict with parameter `password`. | `password={SSHA}qjmhvlsofWDu/AvVhOJX1cU/CvYKLYlwlM5bHw==`
|
||||
`password` | Password | `password=u0tBF82cIV@vi8Gme`
|
||||
`quota` | Mailbox quota (in MB) | `quota=1024`
|
||||
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`
|
||||
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
|
||||
|
|
@ -341,9 +337,6 @@ Notes:
|
|||
`services` | Reset per-user enabled mail services to given values. Conflicts with parameter `addService` and `removeService`. See additional notes below. | `services=mail,smtp,pop3,imap`
|
||||
`addService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `addService=vpn,owncloud`
|
||||
`removeService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `removeService=forward,senderbcc`
|
||||
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat>. __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
|
||||
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
|
||||
`maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
|
||||
|
||||
!!! attention
|
||||
|
||||
|
|
@ -352,16 +345,12 @@ Notes:
|
|||
* Available service names in iRedMail:
|
||||
* smtp
|
||||
* smtpsecured (SMTP over TLS or SSL)
|
||||
* smtptls (SMTP over TLS)
|
||||
* pop3
|
||||
* pop3secured (POP3 over TLS or SSL)
|
||||
* pop3tls (POP3 over TLS)
|
||||
* imap
|
||||
* imapsecured (IMAP over TLS or SSL)
|
||||
* imaptls (IMAP over TLS)
|
||||
* managesieve
|
||||
* managesievesecured (Managesieve over TLS or SSL)
|
||||
* managesievetls (Managesieve over TLS)
|
||||
* deliver (deliver received email to local mailbox)
|
||||
* sogo (SOGo groupware)
|
||||
|
||||
|
|
@ -375,7 +364,7 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
!!! api "`POST`{: .post } `/api/user/<mail>/change_email/<new_mail>`{: .url } `Change user's email address (from '<mail>' to '<new_mail>')`{: .comment }"
|
||||
!!! api "`POST`{: .put } `/api/user/<mail>/change_email/<new_mail>`{: .url } `Change user's email address (from '<mail>' to '<new_mail>')`{: .comment }"
|
||||
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under domain`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
|
@ -411,26 +400,7 @@ Notes:
|
|||
it's implemented with [`mlmmj`](http://mlmmj.org) mailing list manager.
|
||||
* It's available for both SQL and LDAP backends.
|
||||
|
||||
!!! api "`GET`{: .get } `/api/mls/<domain>`{: .url } `Get profile of all mailing lists under given domain`{: .comment } `Parameters`{: .has_params}"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`email_only` | `email_only=yes` | `no` | Return a list of mailing list email addresses instead of detailed profile.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`GET`{: .get } `/api/ml/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment } `Parameters`{: .has_params}"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`with_subscribers` | `with_subscribers=yes` | `no` | Get subscribers of mailing list.
|
||||
|
||||
</div>
|
||||
|
||||
!!! 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">
|
||||
|
|
@ -473,14 +443,6 @@ Notes:
|
|||
`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.
|
||||
|
||||
Parameters used to add subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`subscribers` | `subscribers=<mail1>,<mail2>,<mail3>,...` | | Subscribe users to mailing list. Multiple subscribers must be separated by comma.
|
||||
`require_confirm` | `require_confirm=no` | `yes` | Send email to subscribers and let subscribers confirm the subscription.
|
||||
`subscription` | `subscription=normal` | `normal` | Subscribe to different subscription. Valid values are: `normal`, `digest`, `nomail`.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`DELETE`{: .delete } `/api/ml/<mail>`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
|
@ -535,20 +497,6 @@ Notes:
|
|||
`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.
|
||||
|
||||
Parameters used to add subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`add_subscribers` | `add_subscribers=<mail1>,<mail2>,<mail3>,...` | | Subscribe users to mailing list. Multiple subscribers must be separated by comma.
|
||||
`require_confirm` | `require_confirm=no` | `yes` | Send email to subscribers and let subscribers confirm the subscription.
|
||||
`subscription` | `subscription=normal` | `normal` | Subscribe to different subscription. Valid values are: `normal`, `digest`, `nomail`.
|
||||
|
||||
Parameters used to remove subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`remove_subscribers` | `remove_subscribers=<mail1>,<mail2>,<mail3>,...` | | Remove existing subscribers from mailing list. Multiple subscribers must be separated by comma.
|
||||
|
||||
</div>
|
||||
|
||||
### Mailing List (Unsubscribable) {: .toggle }
|
||||
|
|
@ -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-3.0` and
|
||||
`iRedAdmin-Pro-LDAP-3.2`. 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
|
||||
|
|
@ -309,6 +309,9 @@ Notes:
|
|||
`password` | Password| `password=AsTr0ng@`
|
||||
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
|
||||
`quota` | Mailbox quota (in MB) | `quota=1024`
|
||||
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat>. __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
|
||||
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
|
||||
`maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -323,7 +326,8 @@ Notes:
|
|||
`name` | Display name | `name=Michael Jordon`
|
||||
`gn` | Given name | `gn=Jordon`
|
||||
`sn` | Surname | `sn=Jeffery`
|
||||
`password` | Password | `password=u0tBF82cIV@vi8Gme`
|
||||
`password` | Set user password to the given one. | `password=u0tBF82cIV@vi8Gme`
|
||||
`password_hash` | Set user password to the given hashed password. Conflict with parameter `password`. | `password={SSHA}qjmhvlsofWDu/AvVhOJX1cU/CvYKLYlwlM5bHw==`
|
||||
`quota` | Mailbox quota (in MB) | `quota=1024`
|
||||
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`
|
||||
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
|
||||
|
|
@ -337,6 +341,9 @@ Notes:
|
|||
`services` | Reset per-user enabled mail services to given values. Conflicts with parameter `addService` and `removeService`. See additional notes below. | `services=mail,smtp,pop3,imap`
|
||||
`addService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `addService=vpn,owncloud`
|
||||
`removeService` | Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter `services`. See additional notes below. | `removeService=forward,senderbcc`
|
||||
`mailboxFormat` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat>. __WARNING__: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately. | `mailboxFormat=mdbox`
|
||||
`mailboxFolder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's useful if you need to migrate to different mailbox folder. __WARNING__: New email will be stored in new mailbox folder immediately. | `mailboxFolder=Maildir`
|
||||
`maildir` | Absolute path of the mailbox. All characters will be converted to lower cases. | `maildir=/var/vmail/vmail1/example.com/username`
|
||||
|
||||
!!! attention
|
||||
|
||||
|
|
@ -345,12 +352,16 @@ Notes:
|
|||
* Available service names in iRedMail:
|
||||
* smtp
|
||||
* smtpsecured (SMTP over TLS or SSL)
|
||||
* smtptls (SMTP over TLS)
|
||||
* pop3
|
||||
* pop3secured (POP3 over TLS or SSL)
|
||||
* pop3tls (POP3 over TLS)
|
||||
* imap
|
||||
* imapsecured (IMAP over TLS or SSL)
|
||||
* imaptls (IMAP over TLS)
|
||||
* managesieve
|
||||
* managesievesecured (Managesieve over TLS or SSL)
|
||||
* managesievetls (Managesieve over TLS)
|
||||
* deliver (deliver received email to local mailbox)
|
||||
* sogo (SOGo groupware)
|
||||
|
||||
|
|
@ -364,7 +375,7 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
!!! api "`POST`{: .put } `/api/user/<mail>/change_email/<new_mail>`{: .url } `Change user's email address (from '<mail>' to '<new_mail>')`{: .comment }"
|
||||
!!! api "`POST`{: .post } `/api/user/<mail>/change_email/<new_mail>`{: .url } `Change user's email address (from '<mail>' to '<new_mail>')`{: .comment }"
|
||||
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under domain`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
|
@ -400,7 +411,26 @@ Notes:
|
|||
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 "`GET`{: .get } `/api/mls/<domain>`{: .url } `Get profile of all mailing lists under given domain`{: .comment } `Parameters`{: .has_params}"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`email_only` | `email_only=yes` | `no` | Return a list of mailing list email addresses instead of detailed profile.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`GET`{: .get } `/api/ml/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment } `Parameters`{: .has_params}"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`with_subscribers` | `with_subscribers=yes` | `no` | Get subscribers of mailing list.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`POST`{: .post } `/api/ml/<mail>`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
|
@ -443,6 +473,14 @@ Notes:
|
|||
`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.
|
||||
|
||||
Parameters used to add subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`subscribers` | `subscribers=<mail1>,<mail2>,<mail3>,...` | | Subscribe users to mailing list. Multiple subscribers must be separated by comma.
|
||||
`require_confirm` | `require_confirm=no` | `yes` | Send email to subscribers and let subscribers confirm the subscription.
|
||||
`subscription` | `subscription=normal` | `normal` | Subscribe to different subscription. Valid values are: `normal`, `digest`, `nomail`.
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`DELETE`{: .delete } `/api/ml/<mail>`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
|
@ -497,6 +535,20 @@ Notes:
|
|||
`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.
|
||||
|
||||
Parameters used to add subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`add_subscribers` | `add_subscribers=<mail1>,<mail2>,<mail3>,...` | | Subscribe users to mailing list. Multiple subscribers must be separated by comma.
|
||||
`require_confirm` | `require_confirm=no` | `yes` | Send email to subscribers and let subscribers confirm the subscription.
|
||||
`subscription` | `subscription=normal` | `normal` | Subscribe to different subscription. Valid values are: `normal`, `digest`, `nomail`.
|
||||
|
||||
Parameters used to remove subscribers:
|
||||
|
||||
Parameter | Sample Usage | Default Value | Comment
|
||||
--- |--- |---|---
|
||||
`remove_subscribers` | `remove_subscribers=<mail1>,<mail2>,<mail3>,...` | | Remove existing subscribers from mailing list. Multiple subscribers must be separated by comma.
|
||||
|
||||
</div>
|
||||
|
||||
### Mailing List (Unsubscribable) {: .toggle }
|
||||
|
|
|
|||
|
|
@ -22,7 +22,8 @@ this tutorial with just one shell command:
|
|||
|
||||
Version | Release Date | Comment | Extra
|
||||
---|---|---|---
|
||||
[3.1](https://forum.iredmail.org/topic14079.html) | Apr 3, 2018 | | [RESTful API document](./iredadmin-pro.restful.api.html)
|
||||
[3.2](https://forum.iredmail.org/topic15065.html) | Dec 17, 2018 | | [RESTful API document](./iredadmin-pro.restful.api.html)
|
||||
[3.1](https://forum.iredmail.org/topic14079.html) | Apr 3, 2018 | | [RESTful API document](./iredadmin-pro.restful.api-20181217.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)
|
||||
|
|
|
|||
|
|
@ -56,10 +56,16 @@ this tutorial with just one shell command:</p>
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="https://forum.iredmail.org/topic15065.html">3.2</a></td>
|
||||
<td>Dec 17, 2018</td>
|
||||
<td></td>
|
||||
<td><a href="./iredadmin-pro.restful.api.html">RESTful API document</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://forum.iredmail.org/topic14079.html">3.1</a></td>
|
||||
<td>Apr 3, 2018</td>
|
||||
<td></td>
|
||||
<td><a href="./iredadmin-pro.restful.api.html">RESTful API document</a></td>
|
||||
<td><a href="./iredadmin-pro.restful.api-20181217.html">RESTful API document</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://forum.iredmail.org/topic13212.html">3.0</a></td>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -53,8 +53,8 @@
|
|||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<ul>
|
||||
<li>This document is applicable to <code>iRedAdmin-Pro-SQL-2.9.0</code> and
|
||||
<code>iRedAdmin-Pro-LDAP-3.1</code>. If you're running an old release, please
|
||||
<li>This document is applicable to <code>iRedAdmin-Pro-SQL-3.0</code> and
|
||||
<code>iRedAdmin-Pro-LDAP-3.2</code>. If you're running an old release, please
|
||||
upgrade iRedAdmin-Pro to the latest release, or check
|
||||
<a href="./iredadmin-pro.releases.html">document for old releases</a>.</li>
|
||||
<li>If you need an API which has not yet been implemented, don't hesitate to
|
||||
|
|
@ -880,6 +880,21 @@ to be a domain admin.</p>
|
|||
<td>Mailbox quota (in MB)</td>
|
||||
<td><code>quota=1024</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mailboxFormat</code></td>
|
||||
<td>Mailbox format. e.g. <code>maildir</code>, <code>mdbox</code>. Defaults to <code>maildir</code> if not present. For more details, please read Dovecot document: <a href="https://wiki2.dovecot.org/MailboxFormat">https://wiki2.dovecot.org/MailboxFormat</a>. <strong>WARNING</strong>: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately.</td>
|
||||
<td><code>mailboxFormat=mdbox</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mailboxFolder</code></td>
|
||||
<td>Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to <code>Maildir</code>. It's useful if you need to migrate to different mailbox folder. <strong>WARNING</strong>: New email will be stored in new mailbox folder immediately.</td>
|
||||
<td><code>mailboxFolder=Maildir</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maildir</code></td>
|
||||
<td>Absolute path of the mailbox. All characters will be converted to lower cases.</td>
|
||||
<td><code>maildir=/var/vmail/vmail1/example.com/username</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
|
@ -921,10 +936,15 @@ to be a domain admin.</p>
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>password</code></td>
|
||||
<td>Password</td>
|
||||
<td>Set user password to the given one.</td>
|
||||
<td><code>password=u0tBF82cIV@vi8Gme</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>password_hash</code></td>
|
||||
<td>Set user password to the given hashed password. Conflict with parameter <code>password</code>.</td>
|
||||
<td><code>password={SSHA}qjmhvlsofWDu/AvVhOJX1cU/CvYKLYlwlM5bHw==</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>quota</code></td>
|
||||
<td>Mailbox quota (in MB)</td>
|
||||
<td><code>quota=1024</code></td>
|
||||
|
|
@ -989,6 +1009,21 @@ to be a domain admin.</p>
|
|||
<td>Add new per-user enabled mail service(s). Multiple values must be separated by comma. Conflicts with parameter <code>services</code>. See additional notes below.</td>
|
||||
<td><code>removeService=forward,senderbcc</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mailboxFormat</code></td>
|
||||
<td>Mailbox format. e.g. <code>maildir</code>, <code>mdbox</code>. Defaults to <code>maildir</code> if not present. For more details, please read Dovecot document: <a href="https://wiki2.dovecot.org/MailboxFormat">https://wiki2.dovecot.org/MailboxFormat</a>. <strong>WARNING</strong>: Changing mailbox format does not migrate the mailbox on file system automatically, you have to migrate it manually. New email will be stored in new mailbox format immediately.</td>
|
||||
<td><code>mailboxFormat=mdbox</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mailboxFolder</code></td>
|
||||
<td>Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to <code>Maildir</code>. It's useful if you need to migrate to different mailbox folder. <strong>WARNING</strong>: New email will be stored in new mailbox folder immediately.</td>
|
||||
<td><code>mailboxFolder=Maildir</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>maildir</code></td>
|
||||
<td>Absolute path of the mailbox. All characters will be converted to lower cases.</td>
|
||||
<td><code>maildir=/var/vmail/vmail1/example.com/username</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="admonition attention">
|
||||
|
|
@ -1000,12 +1035,16 @@ to be a domain admin.</p>
|
|||
<ul>
|
||||
<li>smtp</li>
|
||||
<li>smtpsecured (SMTP over TLS or SSL)</li>
|
||||
<li>smtptls (SMTP over TLS)</li>
|
||||
<li>pop3</li>
|
||||
<li>pop3secured (POP3 over TLS or SSL)</li>
|
||||
<li>pop3tls (POP3 over TLS)</li>
|
||||
<li>imap</li>
|
||||
<li>imapsecured (IMAP over TLS or SSL)</li>
|
||||
<li>imaptls (IMAP over TLS)</li>
|
||||
<li>managesieve</li>
|
||||
<li>managesievesecured (Managesieve over TLS or SSL)</li>
|
||||
<li>managesievetls (Managesieve over TLS)</li>
|
||||
<li>deliver (deliver received email to local mailbox)</li>
|
||||
<li>sogo (SOGo groupware)</li>
|
||||
</ul>
|
||||
|
|
@ -1026,7 +1065,7 @@ to be a domain admin.</p>
|
|||
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">POST</code> <code class="url">/api/user/<mail>/change_email/<new_mail></code> <code class="comment">Change user's email address (from '<mail>' to '<new_mail>')</code></p>
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/<mail>/change_email/<new_mail></code> <code class="comment">Change user's email address (from '<mail>' to '<new_mail>')</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/<domain></code> <code class="comment">Update profiles of all users under domain</code> <code class="has_params">Parameters</code></p>
|
||||
|
|
@ -1098,7 +1137,54 @@ to be a domain admin.</p>
|
|||
</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>
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/mls/<domain></code> <code class="comment">Get profile of all mailing lists under given domain</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>email_only</code></td>
|
||||
<td><code>email_only=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Return a list of mailing list email addresses instead of detailed profile.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</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> <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>with_subscribers</code></td>
|
||||
<td><code>with_subscribers=yes</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Get subscribers of mailing list.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</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>
|
||||
|
|
@ -1326,6 +1412,37 @@ to be a domain admin.</p>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Parameters used to add subscribers:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Sample Usage</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>subscribers</code></td>
|
||||
<td><code>subscribers=<mail1>,<mail2>,<mail3>,...</code></td>
|
||||
<td></td>
|
||||
<td>Subscribe users to mailing list. Multiple subscribers must be separated by comma.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>require_confirm</code></td>
|
||||
<td><code>require_confirm=no</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>Send email to subscribers and let subscribers confirm the subscription.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subscription</code></td>
|
||||
<td><code>subscription=normal</code></td>
|
||||
<td><code>normal</code></td>
|
||||
<td>Subscribe to different subscription. Valid values are: <code>normal</code>, <code>digest</code>, <code>nomail</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
|
@ -1578,6 +1695,56 @@ to be a domain admin.</p>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Parameters used to add subscribers:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Sample Usage</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>add_subscribers</code></td>
|
||||
<td><code>add_subscribers=<mail1>,<mail2>,<mail3>,...</code></td>
|
||||
<td></td>
|
||||
<td>Subscribe users to mailing list. Multiple subscribers must be separated by comma.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>require_confirm</code></td>
|
||||
<td><code>require_confirm=no</code></td>
|
||||
<td><code>yes</code></td>
|
||||
<td>Send email to subscribers and let subscribers confirm the subscription.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>subscription</code></td>
|
||||
<td><code>subscription=normal</code></td>
|
||||
<td><code>normal</code></td>
|
||||
<td>Subscribe to different subscription. Valid values are: <code>normal</code>, <code>digest</code>, <code>nomail</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Parameters used to remove subscribers:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Sample Usage</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>remove_subscribers</code></td>
|
||||
<td><code>remove_subscribers=<mail1>,<mail2>,<mail3>,...</code></td>
|
||||
<td></td>
|
||||
<td>Remove existing subscribers from mailing list. Multiple subscribers must be separated by comma.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue