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>

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

 

Response Packet Structure

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

getSupportedOutput

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

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

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.