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

iRedAdmin-Pro API: able to update per-user mail forwading addresses.

This commit is contained in:
Zhang Huangbin 2016-10-09 14:06:35 +08:00
parent 281394e6a9
commit 15b59c7dbf
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
en_US/faq/2-iredadmin-pro.restful.api.md
View File

@ -98,7 +98,7 @@ Notes:
Parameter Name | Summary | Sample Usage
--- |--- |---
`name` | Short description of this domain name. e.g. company name | `name=Google Inc`
`accountStatus` | Enable or disable domain | `accountStatus=active` (or `disabled`)
`accountStatus` | Enable or disable domain. Possible values: `active`, `disabled`. | `accountStatus=active`
`quota` | Mailbox quota for whole domain, in MB. | `quota=2048`
`language` | Default preferred language for newly created mail user | `language=en_US`
`transport` | Transport program | `transport=dovecot`
@ -154,7 +154,7 @@ Notes:
--- |--- |---
`name` | Display name | `name=My New Name`
`password` | Password| `password=AsTr0ng@`
`language` | Preferred language of web UI | `language=en_US`
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
`quota` | Mailbox quota (in MB) | `quota=1024`
</div>
@ -169,9 +169,10 @@ Notes:
`name` | Display name | `name=My New Name`
`password` | Password | `password=u0tBF82cIV@vi8Gme`
`quota` | Mailbox quota (in MB) | `quota=1024`
`accountStatus` | Enable or disable user | `accountStatus=active` (or `disabled`)
`language` | Preferred language of web UI | `language=en_US`
`accountStatus` | Enable or disable user. Possible values: `active`, `disabled`. | `accountStatus=active`
`language` | Preferred language of iRedAdmin web UI | `language=en_US`
`transport` | Transport program | `transport=dovecot`
`forwarding` | Per-user mail forwarding. Multiple addresses must be separated by comma. To save an email copy in mailbox, add original email address as one of forwarding addresses. | `forwarding=user1@domain.com,user2@domain.com,user3@domain.com`
</div>
@ -183,7 +184,7 @@ Notes:
--- |---
`accountStatus` | Account status. Possible value is: active, disabled.
`password` | Password
`language` | Preferred language of web UI
`language` | Preferred language of iRedAdmin web UI
`transport` | Per-user transport
</div>

19
html/iredadmin-pro.restful.api.html
View File

@ -200,8 +200,8 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
</tr>
<tr>
<td><code>accountStatus</code></td>
<td>Enable or disable domain</td>
<td><code>accountStatus=active</code> (or <code>disabled</code>)</td>
<td>Enable or disable domain. Possible values: <code>active</code>, <code>disabled</code>.</td>
<td><code>accountStatus=active</code></td>
</tr>
<tr>
<td><code>quota</code></td>
@ -366,7 +366,7 @@ to be a domain admin.</p>
</tr>
<tr>
<td><code>language</code></td>
<td>Preferred language of web UI</td>
<td>Preferred language of iRedAdmin web UI</td>
<td><code>language=en_US</code></td>
</tr>
<tr>
@ -412,12 +412,12 @@ to be a domain admin.</p>
</tr>
<tr>
<td><code>accountStatus</code></td>
<td>Enable or disable user</td>
<td><code>accountStatus=active</code> (or <code>disabled</code>)</td>
<td>Enable or disable user. Possible values: <code>active</code>, <code>disabled</code>.</td>
<td><code>accountStatus=active</code></td>
</tr>
<tr>
<td><code>language</code></td>
<td>Preferred language of web UI</td>
<td>Preferred language of iRedAdmin web UI</td>
<td><code>language=en_US</code></td>
</tr>
<tr>
@ -425,6 +425,11 @@ to be a domain admin.</p>
<td>Transport program</td>
<td><code>transport=dovecot</code></td>
</tr>
<tr>
<td><code>forwarding</code></td>
<td>Per-user mail forwarding. Multiple addresses must be separated by comma. To save an email copy in mailbox, add original email address as one of forwarding addresses.</td>
<td><code>forwarding=user1@domain.com,user2@domain.com,user3@domain.com</code></td>
</tr>
</tbody>
</table>
</div>
@ -452,7 +457,7 @@ to be a domain admin.</p>
</tr>
<tr>
<td><code>language</code></td>
<td>Preferred language of web UI</td>
<td>Preferred language of iRedAdmin web UI</td>
</tr>
<tr>
<td><code>transport</code></td>