Retrieving types of lists available for a single user
This request packet retrieves available types of server lists.
<packet version="1.4.2.0">
<spamfilter>
<get-allowed-lists>
<filter>
<username>admin</username>
</filter>
</get-allowed-lists>
</spamfilter>
</packet>
The positive response from the server looks as follows:
<packet version="1.4.2.0">
<spamfilter>
<get-allowed-lists>
<result>
<status>ok</status>
<filter-id>admin</filter-id>
<list>black</list>
<list>white</list>
</result>
</get-allowed-lists>
</spamfilter>
</packet>
If the SpamAssassin service was not found on the server, the response is as follows:
<packet version="1.4.2.0">
<spamfilter>
<get-allowed-lists>
<result>
<status>error</status>
<errcode>1026</errcode>
<errtext>Component is not installed.</errtext>
<filter-id>admin</filter>
</result>
</get-allowed-lists>
</spamfilter>
</packet>
Retrieving types of lists available for multiple users
This packet retrieves types of lists available for mailboxes mybox@domain.com and my@domain.com.
<packet version="1.4.2.0">
<spamfilter>
<get-allowed-lists>
<filter>
<username>mybox@domain.com</username>
<username>my@domain.com</username>
</filter>
</get-allowed-lists>
</spamfilter>
</packet>
If mailbox mybox@domain.com was not found on the server, the response looks as follows:
<packet version="1.4.2.0">
<spamfilter>
<get-allowed-lists>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>Mailbox does not exist.</errtext>
<filter-id>mybox@domain.com</filter>
</result>
<result>
<status>ok</status>
<filter-id>my@domain.com</filter-id>
<list>black</list>
<list>white</list>
<list>unblack</list>
<list>unwhite</list>
</result>
</get-allowed-lists>
</spamfilter>
</packet>