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

filter_type

string

Yes

sender, subject

filter

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

from-filter

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

subj-filter

string

Yes

Action: delete

Added in Version

4.7.0-339

Description

Delete e-mail filters.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

delete_from

struct (string)

No

bob@interworx.com

delete_subjects

struct (string)

No

bitcoin

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

filter_action

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 (
    0 =>
    array (
      'type' => 'from',
      'delete_input' => 'delete_from',
      'filter' => '[email protected]',
    ),
    1 =>
    array (
      'type' => 'subject',
      'delete_input' => 'delete_subjects',
      'filter' => 'bitcoin',
    ),
  ),
  '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

controller

string

Yes

Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: wait

Added in Version

8.1.3-2998

Description

Magic function - used to simulate a long-running process

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.