The unregister operation is used to remove a webmail service.

Request Packet Structure

A request XML packet removing a webmail service includes the unregister operation node:

<packet>
<webmail>
   <unregister>
   ...
   </unregister>
</webmail>
</packet>

The unregister node is presented by type UnRegisterInputType (webmail.xsd). Its graphical representation is as follows:

image 66994.gif

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.

  • The filter node is required. It specifies the criteria by which the necessary webmail service will be selected from the database.
  • The name node is required. It specifies the webmail service name. Data type: string.

Note: When creating request packets, put nodes and elements in the order they follow in the packet structure.

Response Packet Structure

The unregister node of the output XML packet is structured as follows:

image 67000.gif

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.

  • The result node is required. It wraps the information about the operation execution and the list of webmail services. Data type: WebmailResult (webmail.xsd).
  • The status node is required. It specifies the execution status of the operation. Data type: result_status (string). Allowed values: ok | error.
  • The errcode node is optional. It returns the error code. Data type: unsignedInt.
  • The errtext node is optional. It returns the error message. Data type: string.
  • The webmail node is required. It wraps the webmail service parameters.
  • The name node is required. It specifies the webmail service name. Data type: string.
  • The status node is optional. It specifies the webmail service status. Data type: string.
  • The url node is required. It specifies the webmail service URL. Data type: string.

Samples

This packet removes an external webmail service Horde from Plesk:

<packet>
<webmail>
   <unregister>
      <filter>
         <name>Horde</name>
      </filter>
   </unregister>
</webmail>
</packet>

Response:

<packet>
<webmail>
   <unregister>
      <result>
         <status>ok</status>
         <webmail>
            <name>Horde</name>
         </webmail>
      </result>
   </unregister>
</webmail>
</packet>
</webmail>
</packet>