Response Samples

Retrieving Spam Filtering preferences available for a single user

This request packet retrieves Spam Filtering service preferences available for Administrator.

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

      <filter>

         <username>admin</username>

      </filter>

   </get-allowed-preferences>

</spamfilter>

</packet>

A positive response from the server looks as follows:

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

   <result>

      <status>ok</status>

      <filter-id>admin</filter-id>

      <preference>personal</preference>

      <preference>max-children-process</preference>

      <preference>required-score</preference>

      <preference>rewrite-header</preference>

   </result>

   </get-allowed-preferences>

</spamfilter>

</packet>

If the SpamAssassin service is restricted by Plesk licence key, or a user does not have access to SpamAssassin management, the response is as follows:

<packet version="1.4.2.0">

<spamfilter>

<get-allowed-preferences>

   <result>

      <status>error</status>

      <errcode>1006</errcode>

      <errtext>Permission denied.</errtext>

      <filter-id>admin</filter>

   </result>

</get-allowed-preferences>

</spamfilter>

</packet>

Retrieving Spam Filtering preferences available for multiple users

This request packet retrieves Spam Filtering preferences available for mailbox mybox@domain.com, and SpamAssassin user with ID 7.

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

      <filter>

         <username>mybox@domain.com</username>

      </filter>

   </get-allowed-preferences>

   <get-allowed-preferences>

      <filter>

         <spamfilter-id>7</spamfilter-id>

      </filter>

   </get-allowed-preferences>

</spamfilter>

</packet>

A positive response from the server looks as follows:

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

   <result>

      <status>ok</status>

      <filter-id>mybox@domain.com</filter-id>

      <preference>personal</preference>

      <preference>max-children-process</preference>

      <preference>required-score</preference>

      <preference>rewrite-header</preference>

   </result>

   </get-allowed-preferences>

   <get-allowed-preferences>

   <result>

      <status>ok</status>

      <filter-id>7</filter-id>

      <preference>reject-spam</preference>

      <preference>required-score</preference>

      <preference>rewrite-header</preference>

   </result>

   </get-allowed-preferences>

</spamfilter>

</packet>

This request packet retrieves Spam Filtering preferences available for mailboxes mybox@domain.com and my@domain.com.

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

      <filter>

         <username>mybox@domain.com</username>

         <username>my@domain.com</username>

      </filter>

   </get-allowed-preferences>

</spamfilter>

</packet>

A positive response from the server looks as follows:

<packet version="1.4.2.0">

<spamfilter>

   <get-allowed-preferences>

   <result>

      <status>ok</status>

      <filter-id>mybox@domain.com</filter-id>

      <preference>personal</preference>

      <preference>max-children-process</preference>

      <preference>required-score</preference>

      <preference>rewrite-header</preference>

   </result>

   <result>

      <status>ok</status>

      <filter-id>my@domain.com</filter-id>

      <preference>reject-spam</preference>

      <preference>required-score</preference>

      <preference>rewrite-header</preference>

   </result>

   </get-allowed-preferences>

</spamfilter>

</packet>