diff --git a/en_US/faq/2-iredadmin-pro.restful.api.md b/en_US/faq/2-iredadmin-pro.restful.api.md index b95d9eaa..9f8290f9 100644 --- a/en_US/faq/2-iredadmin-pro.restful.api.md +++ b/en_US/faq/2-iredadmin-pro.restful.api.md @@ -69,7 +69,7 @@ Notes: --- |--- |--- `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc` `quota` | Per-domain mailbox quota, in MB. | `quota=2048` - `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US` + `language` | Default preferred language for newly created mail user | `language=en_US` `defaultQuota` | Default per-user mailbox quota for newly created user, in MB. | `defaultQuota=1024` `maxUserQuota` | Max mailbox quota of a mail user, in MB. | `maxUserQuota=2048` `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20` @@ -89,7 +89,7 @@ Notes: --- |--- |--- `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc` `quota` | Mailbox quota for whole domain, in MB. | `quota=2048` - `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US` + `language` | Default preferred language for newly created mail user | `language=en_US` `defaultQuota` | Default per-user mailbox quota for newly created user | `defaultQuota=1024` `maxUserQuota` | Max mailbox quota of a mail user | `maxUserQuota=2048` `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20` @@ -101,7 +101,19 @@ Notes: ### User {: .toggle } -!!! api "`POST`{: .post } `/api/user/`{: .url } `Create a new mail user`{: .comment }" +!!! api "`POST`{: .post } `/api/user/`{: .url } `Create a new mail user`{: .comment } `Parameters`{: .has_params }" + +
+ + Parameter Name | Summary | Sample Usage + --- |--- |--- + `cn` | Display name | `cn=My New Name` + `password` | Password| `password=AsTr0ng@` + `language` | Preferred language of web UI | `language=en_US` + `quota` | Mailbox quota (in MB) | `quota=1024` + +
+ !!! api "`DELETE`{: .delete } `/api/user/`{: .url } `Delete an existing mail user`{: .comment }" !!! api "`PUT`{: .put } `/api/user/`{: .url } `Update profile of an existing mail user`{: .comment } `Parameters`{: .has_params} " @@ -110,8 +122,7 @@ Notes: Parameter Name | Summary | Sample Usage --- |--- |--- `cn` | Display name | `cn=My New Name` - `language` | Preferred language of web UI | `preferredLanguage=en_US` - `mailQuota` | User's mailbox quota, in MB | `mailQuota=1024` + `language` | Preferred language of web UI | `language=en_US` `transport` | Transport program | `transport=dovecot` @@ -215,7 +226,16 @@ Notes: +### Export Accounts {: .toggle } +#### LDIF (LDAP backend only) {: .toggle } + +!!! api "`GET`{: .get } `/api/ldif/domain/`{: .url } `Export domain to LDIF`{: .comment } `upcoming`{: .upcoming }" +!!! api "`GET`{: .get } `/api/ldif/catchall/`{: .url } `Export per-domain catch-all account to LDIF`{: .comment } `upcoming`{: .upcoming }" +!!! api "`GET`{: .get } `/api/ldif/admin/`{: .url } `Export (separated) domain admin to LDIF`{: .comment } `upcoming`{: .upcoming }" +!!! api "`GET`{: .get } `/api/ldif/user/`{: .url } `Export mail user to LDIF`{: .comment } `upcoming`{: .upcoming }" +!!! api "`GET`{: .get } `/api/ldif/maillist/`{: .url } `Export mailing list account to LDIF`{: .comment } `upcoming`{: .upcoming }" +!!! api "`GET`{: .get } `/api/ldif/alias/`{: .url } `Export mail alias account to LDIF`{: .comment } `upcoming`{: .upcoming }" diff --git a/en_US/upgrade/0-upgrade.iredmail.0.9.5.1-0.9.6.md b/en_US/upgrade/0-upgrade.iredmail.0.9.5.1-0.9.6.md new file mode 100644 index 00000000..57e9f271 --- /dev/null +++ b/en_US/upgrade/0-upgrade.iredmail.0.9.5.1-0.9.6.md @@ -0,0 +1,53 @@ +# Upgrade iRedMail from 0.9.5-1 to 0.9.6 + +[TOC] + +!!! note "Paid Remote Upgrade Support" + + We offer remote upgrade support if you don't want to get your hands dirty, + check [the details](../support.html) and [contact us](../contact.html). + +!!! warning + + This tutorial is still a __DRAFT__, do not apply it. + +## TODO + +* Separated SOGo address book for LDAP backend. + +## ChangeLog + +* May 24, 2016: initial __DRAFT__. + +## General (All backends should apply these steps) + +### Update `/etc/iredmail-release` with new iRedMail version number + +iRedMail stores the release version in `/etc/iredmail-release` after +installation, it's recommended to update this file after you upgraded iRedMail, +so that you can know which version of iRedMail you're running. For example: + +``` +0.9.6 +``` + +### Upgrade iRedAPD (Postfix policy server) to the latest stable release (1.9.2) + +Please follow below tutorial to upgrade iRedAPD to the latest stable release: +[Upgrade iRedAPD to the latest stable release](./upgrade.iredapd.html) + +Detailed release notes are available [here](./iredapd.releases.html). + +### Upgrade iRedAdmin (open source edition) to the latest stable release (0.7.2) + +Please follow this tutorial to upgrade iRedAdmin open source edition to the +latest stable release: +[Upgrade iRedAdmin to the latest stable release](./migrate.or.upgrade.iredadmin.html) + +### Upgrade Roundcube webmail to the latest stable release (1.2.0) + +Please follow Roundcube official tutorial to upgrade Roundcube webmail to the +latest stable release immediately: [How to upgrade Roundcube](https://github.com/roundcube/roundcubemail/wiki/Upgrade). + +Note: package `rsync` must be installed on your server before upgrading. + diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index 5afad286..d840a06f 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -34,6 +34,10 @@
  • Mailing List
  • Mail Alias
  • Throttling
    • +
  • Export Accounts +
    • @@ -111,7 +115,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] language Default preferred language for newly created mail user -preferredLanguage=en_US +language=en_US defaultQuota @@ -155,7 +159,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] --- |--- |--- `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc` `quota` | Mailbox quota for whole domain, in MB. | `quota=2048` - `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US` + `language` | Default preferred language for newly created mail user | `language=en_US` `defaultQuota` | Default per-user mailbox quota for newly created user | `defaultQuota=1024` `maxUserQuota` | Max mailbox quota of a mail user | `maxUserQuota=2048` `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20` @@ -167,7 +171,42 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]

    User

    -

    POST /api/user/<mail> Create a new mail user

    +

    POST /api/user/<mail> Create a new mail user Parameters

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameter NameSummarySample Usage
    cnDisplay namecn=My New Name
    passwordPasswordpassword=AsTr0ng@
    languagePreferred language of web UIlanguage=en_US
    quotaMailbox quota (in MB)quota=1024
    +
    +

    DELETE /api/user/<mail> Delete an existing mail user

    @@ -193,12 +232,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] language Preferred language of web UI -preferredLanguage=en_US - - -mailQuota -User's mailbox quota, in MB -mailQuota=1024 +language=en_US transport @@ -431,6 +465,26 @@ please use mail alias account as mailing list.

    + +

    Export Accounts

    +

    LDIF (LDAP backend only)

    +
    +

    GET /api/ldif/domain/<domain> Export domain to LDIF upcoming

    +
    +
    +

    GET /api/ldif/catchall/<domain> Export per-domain catch-all account to LDIF upcoming

    +
    +
    +

    GET /api/ldif/admin/<mail> Export (separated) domain admin to LDIF upcoming

    +
    +
    +

    GET /api/ldif/user/<mail> Export mail user to LDIF upcoming

    +
    +
    +

    GET /api/ldif/maillist/<mail> Export mailing list account to LDIF upcoming

    +
    +
    +

    GET /api/ldif/alias/<mail> Export mail alias account to LDIF upcoming

    diff --git a/html/upgrade.iredmail.0.9.5.1-0.9.6.html b/html/upgrade.iredmail.0.9.5.1-0.9.6.html new file mode 100644 index 00000000..5d54504d --- /dev/null +++ b/html/upgrade.iredmail.0.9.5.1-0.9.6.html @@ -0,0 +1,83 @@ + + + + + Upgrade iRedMail from 0.9.5-1 to 0.9.6 + + + + +

    Upgrade iRedMail from 0.9.5-1 to 0.9.6

    +
    + +
    +
    +

    Paid Remote Upgrade Support

    +

    We offer remote upgrade support if you don't want to get your hands dirty, +check the details and contact us.

    +
    +
    +

    Warning

    +

    This tutorial is still a DRAFT, do not apply it.

    +
    +

    TODO

    +
      +
    • Separated SOGo address book for LDAP backend.
      • +
    +

    ChangeLog

    +
      +
    • May 24, 2016: initial DRAFT.
      • +
    +

    General (All backends should apply these steps)

    +

    Update /etc/iredmail-release with new iRedMail version number

    +

    iRedMail stores the release version in /etc/iredmail-release after +installation, it's recommended to update this file after you upgraded iRedMail, +so that you can know which version of iRedMail you're running. For example:

    +
    0.9.6
+
    + +

    Upgrade iRedAPD (Postfix policy server) to the latest stable release (1.9.2)

    +

    Please follow below tutorial to upgrade iRedAPD to the latest stable release: +Upgrade iRedAPD to the latest stable release

    +

    Detailed release notes are available here.

    +

    Upgrade iRedAdmin (open source edition) to the latest stable release (0.7.2)

    +

    Please follow this tutorial to upgrade iRedAdmin open source edition to the +latest stable release: +Upgrade iRedAdmin to the latest stable release

    +

    Upgrade Roundcube webmail to the latest stable release (1.2.0)

    +

    Please follow Roundcube official tutorial to upgrade Roundcube webmail to the +latest stable release immediately: How to upgrade Roundcube.

    +

    Note: package rsync must be installed on your server before upgrading.

    +

    All documents are available in BitBucket repository, and published under Creative Commons license. You can download the latest version for offline reading. If you found something wrong, please do contact us to fix it.

    +
    + + \ No newline at end of file