Registering an External Webmail Service

The register operation is used to register an external webmail service.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet registering an external webmail service includes the register operation node:

<packet>
<webmail>
   <register>
   ...
   </register>
</webmail>
</packet>

The register node is presented by type RegisterInputType (webmail.xsd). Its graphical representation is as follows:

registerInput

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The register node of the output XML packet is structured as follows:

registerOutput

 

Samples

This packet registers an external webmail service Horde in Plesk, the webmail service URL is http://example.com and it will be available for adding to service plans:

<packet>
<webmail>
   <register>
      <filter>
      <service>
         <name>Horde</name>
         <url>http://example.com</url>
         <status>true</status>
      </service>
      </filter>
   </register>
</webmail>
</packet>

Response:

<packet>
<webmail>
   <register>
      <result>
         <status>ok</status>
         <webmail>
            <name>Horde</name>
            <status>true</status>
            <url>http://example.com</url>
         </webmail>
      </result>
   </register>
</webmail>
</packet>