Overview | Service | Command |
Applies one or more filter rules to messages specified by a comma-separated ID list,
or returned by a search query. One or the other can be specified, but not both. Returns the list of ids of
existing messages that were affected.
Note that redirect actions are ignored when applying filter rules to existing messages.
Authorization token required | true |
Admin Authorization token required | false |
<ApplyFilterRulesRequest> ## ApplyFilterRulesRequest
<filterRules>
(<filterRule [name="..."] /> ## NamedElement)*
</filterRules>
<m ids="{ids}" /> ## IdsAttr
<query>{query} (String)</query>
</ApplyFilterRulesRequest>
The following table describes elements and attributes you can define within a
<ApplyFilterRulesRequest>
element:
XPath | Required / Optional | Description |
/filterRules | Required (only 1) | |
/filterRules/filterRule | Optional (0 or more) | |
/filterRules/filterRule@name | Optional (0 or 1) | Type:String Name |
/m | Optional (0 or 1) | Comma-separated list of message IDs |
/m@ids | Required (only 1) | Type:String IDs |
/query | Optional (0 or 1) | Type:{query} (String) Query string |
<ApplyFilterRulesResponse> ## ApplyFilterRulesResponse
<m ids="{ids}" /> ## IdsAttr
</ApplyFilterRulesResponse>
The following table describes elements and attributes you can define within a
<ApplyFilterRulesResponse>
element:
XPath | Required / Optional | Description |
/m | Optional (0 or 1) | Comma-separated list of message IDs that were affected |
/m@ids | Required (only 1) | Type:String IDs |