Cleaning Mail Queue

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

  

In this chapter:

Request Packet

Response Packet Structure

Samples

 

Request Packet

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

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

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

 

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:

CleanMailQueue

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

  • 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>
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.