Service: zimbraMail
Namespace: "urn:zimbraMail"
ApplyOutgoingFilterRules SOAP 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.

Authorization token required true
Admin Authorization token required false

ApplyOutgoingFilterRulesRequest

    <ApplyOutgoingFilterRulesRequest> ## ApplyOutgoingFilterRulesRequest
        <filterRules>
            (<filterRule [name="..."] /> ## NamedElement)*
        </filterRules>
        <m ids="{ids}" /> ## IdsAttr
        <query>{query} (String)</query>
    </ApplyOutgoingFilterRulesRequest>

The following table describes elements and attributes you can define within a <ApplyOutgoingFilterRulesRequest> 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

ApplyOutgoingFilterRulesResponse

    <ApplyOutgoingFilterRulesResponse> ## ApplyOutgoingFilterRulesResponse
        <m ids="{ids}" /> ## IdsAttr
    </ApplyOutgoingFilterRulesResponse>

The following table describes elements and attributes you can define within a <ApplyOutgoingFilterRulesResponse> 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