Namespace: "urn:zimbraAdmin"
GetFilterRules SOAP Command

Get filter rules

Authorization token required true
Admin Authorization token required true

GetFilterRulesRequest

    <GetFilterRulesRequest type="{type}"> ## GetFilterRulesRequest
        <account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
        <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
        <cos [by="{cos-selector-by} (id|name)"]>{key}</cos> ## CosSelector
        <server [by="{server-by} (id|name|serviceHostname)"]>{key}</server> ## ServerSelector
    </GetFilterRulesRequest>

The following table describes elements and attributes you can define within a <GetFilterRulesRequest> element:

XPath Required / Optional Description
@type Required (only 1) Type:String
Type can be either before or after
/account Optional (0 or 1) Type:{key}
Account
Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/account@by Required (only 1) Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal
Select the meaning of {acct-selector-key}
/domain Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by}
/domain@by Optional (0 or 1) Type:id|name|virtualHostname|krb5Realm|foreignName
Select the meaning of {domain-selector-key}
/cos Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the COS. Meaning determined by {cos-selector-by}
/cos@by Optional (0 or 1) Type:id|name
Select the meaning of {cos-selector-key}
/server Optional (0 or 1) Type:{key}
Domain
Description for element text content:Key for choosing server
{server-by}="id" Use server's zimbraId as the Key
{server-by}="name" Use name of the server as the Key
{server-by}="serviceHostname" Use server's value for attr zimbraServiceHostname as the Key
/server@by Optional (0 or 1) Type:id|name|serviceHostname
Selects the meaning of {server-key}

