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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
sender, subject |
||
|
string |
Yes |
Action: addFrom
¶
- Added in Version
4.7.0-339
- Description
Add a “from” e-mail filter.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Action: addSubject
¶
- Added in Version
4.7.0-339
- Description
Add a “subject” e-mail filter.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete e-mail filters.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: filterBehavior
¶
- Added in Version
4.7.0-339
- Description
Set the filtered e-mail behavior.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
drop, spam |
drop |
* 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 (
),
'reply_code' => 205,
)
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',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.