Retrieving the List of Available Webmail Services
The get-available operation is used to retrieve the list of webmail services available for selection in hosting plan settings.
Request Packet Structure
A request XML packet retrieving the list of webmail services available for selection in hosting plan settings includes the get-available operation node:
<packet version="1.6.3.1">
<webmail>
<get-available />
</webmail>
</packet>
Response Packet Structure
The get-available 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 retrieves the list of available external webmail services:
<packet>
<webmail>
<get-available />
</webmail>
</packet>
Response:
<packet>
<webmail>
<get-available>
<result>
<status>ok</status>
<webmail>
<name>Horde</name>
<status>true</status>
<url>http://example.com</url>
</webmail>
<webmail>
<name>Webmail</name>
<status>true</status>
<url>http://mail.example.com</url>
</webmail>
</result>
</get-available>
</webmail>
</packet>
There are two available webmail services: Horde with URL http://example.com, available for adding to service plans, and Webmail with URL http://mail.example.com, available for adding to service plans.