Filtering is the way the request XML packet indicates the object to which an operation will be applied. The request XML packet filters objects using a special <filter> section. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.
Note: Please, do not confuse this with Spam Filtering methods. Spam Filtering is made by the tool integrated into Plesk, and this kind of filtering is a specification of the operator.
The SpamPatternFilter filter is used in add-pattern and del-pattern operations to add or remove patterns. For more information on the operations, refer to the Adding Pattern and Removing Pattern sections. Data type:SpamPatternFilter (
). The graphical representation of the filter node is as follows:
You can match multiple patterns using this filter as in the following example:
Note: Use the blank filter (<filter/>) to match all patterns.
The SpamassassinFilter filter is used in get-patterns, get , set, get-allowed-preferences, get-allowed-lists operations. For more information on the operations, refer to the following sections:
Data type:SpamassassinFilter (
spamfilter.xsd). The graphical representation of the filter node is as follows:
You can filter by either username or spamfilter-id parameters as in the following example:
A single operation does not support different types of parameters for a filtering rule, so the following filter will be considered invalid by Plesk:
If an operation uses filters in a request packet, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If one of the following values was set as a filter rule, it is returned in the filter-id node of the response packet.
It is done to trace the request parameters in case of an error. Data type: anySimple.
All operations except for the check possess the filter-id node in the response packet.
Please send us your feedback on this help page.