Activating Mailing Lists Service

Use the enable operation to activate mailing lists service on a specified site.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet activating a mailing lists service includes the enable operation node:

<packet>
<maillist>
<enable>
...  
</enable>
</maillist>
</packet>

 

The enable node is presented by the MaillistEnableInputType type (maillist.xsd), and its graphical representation is as follows:

 

Remarks

You can activate mailing lists service on multiple sites using different filtering rules in a single packet. Add as many enable operations as the number of different filtering rules to be applied.

<enable>
   ...
</enable>
   ...
<enable>
   ...
</enable>

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

 

Response Packet Structure

The enable node of the output XML packet is presented by type MaillistEnableOutputType (maillist.xsd) and structured as follows:

 

 

Samples

Activating mailing lists service on a single site

This request packet activates the mailing lists service on the site called Mysite.com.

<packet>
<maillist>
<enable>
   <filter>
      <site-name>Mysite.com</site-name>
   </filter>
</enable>
</maillist>
</packet>

Response:

<packet>
<maillist>
<enable>
   <result>
      <status>ok</status>
      <filter-id>Mysite.com</filter-id>
   </result>
</enable>
</maillist>
</packet>

 

If the site was not found on the server, the result looks as follows:

<packet>
<maillist>
<enable>
   <result>
      <status>error</status>
      <errcode>1015</errcode>
      <errtext>Domain does not exist</errtext>
      <filter-id>Mysite.com</filter-id>
   </result>
</enable>
</maillist>
</packet> 
Enabling mailing lists service on multiple sites

This request packet activates mailing lists service on the sites Mysite.com, My2site.com, and on the site specified by ID 5.

<packet>
<maillist>
<enable>
   <filter>
      <site-name>Mysite.com</site-name>
      <site-name>My2site.com</site-name>
   </filter>
</enable>
<enable>
   <filter>
      <site-id>5</site-id>
   </filter>
</enable>
</maillist>
</packet>

 

A positive response from the server can look as follows:

<packet>
<maillist>
<enable>
   <result>
      <status>ok</status>
      <filter-id>Mysite.com</filter-id>
   </result>
   <result>
      <status>ok</status>
      <filter-id>My2site.com</filter-id>
   </result>
</enable>
<enable>
   <result>
      <status>ok</status>
      <filter-id>5</filter-id>
   </result>
</enable>
</maillist>
</packet>