elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update iRedAdmin-Pro RESTful API doc.

This commit is contained in:
Zhang Huangbin 2018-05-30 09:26:27 +08:00
parent bd297f5018
commit d39d47f387
4 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
View File

@ -310,6 +310,7 @@ Notes:
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
`quota` | Mailbox quota (in MB) | `quota=1024`
`mailbox_format` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat> | `mailbox_format=mdbox`
`mailbox_folder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's not recommended to change this if you're using mailbox format `maildir`. | `mailbox_folder=Maildir`
</div>
@ -339,6 +340,8 @@ 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`
`mailbox_format` | Mailbox format. e.g. `maildir`, `mdbox`. Defaults to `maildir` if not present. For more details, please read Dovecot document: <https://wiki2.dovecot.org/MailboxFormat> | `mailbox_format=mdbox`
`mailbox_folder` | Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to `Maildir`. It's not recommended to change this if you're using mailbox format `maildir`. | `mailbox_folder=Maildir`
!!! attention

15
en_US/upgrade/0-upgrade.iredmail.0.9.8-0.9.9.md
View File

@ -183,21 +183,12 @@ different mailbox format, or set different mailbox for new user.
If you use different mailbox format, you need to set mailbox format to the
one you're using.
Download SQL template file used to update SQL database:
Download SQL template file and import it:
```
cd /root/
wget https://bitbucket.org/zhb/iredmail/raw/default/extra/update/0.9.9/iredmail.pgsql
```
Connect to PostgreSQL server as `postgres` user and import the SQL file:
* on Linux, it's `postgres` user
* on FreeBSD, it's `pgsql` user
* on OpenBSD, it's `_postgresql` user
```
mysql vmail < /root/iredmail.pgsql
wget https://bitbucket.org/zhb/iredmail/raw/default/extra/update/0.9.9/iredmail.mysql
mysql vmail < /root/iredmail.mysql
```
### Dovecot: read mailbox format from SQL

15
html/iredadmin-pro.restful.api-new.html
View File

@ -885,6 +885,11 @@ to be a domain admin.</p>
<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></td>
<td><code>mailbox_format=mdbox</code></td>
</tr>
<tr>
<td><code>mailbox_folder</code></td>
<td>Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to <code>Maildir</code>. It's not recommended to change this if you're using mailbox format <code>maildir</code>.</td>
<td><code>mailbox_folder=Maildir</code></td>
</tr>
</tbody>
</table>
</div>
@ -999,6 +1004,16 @@ 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>mailbox_format</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></td>
<td><code>mailbox_format=mdbox</code></td>
</tr>
<tr>
<td><code>mailbox_folder</code></td>
<td>Mailbox folder name (case sensitive) which will be appended to user's home path. Defaults to <code>Maildir</code>. It's not recommended to change this if you're using mailbox format <code>maildir</code>.</td>
<td><code>mailbox_folder=Maildir</code></td>
</tr>
</tbody>
</table>
<div class="admonition attention">

12
html/upgrade.iredmail.0.9.8-0.9.9.html
View File

@ -210,16 +210,10 @@ different mailbox format, or set different mailbox for new user.</p>
<p>If you use different mailbox format, you need to set mailbox format to the
one you're using.</p>
</div>
<p>Download SQL template file used to update SQL database:</p>
<p>Download SQL template file and import it:</p>
<pre><code>cd /root/
wget https://bitbucket.org/zhb/iredmail/raw/default/extra/update/0.9.9/iredmail.pgsql
</code></pre>
<p>Connect to PostgreSQL server as <code>postgres</code> user and import the SQL file:
<em> on Linux, it's <code>postgres</code> user
</em> on FreeBSD, it's <code>pgsql</code> user
* on OpenBSD, it's <code>_postgresql</code> user</p>
<pre><code>mysql vmail &lt; /root/iredmail.pgsql
wget https://bitbucket.org/zhb/iredmail/raw/default/extra/update/0.9.9/iredmail.mysql
mysql vmail &lt; /root/iredmail.mysql
</code></pre>
<h3 id="dovecot-read-mailbox-format-from-sql">Dovecot: read mailbox format from SQL</h3>