Request Packet Structure
A request XML packet adding a pattern includes the add-pattern operation node:
The add-pattern node is presented by the SpamFilterAddPatternInputType type (
spamfilter.xsd), and its graphical representation is as follows:
- The filter node is required. It specifies the filtering rule. Data type: SpamPatternFilter (
- The list node is required. It specifies the type of the list. For information on list types, refer to the Types of Server Lists and Types of Lists available for Mailbox Owners sections. Data type: SpamListType (
spamfilter.xsd). Allowed values: black | white | unblack | unwhite.
- The username node is required.It specifies the name of a SpamAssassin user. You can specify e-mail address of a mailbox owner, or the 'admin' value. To access server black (white) lists, you should set 'admin' as a value for this node. Data type: string.
- The spamfilter-id node is required. It specifies the ID of a SpamAssassin user. Data type: integer.
You can add patterns to multiple users in a single packet. Add as many add-pattern operations as the number of different users to be affected.