Class ZmFilterRule
Class Detail
ZmFilterRule(name, active, filterActions, filterTests)
Creates an empty filter rule. Conditions and actions will need to be added.
Author: Conrad Damon.
Field Detail
<static>
ZmFilterRule.A_DISCARD
Defines the "discard" action type.
<static>
ZmFilterRule.A_FLAG
Defines the "flag" action type.
<static>
ZmFilterRule.A_FOLDER
Defines the "folder" action type.
<static>
ZmFilterRule.A_FORWARD
Defines the "forward" action type.
<static>
ZmFilterRule.A_KEEP
Defines the "keep" action type.
<static>
ZmFilterRule.A_KEEP_SENT
Defines the "keep" action type.
<static>
ZmFilterRule.A_NAME_DISCARD
Defines the "discard" action name.
<static>
ZmFilterRule.A_NAME_FLAG
Defines the "flag" action name.
<static>
ZmFilterRule.A_NAME_FOLDER
Defines the "file into a folder" action name.
<static>
ZmFilterRule.A_NAME_FORWARD
Defines the "forward" action name.
<static>
ZmFilterRule.A_NAME_KEEP
Defines the "keep" action name.
<static>
ZmFilterRule.A_NAME_KEEP_SENT
Defines the "keep" action name.
<static>
ZmFilterRule.A_NAME_STOP
Defines the "stop" action name.
<static>
ZmFilterRule.A_NAME_TAG
Defines the "tag" action name.
<static>
ZmFilterRule.A_NOTIFY
Defines the "notify" action name.
<static>
ZmFilterRule.A_REPLY
Defines the "reply" action name.
<static>
ZmFilterRule.A_STOP
Defines the "stop" action type.
<static>
ZmFilterRule.A_TAG
Defines the "tag" action type.
<static>
ZmFilterRule.ACTIONS
This defines a hash of actions. The hash key is known as the action "name".
It may or may not take an argument.
The action parameters are:
{Object}
actions
The filter rule actions.
{Object}
conditions
The filter rules conditions.
<static>
ZmFilterRule.CONDITIONS
This defines a hash of conditions. Each condition is a hash of parameters. The key of the hash
is also known as the condition "subject". It is the field of an email message that
the condition is tested against.
The condition parameters are:
<static>
ZmFilterRule.GROUP_ALL
Defines the "group all" operator.
<static>
ZmFilterRule.GROUP_ANY
Defines the "group any" operator.
{String}
name
The name of the filter rule.
<static>
ZmFilterRule.TYPE_CALENDAR
Defines the "calendar" type.
<static>
ZmFilterRule.TYPE_FOLDER_PICKER
Defines the "folder picker" type.
<static>
ZmFilterRule.TYPE_INPUT
Defines the "input" type.
<static>
ZmFilterRule.TYPE_SELECT
Defines the "select" type.
<static>
ZmFilterRule.TYPE_TAG_PICKER
Defines the "tag picker" type.
Method Detail
addAction(actionType, value)
Adds an action to the rule actions list.
clearActions()
Clears the rule actions list.
clearConditions()
Clears the rule conditions list.
{constant}
getGroupOp()
Gets the rule condition grouping operator.
<static>
{constant}
ZmFilterRule.getNegativeComparator(comparator)
helper method to get the negative comparator
<static>
{array}
ZmFilterRule.getSocialFilters()
Returns array of social filter options based on COS settings
{Boolean}
hasValidAction()
Checks if the if the rule is enabled.
setGroupOp(groupOp)
Sets the rule condition grouping operator to "any" or "all".
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:36 GMT-0400 (EDT)
|