| Authorization token required | true |
| Admin Authorization token required | true |
<MailQueueActionRequest> ## MailQueueActionRequest
<server name="{mta-server}"> ## ServerWithQueueAction
<queue name="{queue-name}"> ## MailQueueWithAction
<action op="{operation} (hold | release | delete | requeue)" by="{by} (id | query)"> ## MailQueueAction
List of any of: {
<query [offset="{offset} (Integer)"] [limit="{limit} (Integer)"]> ## QueueQuery
(<field name="{field-name}"> ## QueueQueryField
(<match value="{value}" /> ## ValueAttrib)*
</field>)*
</query>
}
</action>
</queue>
</server>
</MailQueueActionRequest>
elements and attributes you can define within a
<MailQueueActionRequest> element:
| XPath | Required / Optional | Description | ||||
| /server | Required (only 1) | Server with queue action | ||||
| /server@name | Required (only 1) | Type: String MTA server |
||||
| /server/queue | Required (only 1) | Queue | ||||
| /server/queue@name | Required (only 1) | Type: String Queue name |
||||
| /server/queue/action | Required (only 1) | Action | ||||
| /server/queue/action@op | Required (only 1) | Type: hold | release | delete | requeue Operation. |
||||
| /server/queue/action@by | Required (only 1) | Type: id | query By selector.
|
||||
| /server/queue/action/query | Required (only 1) | |||||
| /server/queue/action/query@offset | Optional (0 or 1) | Type: Integer Offset |
||||
| /server/queue/action/query@limit | Optional (0 or 1) | Type: Integer Limit the number of queue items to return in the response |
||||
| /server/queue/action/query/field | Optional (0 or more) | Queue query field | ||||
| /server/queue/action/query/field@name | Required (only 1) | Type: String Field name |
||||
| /server/queue/action/query/field/match | Optional (0 or more) | Match specification | ||||
| /server/queue/action/query/field/match@value | Required (only 1) | Type: String Value |
<MailQueueActionResponse /> ## MailQueueActionResponse