Fix typo in mlmmj integration docs.
This commit is contained in:
parent
9dab777bec
commit
2c0ec022c8
|
@ -300,7 +300,7 @@ iredmail_ldap_bind_password = 'xxxxxxxx'
|
|||
|
||||
```
|
||||
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
```
|
||||
|
||||
|
|
|
@ -330,7 +330,7 @@ iredmail_sql_db_password = '<password>'
|
|||
|
||||
```
|
||||
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
```
|
||||
|
||||
|
|
|
@ -332,7 +332,7 @@ iredmail_sql_db_password = '<password>'
|
|||
|
||||
```
|
||||
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
```
|
||||
|
||||
|
|
|
@ -392,12 +392,34 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
### Mailing List {: .toggle }
|
||||
### Subscribable Mailing List {: .toggle }
|
||||
|
||||
!!! attention
|
||||
|
||||
Mailing list is only available in OpenLDAP backend. For SQL backends,
|
||||
please use mail alias account as mailing list.
|
||||
This subscribable mailing list is available for both SQL and LDAP backends,
|
||||
it requires iRedMail-0.9.8 and later releases (it's implemented with
|
||||
[`mlmmj`](http://mlmmj.org) mailing list manager).
|
||||
|
||||
!!! api "`GET`{: .get } `/api/ml/<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 }"
|
||||
|
||||
!!! api "`DELETE`{: .delete } `/api/ml/<mail>`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`keep_archive` | Archive subscribable mailing list before deleting the account. | `keep_archive=no`
|
||||
|
||||
</div>
|
||||
|
||||
!!! api "`PUT`{: .put } `/api/ml/<mail>`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
### Mailing List (Unsubscribable, deprecated) {: .toggle }
|
||||
|
||||
!!! attention
|
||||
|
||||
This unsubscribable mailing list is only available in __LDAP__ backend.
|
||||
|
||||
!!! api "`GET`{: .get } `/api/maillist/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment }"
|
||||
!!! api "`POST`{: .post } `/api/maillist/<mail>`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
|
||||
|
|
|
@ -317,7 +317,7 @@ iredmail_ldap_bind_password = 'xxxxxxxx'
|
|||
directory used to store mailing lists:</li>
|
||||
</ul>
|
||||
<pre><code>MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
</code></pre>
|
||||
|
||||
|
|
|
@ -345,7 +345,7 @@ iredmail_sql_db_password = '<password>'
|
|||
directory used to store mailing lists:</li>
|
||||
</ul>
|
||||
<pre><code>MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
</code></pre>
|
||||
|
||||
|
|
|
@ -347,7 +347,7 @@ iredmail_sql_db_password = '<password>'
|
|||
directory used to store mailing lists:</li>
|
||||
</ul>
|
||||
<pre><code>MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive
|
||||
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
|
||||
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
|
||||
</code></pre>
|
||||
|
||||
|
|
|
@ -27,7 +27,8 @@
|
|||
<li><a href="#domain">Domain</a></li>
|
||||
<li><a href="#domain-admin">Domain Admin</a></li>
|
||||
<li><a href="#mail-user">Mail User</a></li>
|
||||
<li><a href="#mailing-list">Mailing List</a></li>
|
||||
<li><a href="#subscribable-mailing-list">Subscribable Mailing List</a></li>
|
||||
<li><a href="#mailing-list-unsubscribable-deprecated">Mailing List (Unsubscribable, deprecated)</a></li>
|
||||
<li><a href="#mail-alias">Mail Alias</a></li>
|
||||
<li><a href="#spam-policy">Spam Policy</a></li>
|
||||
<li><a href="#throttling">Throttling</a></li>
|
||||
|
@ -1087,11 +1088,49 @@ to be a domain admin.</p>
|
|||
</div>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="mailing-list">Mailing List</h3>
|
||||
<h3 class="toggle" id="subscribable-mailing-list">Subscribable Mailing List</h3>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>Mailing list is only available in OpenLDAP backend. For SQL backends,
|
||||
please use mail alias account as mailing list.</p>
|
||||
<p>This subscribable mailing list is available for both SQL and LDAP backends,
|
||||
it requires iRedMail-0.9.8 and later releases (it's implemented with
|
||||
<a href="http://mlmmj.org"><code>mlmmj</code></a> mailing list manager).</p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ml/<mail></code> <code class="comment">Get profile of an existing mailing list account</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/ml/<mail></code> <code class="comment">Create a new mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/ml/<mail></code> <code class="comment">Delete an existing mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params">
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Summary</th>
|
||||
<th>Sample Usage</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>keep_archive</code></td>
|
||||
<td>Archive subscribable mailing list before deleting the account.</td>
|
||||
<td><code>keep_archive=no</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/ml/<mail></code> <code class="comment">Update profile of an existing mailing list</code> <code class="has_params">Parameters</code></p>
|
||||
</div>
|
||||
<h3 class="toggle" id="mailing-list-unsubscribable-deprecated">Mailing List (Unsubscribable, deprecated)</h3>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>This unsubscribable mailing list is only available in <strong>LDAP</strong> backend.</p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/maillist/<mail></code> <code class="comment">Get profile of an existing mailing list account</code></p>
|
||||
|
|
Loading…
Reference in New Issue