Cleaning Mail Queue

The clean-mail-queue operation is used to reboot your server.

Request Packet

A request XML packet (server_input.xsd) that clears the mail queue:

<packet>
  <server>
    <clean-mail-queue/>
  </server>
</packet>

Response Packet Structure

The clean-mail-queue node of the output XML packet is of complex type (server_output.xsd) which has the following presentation:

• result, required.
  It wraps the result of the clean-mail-queue operation. Data type: resultType (common.xsd).
• status, required.
  It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
• errcode, required if the operation fails.
  Returns error code. Data type: unsignedInt.
• errtext, required if the operation fails.
  Returns error message. Data type: string.

A positive response from the server looks as follows:

<packet>
  <server>
    <clean-mail-queue>
      <result>
        <status>ok</status>
      </result>
    </clean-mail-queue>
  </server>
</packet>

Samples

This request clears the mail queue:

<packet>
  <server>
    <clean-mail-queue/>
  </server>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <server>
    <clean-mail-queue>
      <result>
        <status>ok</status>
      </result>
    </clean-mail-queue>
  </server>
</packet>