GetFilterRulesResponse

    <GetFilterRulesResponse type="{type}"> ## GetFilterRulesResponse
        <account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
        <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
        <cos [by="{cos-selector-by} (id|name)"]>{key}</cos> ## CosSelector
        <server [by="{server-by} (id|name|serviceHostname)"]>{key}</server> ## ServerSelector
        <filterRules>
            (<filterRule name="{rule-name}" active="{active-flag} (0|1)"> ## FilterRule
                <filterVariables [index="{index} (int)"]> ## FilterVariables
                    (<filterVariable name="{rule-name}" value="{value}" /> ## FilterVariable)+
                 </filterVariables>
                <filterTests condition="{condition-allof|anyof}"> ## FilterTests
                    List of any of: {
                        <addressBookTest header="..." [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$AddressBookTest
                        <addressTest header="..." part="..." stringComparison="..." [caseSensitive="(0|1)"] value="..."
                                         [valueComparison="..."] [countComparison="..."] [valueComparisonComparator="..."]
                                         [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$AddressTest
                        <envelopeTest header="..." part="..." stringComparison="..." [caseSensitive="(0|1)"] value="..."
                                          [valueComparison="..."] [countComparison="..."] [valueComparisonComparator="..."]
                                          [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$EnvelopeTest
                        <attachmentTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$AttachmentTest
                        <bodyTest [value="..."] [caseSensitive="(0|1)"] [index="{index} (int)"]
                                      [negative="{not-condition} (0|1)"] /> ## FilterTest$BodyTest
                        <bulkTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$BulkTest
                        <contactRankingTest header="..." [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$ContactRankingTest
                        <conversationTest [where="..."] [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$ConversationTest
                        <currentDayOfWeekTest [value="..."] [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$CurrentDayOfWeekTest
                        <currentTimeTest [dateComparison="..."] [time="..."] [index="{index} (int)"]
                                             [negative="{not-condition} (0|1)"] /> ## FilterTest$CurrentTimeTest
                        <dateTest [dateComparison="..."] [d="(Long)"] [index="{index} (int)"]
                                      [negative="{not-condition} (0|1)"] /> ## FilterTest$DateTest
                        <facebookTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$FacebookTest
                        <flaggedTest flagName="..." [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$FlaggedTest
                        <headerExistsTest header="..." [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$HeaderExistsTest
                        <headerTest [header="..."] [stringComparison="..."] [valueComparison="..."]
                                        [countComparison="..."] [valueComparisonComparator="..."] [value="..."]
                                        [caseSensitive="(0|1)"] [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$HeaderTest
                        <importanceTest imp="(high|normal|low)" [index="{index} (int)"]
                                            [negative="{not-condition} (0|1)"] /> ## FilterTest$ImportanceTest
                        <inviteTest [index="{index} (int)"] [negative="{not-condition} (0|1)"]> ## FilterTest$InviteTest
                            (<method>{methods} (String)</method>)*
                         </inviteTest>
                        <linkedinTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$LinkedInTest
                        <listTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$ListTest
                        <meTest header="..." [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$MeTest
                        <mimeHeaderTest [header="..."] [stringComparison="..."] [value="..."] [caseSensitive="(0|1)"]
                                            [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$MimeHeaderTest
                        <sizeTest [numberComparison="..."] [s="..."] [index="{index} (int)"]
                                      [negative="{not-condition} (0|1)"] /> ## FilterTest$SizeTest
                        <socialcastTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$SocialcastTest
                        <trueTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$TrueTest
                        <twitterTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$TwitterTest
                        <communityRequestsTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$CommunityRequestsTest
                        <communityContentTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$CommunityContentTest
                        <communityConnectionsTest [index="{index} (int)"] [negative="{not-condition} (0|1)"] /> ## FilterTest$CommunityConnectionsTest
                    }
                </filterTests>
                <filterActions>
                    List of any of: {
                        <filterVariables [index="{index} (int)"]> ... </filterVariables> ## See /filterRules/filterRule/filterVariables [ ## FilterVariables]
                        <actionKeep [index="{index} (int)"] /> ## FilterAction$KeepAction
                        <actionDiscard [index="{index} (int)"] /> ## FilterAction$DiscardAction
                        <actionFileInto [folderPath="..."] [copy="(0|1)"] [index="{index} (int)"] /> ## FilterAction$FileIntoAction
                        <actionFlag [flagName="..."] [index="{index} (int)"] /> ## FilterAction$FlagAction
                        <actionTag tagName="..." [index="{index} (int)"] /> ## FilterAction$TagAction
                        <actionRedirect [a="..."] [copy="(0|1)"] [index="{index} (int)"] /> ## FilterAction$RedirectAction
                        <actionReply [index="{index} (int)"]> ## FilterAction$ReplyAction
                            <content>{content} (String)</content>
                         </actionReply>
                        <actionNotify [a="..."] [su="..."] [maxBodySize="(Integer)"] [origHeaders="..."]
                                          [index="{index} (int)"]> ## FilterAction$NotifyAction
                            <content>{content} (String)</content>
                         </actionNotify>
                        <actionRFCCompliantNotify [from="..."] [importance="..."] [options="..."] [message="..."]
                                                      [index="{index} (int)"]> ## FilterAction$RFCCompliantNotifyAction
                            <method>{method} (String)</method>
                         </actionRFCCompliantNotify>
                        <actionStop [index="{index} (int)"] /> ## FilterAction$StopAction
                        <actionReject [index="{index} (int)"]>{content}</actionReject> ## FilterAction$RejectAction
                        <actionEreject [index="{index} (int)"] /> ## FilterAction$ErejectAction
                        <actionLog [level="(fatal|error|warn|info|debug|trace)"] [index="{index} (int)"]>{content}</actionLog> ## FilterAction$LogAction
                        <actionAddheader [last="(Boolean)"] [index="{index} (int)"]> ## FilterAction$AddheaderAction
                            <headerName>{headerName} (String)</headerName>
                            <headerValue>{headerValue} (String)</headerValue>
                         </actionAddheader>
                        <actionDeleteheader [last="(Boolean)"] [offset="(Integer)"] [index="{index} (int)"]> ## FilterAction$DeleteheaderAction
                            <test [matchType="{matchType}"] [countComparator="{count} (Boolean)"]
                                     [valueComparator="{count} (Boolean)"] [relationalComparator="{relationalComparator}"]
                                     [comparator="{comparator}"]> ## EditheaderTest
                                <headerName>{headerName} (String)</headerName>
                                (<headerValue>{headerValue} (String)</headerValue>)+
                            </test>
                         </actionDeleteheader>
                        <actionReplaceheader [last="(Boolean)"] [offset="(Integer)"] [index="{index} (int)"]> ## FilterAction$ReplaceheaderAction
                            <newName>{newName} (String)</newName>
                            <newValue>{newValue} (String)</newValue>
                            <test ... > ... </test> ## See /filterRules/filterRule/filterActions/actionDeleteheader/test [ ## EditheaderTest]
                         </actionReplaceheader>
                    }
                </filterActions>
                <nestedRule> ## NestedRule
                    <filterVariables [index="{index} (int)"]> ... </filterVariables> ## See /filterRules/filterRule/filterVariables [ ## FilterVariables]
                    <filterTests condition="{condition-allof|anyof}"> ... </filterTests> ## See /filterRules/filterRule/filterTests [ ## FilterTests]
                    <filterActions>
                        List of any of: {
                            <filterVariables [index="{index} (int)"]> ... </filterVariables> ## See /filterRules/filterRule/filterVariables [ ## FilterVariables]
                            <actionKeep [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionKeep [ ## FilterAction$KeepAction]
                            <actionDiscard [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionDiscard [ ## FilterAction$DiscardAction]
                            <actionFileInto ... /> ## See /filterRules/filterRule/filterActions/actionFileInto [ ## FilterAction$FileIntoAction]
                            <actionFlag [flagName="..."] [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionFlag [ ## FilterAction$FlagAction]
                            <actionTag tagName="..." [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionTag [ ## FilterAction$TagAction]
                            <actionRedirect ... /> ## See /filterRules/filterRule/filterActions/actionRedirect [ ## FilterAction$RedirectAction]
                            <actionReply [index="{index} (int)"]> ... </actionReply> ## See /filterRules/filterRule/filterActions/actionReply [ ## FilterAction$ReplyAction]
                            <actionNotify ... > ... </actionNotify> ## See /filterRules/filterRule/filterActions/actionNotify [ ## FilterAction$NotifyAction]
                            <actionRFCCompliantNotify ... > ... </actionRFCCompliantNotify> ## See /filterRules/filterRule/filterActions/actionRFCCompliantNotify [ ## FilterAction$RFCCompliantNotifyAction]
                            <actionStop [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionStop [ ## FilterAction$StopAction]
                            <actionReject [index="{index} (int)"]>{content}</actionReject> ## See /filterRules/filterRule/filterActions/actionReject [ ## FilterAction$RejectAction]
                            <actionEreject [index="{index} (int)"] /> ## See /filterRules/filterRule/filterActions/actionEreject [ ## FilterAction$ErejectAction]
                            <actionLog [level="(fatal|error|warn|info|debug|trace)"] [index="{index} (int)"]>{content}</actionLog> ## See /filterRules/filterRule/filterActions/actionLog [ ## FilterAction$LogAction]
                            <actionAddheader [last="(Boolean)"] [index="{index} (int)"]> ... </actionAddheader> ## See /filterRules/filterRule/filterActions/actionAddheader [ ## FilterAction$AddheaderAction]
                            <actionDeleteheader ... > ... </actionDeleteheader> ## See /filterRules/filterRule/filterActions/actionDeleteheader [ ## FilterAction$DeleteheaderAction]
                            <actionReplaceheader ... > ... </actionReplaceheader> ## See /filterRules/filterRule/filterActions/actionReplaceheader [ ## FilterAction$ReplaceheaderAction]
                        }
                    </filterActions>
                    <nestedRule> ... </nestedRule> ## See /filterRules/filterRule/nestedRule [ ## NestedRule] # [inside itself]
                 </nestedRule>
              </filterRule>)*
        </filterRules>
    </GetFilterRulesResponse>

The following table describes elements and attributes you can define within a <GetFilterRulesResponse> element:

XPath Required / Optional Description
@type Required (only 1) Type:String
Type can be either before or after
/account Optional (0 or 1) Type:{key}
Account
Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/account@by Required (only 1) Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal
Select the meaning of {acct-selector-key}
/domain Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by}
/domain@by Optional (0 or 1) Type:id|name|virtualHostname|krb5Realm|foreignName
Select the meaning of {domain-selector-key}
/cos Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the COS. Meaning determined by {cos-selector-by}
/cos@by Optional (0 or 1) Type:id|name
Select the meaning of {cos-selector-key}
/server Optional (0 or 1) Type:{key}
Domain
Description for element text content:Key for choosing server
{server-by}="id" Use server's zimbraId as the Key
{server-by}="name" Use name of the server as the Key
{server-by}="serviceHostname" Use server's value for attr zimbraServiceHostname as the Key
/server@by Optional (0 or 1) Type:id|name|serviceHostname
Selects the meaning of {server-key}
/filterRules Required (only 1)
/filterRules/filterRule Optional (0 or more)
/filterRules/filterRule@name Required (only 1) Type:String
Rule name
/filterRules/filterRule@active Required (only 1) Type:0|1
Active flag. Set by default.
/filterRules/filterRule/filterVariables Optional (0 or 1) Filter Variables
/filterRules/filterRule/filterVariables@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterVariables/filterVariable Required (1 or more)
/filterRules/filterRule/filterVariables/filterVariable@name Required (only 1) Type:String
Rule name
/filterRules/filterRule/filterVariables/filterVariable@value Required (only 1) Type:String
Value
/filterRules/filterRule/filterTests Required (only 1) Filter tests
/filterRules/filterRule/filterTests@condition Required (only 1) Type:String
Condition - allof|anyof
/filterRules/filterRule/filterTests/addressBookTest Optional (0 or 1)
/filterRules/filterRule/filterTests/addressBookTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/addressBookTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/addressBookTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/addressTest Optional (0 or 1)
/filterRules/filterRule/filterTests/addressTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/addressTest@part Required (only 1) Type:String
/filterRules/filterRule/filterTests/addressTest@stringComparison Required (only 1) Type:String
/filterRules/filterRule/filterTests/addressTest@caseSensitive Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterTests/addressTest@value Required (only 1) Type:String
/filterRules/filterRule/filterTests/addressTest@valueComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/addressTest@countComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/addressTest@valueComparisonComparator Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/addressTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/addressTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/envelopeTest Optional (0 or 1)
/filterRules/filterRule/filterTests/envelopeTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@part Required (only 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@stringComparison Required (only 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@caseSensitive Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterTests/envelopeTest@value Required (only 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@valueComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@countComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@valueComparisonComparator Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/envelopeTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/envelopeTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/attachmentTest Optional (0 or 1)
/filterRules/filterRule/filterTests/attachmentTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/attachmentTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/bodyTest Optional (0 or 1)
/filterRules/filterRule/filterTests/bodyTest@value Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/bodyTest@caseSensitive Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterTests/bodyTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/bodyTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/bulkTest Optional (0 or 1)
/filterRules/filterRule/filterTests/bulkTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/bulkTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/contactRankingTest Optional (0 or 1)
/filterRules/filterRule/filterTests/contactRankingTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/contactRankingTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/contactRankingTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/conversationTest Optional (0 or 1)
/filterRules/filterRule/filterTests/conversationTest@where Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/conversationTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/conversationTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/currentDayOfWeekTest Optional (0 or 1)
/filterRules/filterRule/filterTests/currentDayOfWeekTest@value Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/currentDayOfWeekTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/currentDayOfWeekTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/currentTimeTest Optional (0 or 1)
/filterRules/filterRule/filterTests/currentTimeTest@dateComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/currentTimeTest@time Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/currentTimeTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/currentTimeTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/dateTest Optional (0 or 1)
/filterRules/filterRule/filterTests/dateTest@dateComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/dateTest@d Optional (0 or 1) Type:Long
/filterRules/filterRule/filterTests/dateTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/dateTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/facebookTest Optional (0 or 1)
/filterRules/filterRule/filterTests/facebookTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/facebookTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/flaggedTest Optional (0 or 1)
/filterRules/filterRule/filterTests/flaggedTest@flagName Required (only 1) Type:String
/filterRules/filterRule/filterTests/flaggedTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/flaggedTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/headerExistsTest Optional (0 or 1)
/filterRules/filterRule/filterTests/headerExistsTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/headerExistsTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/headerExistsTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/headerTest Optional (0 or 1)
/filterRules/filterRule/filterTests/headerTest@header Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@stringComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@valueComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@countComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@valueComparisonComparator Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@value Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/headerTest@caseSensitive Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterTests/headerTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/headerTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/importanceTest Optional (0 or 1)
/filterRules/filterRule/filterTests/importanceTest@imp Required (only 1) Type:high|normal|low
/filterRules/filterRule/filterTests/importanceTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/importanceTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/inviteTest Optional (0 or 1)
/filterRules/filterRule/filterTests/inviteTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/inviteTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/inviteTest/method Optional (0 or more) Type:{methods} (String)
/filterRules/filterRule/filterTests/linkedinTest Optional (0 or 1)
/filterRules/filterRule/filterTests/linkedinTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/linkedinTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/listTest Optional (0 or 1)
/filterRules/filterRule/filterTests/listTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/listTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/meTest Optional (0 or 1)
/filterRules/filterRule/filterTests/meTest@header Required (only 1) Type:String
/filterRules/filterRule/filterTests/meTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/meTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/mimeHeaderTest Optional (0 or 1)
/filterRules/filterRule/filterTests/mimeHeaderTest@header Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/mimeHeaderTest@stringComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/mimeHeaderTest@value Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/mimeHeaderTest@caseSensitive Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterTests/mimeHeaderTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/mimeHeaderTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/sizeTest Optional (0 or 1)
/filterRules/filterRule/filterTests/sizeTest@numberComparison Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/sizeTest@s Optional (0 or 1) Type:String
/filterRules/filterRule/filterTests/sizeTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/sizeTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/socialcastTest Optional (0 or 1)
/filterRules/filterRule/filterTests/socialcastTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/socialcastTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/trueTest Optional (0 or 1)
/filterRules/filterRule/filterTests/trueTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/trueTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/twitterTest Optional (0 or 1)
/filterRules/filterRule/filterTests/twitterTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/twitterTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/communityRequestsTest Optional (0 or 1)
/filterRules/filterRule/filterTests/communityRequestsTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/communityRequestsTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/communityContentTest Optional (0 or 1)
/filterRules/filterRule/filterTests/communityContentTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/communityContentTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterTests/communityConnectionsTest Optional (0 or 1)
/filterRules/filterRule/filterTests/communityConnectionsTest@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the test elements
/filterRules/filterRule/filterTests/communityConnectionsTest@negative Optional (0 or 1) Type:0|1
Specifies a "not" condition for the test
/filterRules/filterRule/filterActions Required (only 1)
/filterRules/filterRule/filterActions/filterVariables Optional (0 or 1) See /filterRules/filterRule/filterVariables for more details.
/filterRules/filterRule/filterActions/actionKeep Optional (0 or 1)
/filterRules/filterRule/filterActions/actionKeep@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionDiscard Optional (0 or 1)
/filterRules/filterRule/filterActions/actionDiscard@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionFileInto Optional (0 or 1)
/filterRules/filterRule/filterActions/actionFileInto@folderPath Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionFileInto@copy Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterActions/actionFileInto@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionFlag Optional (0 or 1)
/filterRules/filterRule/filterActions/actionFlag@flagName Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionFlag@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionTag Optional (0 or 1)
/filterRules/filterRule/filterActions/actionTag@tagName Required (only 1) Type:String
/filterRules/filterRule/filterActions/actionTag@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionRedirect Optional (0 or 1)
/filterRules/filterRule/filterActions/actionRedirect@a Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionRedirect@copy Optional (0 or 1) Type:0|1
/filterRules/filterRule/filterActions/actionRedirect@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionReply Optional (0 or 1)
/filterRules/filterRule/filterActions/actionReply@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionReply/content Optional (0 or 1) Type:{content} (String)
/filterRules/filterRule/filterActions/actionNotify Optional (0 or 1)
/filterRules/filterRule/filterActions/actionNotify@a Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionNotify@su Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionNotify@maxBodySize Optional (0 or 1) Type:Integer
/filterRules/filterRule/filterActions/actionNotify@origHeaders Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionNotify@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionNotify/content Optional (0 or 1) Type:{content} (String)
/filterRules/filterRule/filterActions/actionRFCCompliantNotify Optional (0 or 1)
/filterRules/filterRule/filterActions/actionRFCCompliantNotify@from Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionRFCCompliantNotify@importance Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionRFCCompliantNotify@options Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionRFCCompliantNotify@message Optional (0 or 1) Type:String
/filterRules/filterRule/filterActions/actionRFCCompliantNotify@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionRFCCompliantNotify/method Required (only 1) Type:{method} (String)
/filterRules/filterRule/filterActions/actionStop Optional (0 or 1)
/filterRules/filterRule/filterActions/actionStop@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionReject Optional (0 or 1) Type:{content}
/filterRules/filterRule/filterActions/actionReject@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionEreject Optional (0 or 1)
/filterRules/filterRule/filterActions/actionEreject@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionLog Optional (0 or 1) Type:{content}
/filterRules/filterRule/filterActions/actionLog@level Optional (0 or 1) Type:fatal|error|warn|info|debug|trace
/filterRules/filterRule/filterActions/actionLog@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionAddheader Optional (0 or 1)
/filterRules/filterRule/filterActions/actionAddheader@last Optional (0 or 1) Type:Boolean
/filterRules/filterRule/filterActions/actionAddheader@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionAddheader/headerName Required (only 1) Type:{headerName} (String)
/filterRules/filterRule/filterActions/actionAddheader/headerValue Required (only 1) Type:{headerValue} (String)
/filterRules/filterRule/filterActions/actionDeleteheader Optional (0 or 1)
/filterRules/filterRule/filterActions/actionDeleteheader@last Optional (0 or 1) Type:Boolean
/filterRules/filterRule/filterActions/actionDeleteheader@offset Optional (0 or 1) Type:Integer
/filterRules/filterRule/filterActions/actionDeleteheader@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionDeleteheader/test Required (only 1)
/filterRules/filterRule/filterActions/actionDeleteheader/test@matchType Optional (0 or 1) Type:String
matchType - is|contains|matches|count|value
/filterRules/filterRule/filterActions/actionDeleteheader/test@countComparator Optional (0 or 1) Type:Boolean
if true count comparison will be done
/filterRules/filterRule/filterActions/actionDeleteheader/test@valueComparator Optional (0 or 1) Type:Boolean
if true count comparison will be done
/filterRules/filterRule/filterActions/actionDeleteheader/test@relationalComparator Optional (0 or 1) Type:String
relational comparator - gt|ge|lt|le|eq|ne
/filterRules/filterRule/filterActions/actionDeleteheader/test@comparator Optional (0 or 1) Type:String
comparator - i;ascii-casemap|i;ascii-numeric|i;octet
/filterRules/filterRule/filterActions/actionDeleteheader/test/headerName Required (only 1) Type:{headerName} (String)
name of the header to be compared
/filterRules/filterRule/filterActions/actionDeleteheader/test/headerValue Required (1 or more) Type:{headerValue} (String)
value of the header to be compared
/filterRules/filterRule/filterActions/actionReplaceheader Optional (0 or 1)
/filterRules/filterRule/filterActions/actionReplaceheader@last Optional (0 or 1) Type:Boolean
/filterRules/filterRule/filterActions/actionReplaceheader@offset Optional (0 or 1) Type:Integer
/filterRules/filterRule/filterActions/actionReplaceheader@index Optional (0 or 1) Type:int
Index - specifies a guaranteed order for the action elements
/filterRules/filterRule/filterActions/actionReplaceheader/newName Optional (0 or 1) Type:{newName} (String)
/filterRules/filterRule/filterActions/actionReplaceheader/newValue Optional (0 or 1) Type:{newValue} (String)
/filterRules/filterRule/filterActions/actionReplaceheader/test Required (only 1) See /filterRules/filterRule/filterActions/actionDeleteheader/test for more details.
/filterRules/filterRule/nestedRule Optional (0 or 1) Nested Rule
/filterRules/filterRule/nestedRule/filterVariables Optional (0 or 1) Filter Variables
See /filterRules/filterRule/filterVariables for more details.
/filterRules/filterRule/nestedRule/filterTests Required (only 1) Filter tests
See /filterRules/filterRule/filterTests for more details.
/filterRules/filterRule/nestedRule/filterActions Required (only 1)
/filterRules/filterRule/nestedRule/filterActions/filterVariables Optional (0 or 1) See /filterRules/filterRule/filterVariables for more details.
/filterRules/filterRule/nestedRule/filterActions/actionKeep Optional (0 or 1) See /filterRules/filterRule/filterActions/actionKeep for more details.
/filterRules/filterRule/nestedRule/filterActions/actionDiscard Optional (0 or 1) See /filterRules/filterRule/filterActions/actionDiscard for more details.
/filterRules/filterRule/nestedRule/filterActions/actionFileInto Optional (0 or 1) See /filterRules/filterRule/filterActions/actionFileInto for more details.
/filterRules/filterRule/nestedRule/filterActions/actionFlag Optional (0 or 1) See /filterRules/filterRule/filterActions/actionFlag for more details.
/filterRules/filterRule/nestedRule/filterActions/actionTag Optional (0 or 1) See /filterRules/filterRule/filterActions/actionTag for more details.
/filterRules/filterRule/nestedRule/filterActions/actionRedirect Optional (0 or 1) See /filterRules/filterRule/filterActions/actionRedirect for more details.
/filterRules/filterRule/nestedRule/filterActions/actionReply Optional (0 or 1) See /filterRules/filterRule/filterActions/actionReply for more details.
/filterRules/filterRule/nestedRule/filterActions/actionNotify Optional (0 or 1) See /filterRules/filterRule/filterActions/actionNotify for more details.
/filterRules/filterRule/nestedRule/filterActions/actionRFCCompliantNotify Optional (0 or 1) See /filterRules/filterRule/filterActions/actionRFCCompliantNotify for more details.
/filterRules/filterRule/nestedRule/filterActions/actionStop Optional (0 or 1) See /filterRules/filterRule/filterActions/actionStop for more details.
/filterRules/filterRule/nestedRule/filterActions/actionReject Optional (0 or 1) Type:{content}
See /filterRules/filterRule/filterActions/actionReject for more details.
/filterRules/filterRule/nestedRule/filterActions/actionEreject Optional (0 or 1) See /filterRules/filterRule/filterActions/actionEreject for more details.
/filterRules/filterRule/nestedRule/filterActions/actionLog Optional (0 or 1) Type:{content}
See /filterRules/filterRule/filterActions/actionLog for more details.
/filterRules/filterRule/nestedRule/filterActions/actionAddheader Optional (0 or 1) See /filterRules/filterRule/filterActions/actionAddheader for more details.
/filterRules/filterRule/nestedRule/filterActions/actionDeleteheader Optional (0 or 1) See /filterRules/filterRule/filterActions/actionDeleteheader for more details.
/filterRules/filterRule/nestedRule/filterActions/actionReplaceheader Optional (0 or 1) See /filterRules/filterRule/filterActions/actionReplaceheader for more details.
/filterRules/filterRule/nestedRule/nestedRule Optional (0 or 1) NestedRule child
See /filterRules/filterRule/nestedRule for more details.