Sync doc of iRedAdmin-Pro RESTful API.
This commit is contained in:
parent
97caffd322
commit
60bc2f8a63
|
@ -389,7 +389,7 @@ Notes:
|
|||
Parameter | Default Value | Comment | Sample Usage
|
||||
--- |--- |--- |---
|
||||
`email_only` | `no` | Return a list of mail users' email addresses instead of detailed profiles. | `email_only=yes`
|
||||
`disabled_only` | `no` | Return only disabled mail domains | `disabled_only=yes`
|
||||
`disabled_only` | `no` | Return only disabled mail users. | `disabled_only=yes`
|
||||
|
||||
</div>
|
||||
|
||||
|
@ -643,6 +643,7 @@ Notes:
|
|||
Parameter | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`name` | Display name | `name=My List Name`
|
||||
`accountStatus` | Enable or disable domain. Valid values: `active`, `disabled`. | `accountStatus=active`
|
||||
`accessPolicy` | Defines who can send email to this mail alias account | `accessPolicy=public`
|
||||
`members` | Members of mail alias. Multiple members must be separated by comma. Conflict with parameter `addMember` and `removeMember`. | `members=user1@domain.com,user2@domain.com`
|
||||
`addMember` | Add new members of mail alias. Multiple members must be separated by comma. Conflict with parameter `members`. | `addMember=user1@domain.com,user2@domain.com`
|
||||
|
@ -652,6 +653,17 @@ Notes:
|
|||
|
||||
!!! api "`POST`{: .put } `/api/alias/<mail>/change_email/<new_mail>`{: .url } `Change email address of alias account (from '<mail>' to '<new_mail>')`{: .comment }"
|
||||
|
||||
!!! api "`GET`{: .get } `/api/aliases/<domain>`{: .url } `Get mail aliases' profiles under given domain`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params">
|
||||
|
||||
Parameter | Default Value | Comment | Sample Usage
|
||||
--- |--- |--- |---
|
||||
`email_only` | `no` | Return a list of mail aliases' email addresses instead of detailed profiles. | `email_only=yes`
|
||||
`disabled_only` | `no` | Return only disabled mail aliases. | `disabled_only=yes`
|
||||
|
||||
</div>
|
||||
|
||||
### Spam Policy {: .toggle }
|
||||
|
||||
!!! api "`GET`{: .get } `/api/spampolicy/global`{: .url } `Get global spam policy`{: .comment }"
|
||||
|
|
|
@ -1097,7 +1097,7 @@ to be a domain admin.</p>
|
|||
<tr>
|
||||
<td><code>disabled_only</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Return only disabled mail domains</td>
|
||||
<td>Return only disabled mail users.</td>
|
||||
<td><code>disabled_only=yes</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
@ -1964,6 +1964,11 @@ to be a domain admin.</p>
|
|||
<td><code>name=My List Name</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accountStatus</code></td>
|
||||
<td>Enable or disable domain. Valid values: <code>active</code>, <code>disabled</code>.</td>
|
||||
<td><code>accountStatus=active</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>accessPolicy</code></td>
|
||||
<td>Defines who can send email to this mail alias account</td>
|
||||
<td><code>accessPolicy=public</code></td>
|
||||
|
@ -1990,6 +1995,37 @@ to be a domain admin.</p>
|
|||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">POST</code> <code class="url">/api/alias/<mail>/change_email/<new_mail></code> <code class="comment">Change email address of alias account (from '<mail>' to '<new_mail>')</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/aliases/<domain></code> <code class="comment">Get mail aliases' profiles under given domain</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params">
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Default Value</th>
|
||||
<th>Comment</th>
|
||||
<th>Sample Usage</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>email_only</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Return a list of mail aliases' email addresses instead of detailed profiles.</td>
|
||||
<td><code>email_only=yes</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>disabled_only</code></td>
|
||||
<td><code>no</code></td>
|
||||
<td>Return only disabled mail aliases.</td>
|
||||
<td><code>disabled_only=yes</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="spam-policy">Spam Policy</h3>
|
||||
<div class="admonition api">
|
||||
|
|
Loading…
Reference in New Issue