Chapter 72: Controller: /siteworx/email/domainkeys Up Part III: SiteWorx API Spec Chapter 74: Controller: /siteworx/email/group 

73 Controller: /siteworx/email/filters

Required Permissions "EMAIL"
Action: add
Added in version 4.7.0-339
Description Add an e-mail filter.
Input Parameters
Name Type Notes Required?
filter_type string Example Values
sender, subject
Yes
filter string Yes
Action: addFrom
Added in version 4.7.0-339
Description Add a "from" e-mail filter.
Input Parameters
Name Type Notes Required?
from-filter string Yes
Action: addSubject
Added in version 4.7.0-339
Description Add a "subject" e-mail filter.
Input Parameters
Name Type Notes Required?
subj-filter string Yes
Action: delete
Added in version 4.7.0-339
Description Delete e-mail filters.
Action: filterBehavior
Added in version 4.7.0-339
Description Set the filtered e-mail behavior.
Input Parameters
Name Type Notes Required?
filter_action string Example Values
drop, spam
Example Default Value
drop
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listFilters
Added in version 4.8.0-393
Description Lists information about SW mail filters.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: queryFilterBehavior
Added in version 5.1.0-838
Description Displays the information available to the action "filterBehavior".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’filter_action’ => ’drop’,
),
)
 Chapter 72: Controller: /siteworx/email/domainkeys Up Part III: SiteWorx API Spec Chapter 74: Controller: /siteworx/email/group 

(C) 2017 by InterWorx LLC