Controller: EmailFilters

API Controller /siteworx/email/filters
Required Permissions ["EMAIL"]
Action Description
add Add an e-mail filter.
addFrom Add a "from" e-mail filter.
addSubject Add a "subject" e-mail filter.
delete Delete e-mail filters.
filterBehavior Set the filtered e-mail behavior.
listFilters Lists information about SW mail filters.

Action: add (Added in version 4.8.0-393)

Add an e-mail filter.

Input Parameters

Name Type Notes Required?
filter_type string
Example Values
sender, subject
 Yes
filter string Yes

Action: addFrom

Add a "from" e-mail filter.

Input Parameters

Name Type Notes Required?
from-filter string Yes

Action: addSubject

Add a "subject" e-mail filter.

Input Parameters

Name Type Notes Required?
subj-filter string Yes

Action: delete

Delete e-mail filters.

Action: filterBehavior

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)

Lists information about SW mail filters.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
  ),
)