The get-available operation is used to retrieve the list of webmail services available for selection in hosting plan settings.
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>
The get-available node of the output XML packet is structured as follows:
webmail.xsd
). 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.