Retrieving the List of Supported Webmail Services

The get-supported operation is used to retrieve the list of supported webmail services.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving the list of supported webmail services includes the get-supported operation node:

<packet version="1.6.3.1">
<webmail>
   <get-supported />
</webmail>
</packet>

 

Response Packet Structure

The get-supported node of the output XML packet is structured as follows:

getSupportedOutput

 

Samples

This packet retrieves the list of supported external webmail services:

<packet>
<webmail>
   <get-supported />
</webmail>
</packet>

Response:

<packet>
<webmail>
   <get-supported>
      <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-supported>
</webmail>
</packet>

There are two supported 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.