Response Packet Structure

The get node of the output XML packet is presented by type SpamFilterGetOutputType (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 operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the get operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the get 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 returns the ID of the Spamassassin user if the operation succeeds. Data type: integer.

  
  The following nodes are nested in the response packet only if the operation succeeds:
  

• The username node is optional. It holds the e-mail address of SpamAssassin user, or string 'admin'. Data type: string.
• The enabled node is optional. It specifies if the Spam Filtering service is enabled for a specified SpamAssassin user. For more information, refer to the Managing Spam Filtering section. Data type: none.
• The disabled node is optional. It specifies if the Spam Filtering service is disabled for a specified SpamAssassin user. For more information, refer to the Managing Spam Filtering section. Data type: none.
• The preferences node is optional. It specifies preferences of Spam Filtering service for a specified user. For information on preferences, refer to the Spam Filtering Preferences section. Data type: SpamassassinPreferencesType (spamfilter.xsd).