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

Update RESTful API docs: able to update (some) user profiles.

This commit is contained in:
Zhang Huangbin 2016-04-12 23:37:25 +08:00
parent 9cba13b439
commit c94c1f317a
4 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -88,6 +88,21 @@ curl -X DELETE -i -b cookie.txt https://<server>/api/user/<mail>
* Replace `<mail>` by the (existing) email address.
#### Update mail user profiles (PUT)
```
curl -X PUT -i -b cookie.txt -d "var=<value>&var2=<value2>" https://<server>/api/user/<mail>
```
Optional PUT data:
* `name`: display name.
* `accountStatus`: enable or disable user. possible value is: active, disabled.
* `password`: set new password for user
* `quota`: set mailbox quota (in MB)
* `language`: set preferred language of web UI
* `transport`: set per-user transport
### Mail Alias (`/alias/<mail>`)
#### Create mail alias (POST)

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

@ -112,6 +112,23 @@ Optional POST data:
requests.delete(url + '/user/zhb@test.com', cookies=cookies)
```
#### Update mail user profiles (PUT)
```
requests.put(url + '/user/zhb@test.com',
cookies=cookies,
data={'password': '<a_strong_password>'})
```
Optional PUT data:
* `name`: display name.
* `accountStatus`: enable or disable user. possible value is: active, disabled.
* `password`: set new password for user
* `quota`: set mailbox quota (in MB)
* `language`: set preferred language of web UI
* `transport`: set per-user transport
### Mail Alias (`/alias/<mail>`)
#### Create mail alias (POST)

14
html/iredadmin-pro.restful.api.curl.html
View File

@ -24,6 +24,7 @@
<li><a href="#mail-user-usermail">Mail User (/user/&lt;mail&gt;)</a><ul>
<li><a href="#create-mail-user-post">Create mail user (POST)</a></li>
<li><a href="#delete-mail-user-delete">Delete mail user (DELETE)</a></li>
<li><a href="#update-mail-user-profiles-put">Update mail user profiles (PUT)</a></li>
</ul>
</li>
<li><a href="#mail-alias-aliasmail">Mail Alias (/alias/&lt;mail&gt;)</a><ul>
@ -120,6 +121,19 @@
<ul>
<li>Replace <code>&lt;mail&gt;</code> by the (existing) email address.</li>
</ul>
<h4 id="update-mail-user-profiles-put">Update mail user profiles (PUT)</h4>
<pre><code>curl -X PUT -i -b cookie.txt -d &quot;var=&lt;value&gt;&amp;var2=&lt;value2&gt;&quot; https://&lt;server&gt;/api/user/&lt;mail&gt;
</code></pre>
<p>Optional PUT data:</p>
<ul>
<li><code>name</code>: display name.</li>
<li><code>accountStatus</code>: enable or disable user. possible value is: active, disabled.</li>
<li><code>password</code>: set new password for user</li>
<li><code>quota</code>: set mailbox quota (in MB)</li>
<li><code>language</code>: set preferred language of web UI</li>
<li><code>transport</code>: set per-user transport</li>
</ul>
<h3 id="mail-alias-aliasmail">Mail Alias (<code>/alias/&lt;mail&gt;</code>)</h3>
<h4 id="create-mail-alias-post">Create mail alias (POST)</h4>
<pre><code>curl -X POST -i -b cookie.txt -d &quot;...&quot; https://&lt;server&gt;/api/alias/&lt;mail&gt;

16
html/iredadmin-pro.restful.api.python.html
View File

@ -24,6 +24,7 @@
<li><a href="#mail-user-usermail">Mail User (/user/&lt;mail&gt;)</a><ul>
<li><a href="#create-mail-user-post">Create mail user (POST)</a></li>
<li><a href="#delete-mail-user-delete">Delete mail user (DELETE)</a></li>
<li><a href="#update-mail-user-profiles-put">Update mail user profiles (PUT)</a></li>
</ul>
</li>
<li><a href="#mail-alias-aliasmail">Mail Alias (/alias/&lt;mail&gt;)</a><ul>
@ -138,6 +139,21 @@ cookies = r.cookies
<pre><code>requests.delete(url + '/user/zhb@test.com', cookies=cookies)
</code></pre>
<h4 id="update-mail-user-profiles-put">Update mail user profiles (PUT)</h4>
<pre><code>requests.put(url + '/user/zhb@test.com',
cookies=cookies,
data={'password': '&lt;a_strong_password&gt;'})
</code></pre>
<p>Optional PUT data:</p>
<ul>
<li><code>name</code>: display name.</li>
<li><code>accountStatus</code>: enable or disable user. possible value is: active, disabled.</li>
<li><code>password</code>: set new password for user</li>
<li><code>quota</code>: set mailbox quota (in MB)</li>
<li><code>language</code>: set preferred language of web UI</li>
<li><code>transport</code>: set per-user transport</li>
</ul>
<h3 id="mail-alias-aliasmail">Mail Alias (<code>/alias/&lt;mail&gt;</code>)</h3>
<h4 id="create-mail-alias-post">Create mail alias (POST)</h4>
<p>Create mail alias account <code>alias@test.com</code>.</p>