Authorization token required | true |
Admin Authorization token required | false |
<ModifyOutgoingFilterRulesRequest> ## ModifyOutgoingFilterRulesRequest
<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>
</ModifyOutgoingFilterRulesRequest>
elements and attributes you can define within a
<ModifyOutgoingFilterRulesRequest>
element:
<ModifyOutgoingFilterRulesResponse /> ## ModifyOutgoingFilterRulesResponse