Removing a Webmail Service

The unregister operation is used to remove a webmail service.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

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:

unregisterInput

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

Important: 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:

unregisterOutput

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

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.