Response Packet Structure

The get-allowed-preferences node of the output XML packet is presented by type SpamFilterGetAllowedPreferencesOutputType (spamfilter.xsd) and structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (common.xsd).
• The status node is required. It specifies the execution status of the get-allowed-preferences operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the get-allowed-preferences operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the get-allowed-preferences operation fails. Data type: string.
• The filter-id node is optional. It holds the filtering rule parameter. For information, refer to the Filtering Issues section. Data type: anySimpleType.
• The id node is optional. It does not return any data for this operation. Data type: integer.
• The preference node is optional. It holds Spam Filtering preferences available for the specified SpamAssassin user. Data type: string.

Note: preferences are separated by the <preference> tag.