Update iredadmin-pro.restful.api.html with some new APIs.
This commit is contained in:
Zhang Huangbin
parent
bfe35e6bea
commit
6c40ebfc89
|
|
@ -82,7 +82,7 @@ Possible `PUT` parameters used to update account profile:
|
|||
Parameter Name | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`cn` | display name | `cn=My List Name`
|
||||
`accessPolicy` | access policy | `accessPolicy=public`
|
||||
`accessPolicy` | Defines who can send email to this mailing list | `accessPolicy=public`
|
||||
|
||||
### Mail Alias
|
||||
|
||||
|
|
@ -97,19 +97,28 @@ Possible `PUT` parameters used to update account profile:
|
|||
Parameter Name | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`cn` | display name | `cn=My List Name`
|
||||
`accessPolicy` | access policy | `accessPolicy=public`
|
||||
`accessPolicy` | Defines who can send email to this mail alias account | `accessPolicy=public`
|
||||
|
||||
> Note: `accessPolicy` is available for only SQL backends.
|
||||
> Note: `accessPolicy` for mail alias account is available for only SQL backends.
|
||||
|
||||
### Throttling
|
||||
|
||||
URL | HTTP Method | Summary
|
||||
--- |---| ---
|
||||
/api/throttle/global | GET | Get global inbound and outbound throttle settings
|
||||
/api/throttle/inbound | POST | Set global inbound throttle setting
|
||||
/api/throttle/outbound | POST | Set global outbound throttle setting
|
||||
/api/throttle/global/inbound | GET | Get global inbound throttle settings
|
||||
/api/throttle/global/outbound | GET | Get global outbound throttle settings
|
||||
/api/throttle/global/inbound | POST | Set global inbound throttle setting
|
||||
/api/throttle/global/outbound | POST | Set global outbound throttle setting
|
||||
/api/throttle/<domain\>/inbound | GET | Get domain inbound throttle settings
|
||||
/api/throttle/<domain\>/outbound | GET | Get domain outbound throttle settings
|
||||
/api/throttle/<domain\>/inbound | POST | Set domain inbound throttle setting
|
||||
/api/throttle/<domain\>/outbound | POST | Set domain outbound throttle setting
|
||||
/api/throttle/<mail\>/inbound | GET | Get user inbound throttle settings
|
||||
/api/throttle/<mail\>/outbound | GET | Get user outbound throttle settings
|
||||
/api/throttle/<mail\>/inbound | POST | Set user inbound throttle setting
|
||||
/api/throttle/<mail\>/outbound | POST | Set user outbound throttle setting
|
||||
|
||||
Possible `POST` parameters used to set throttling:
|
||||
Possible `POST` parameters used to set throttle setting:
|
||||
|
||||
Parameter Name | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
|
|
|
|||
|
|
@ -242,7 +242,7 @@ account as mailing list.</p>
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>accessPolicy</code></td>
|
||||
<td>access policy</td>
|
||||
<td>Defines who can send email to this mailing list</td>
|
||||
<td><code>accessPolicy=public</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -291,13 +291,13 @@ account as mailing list.</p>
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>accessPolicy</code></td>
|
||||
<td>access policy</td>
|
||||
<td>Defines who can send email to this mail alias account</td>
|
||||
<td><code>accessPolicy=public</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<blockquote>
|
||||
<p>Note: <code>accessPolicy</code> is available for only SQL backends.</p>
|
||||
<p>Note: <code>accessPolicy</code> for mail alias account is available for only SQL backends.</p>
|
||||
</blockquote>
|
||||
<h3 id="throttling">Throttling</h3>
|
||||
<table>
|
||||
|
|
@ -310,23 +310,68 @@ account as mailing list.</p>
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>/api/throttle/global</td>
|
||||
<td>/api/throttle/global/inbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get global inbound and outbound throttle settings</td>
|
||||
<td>Get global inbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/inbound</td>
|
||||
<td>/api/throttle/global/outbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get global outbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/global/inbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set global inbound throttle setting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/outbound</td>
|
||||
<td>/api/throttle/global/outbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set global outbound throttle setting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<domain>/inbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get domain inbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<domain>/outbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get domain outbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<domain>/inbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set domain inbound throttle setting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<domain>/outbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set domain outbound throttle setting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<mail>/inbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get user inbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<mail>/outbound</td>
|
||||
<td>GET</td>
|
||||
<td>Get user outbound throttle settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<mail>/inbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set user inbound throttle setting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>/api/throttle/<mail>/outbound</td>
|
||||
<td>POST</td>
|
||||
<td>Set user outbound throttle setting</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Possible <code>POST</code> parameters used to set throttling:</p>
|
||||
<p>Possible <code>POST</code> parameters used to set throttle setting:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
Loading…
Reference in New Issue