Disabling a Webmail Service
The disable operation is used to make a webmail services unavailable for selection in hosting plan settings.
Request Packet Structure
A request XML packet making a webmail services unavailable for selection in hosting plan settings includes the disable operation node:
<packet version="1.6.3.1">
<webmail>
<disable>
...
</disable>
</webmail>
</packet>
The disable node is presented by type UnRegisterInputType (webmail.xsd)
. Its graphical representation is as follows:
- 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.
Response Packet Structure
The disable node of the output XML packet is structured as follows:
- 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 disables an external webmail service Horde:
<packet>
<webmail>
<disable>
<filter>
<name>Horde</name>
</filter>
</disable>
</webmail>
</packet>
Response:
<packet>
<webmail>
<disable>
<result>
<status>ok</status>
<webmail>
<name>Horde</name>
<status>false</status>
<url>http://example.com</url>
</webmail>
</result>
</disable>
</webmail>
</packet>