Overview | Service | Command |
Get a count of all the mail queues by counting the number of files in the queue directories. Note that the admin server waits for queue counting to complete before responding - client should invoke requests for different servers in parallel.
Authorization token required | true |
Admin Authorization token required | true |
<GetMailQueueInfoRequest> ## GetMailQueueInfoRequest
<server [name="..."] /> ## NamedElement
</GetMailQueueInfoRequest>
The following table describes elements and attributes you can define within a
<GetMailQueueInfoRequest>
element:
XPath | Required / Optional | Description |
/server | Required (only 1) | MTA Server |
/server@name | Optional (0 or 1) | Type:String Name |
<GetMailQueueInfoResponse> ## GetMailQueueInfoResponse
<server name="{mta-server}"> ## ServerQueues
(<queue name="{queue-name}" n="{file-count}" /> ## MailQueueCount)*
</server>
</GetMailQueueInfoResponse>
The following table describes elements and attributes you can define within a
<GetMailQueueInfoResponse>
element:
XPath | Required / Optional | Description |
/server | Required (only 1) | Information on queues organised by server |
/server@name | Required (only 1) | Type:String MTA server |
/server/queue | Optional (0 or more) | Queue information |
/server/queue@name | Required (only 1) | Type:String Queue name |
/server/queue@n | Required (only 1) | Type:String Count of the number of files in a queue directory |