Controller: /siteworx/email/spamprefs¶
- Required Permissions
EMAIL
Action: addAdvanced
¶
- Added in Version
4.7.0-339
- Description
Add advanced spamassassin configuration options.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
domain, email |
domain |
|
|
string |
No |
@~example.com, @~pointer.com |
@~example.com |
|
|
string |
No |
|||
|
string |
Yes |
add_header, all_spam_to, always_trust_envelope_sender, auto_whitelist_db_modules, auto_whitelist_factor, bayes_auto_expire, bayes_auto_learn_threshold_nonspam, bayes_auto_learn_threshold_spam, bayes_expiry_max_db_size, bayes_ignore_from, bayes_ignore_header, bayes_ignore_header header_name, bayes_ignore_to, bayes_journal_max_size, bayes_learn_during_report, bayes_learn_to_journal, bayes_min_ham_num, bayes_min_spam_num, bayes_sql_override_username, bayes_use_chi2_combining, bayes_use_hapaxes, blacklist_from, blacklist_to, clear_headers, clear_report_template, clear_unsafe_report_template, dcc_body_max, dcc_fuz1_max, dcc_fuz2_max, dcc_timeout, def_whitelist_auth, def_whitelist_from_rcvd, describe, dns_available, envelope_sender_header, fold_headers, internal_networks, lock_method, more_spam_to, ok_languages, ok_locales, pyzor_max, pyzor_options, pyzor_timeout, razor_timeout, rbl_timeout, remove_header, report, report_charset, report_contact, … |
||
|
string |
Yes |
* indicates that it’s actually required, but probably already has a valid default value.
Action: deleteAdvanced
¶
- Added in Version
4.7.0-339
- Description
Delete advanced spamassassin configuration options.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit spamassassin configuration settings.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
0 |
Enable SiteWorx level SpamAssassin controls for this domain. |
|
string |
No* |
no |
no |
This section lets you define what happens to spam once it has been tagged by SpamAssassin. The options are: <p>1. Deliver the Spam to an IMAP mailbox named “Spam”, or if that box does not exist, the “Inbox”. <p> 2. Delete Spam scored above a certain threshold, delivering all other Spam to the IMAP mailbox named “Spam”. |
|
integer |
No* |
5, 7, 10 |
5 |
Messages that are scored above this value will be tagged and identified as Spam by SpamAssassin. Messages with scores below this value will not be tagged as Spam. - (required_score) |
|
string |
No* |
no |
no |
You can choose to have SpamAssassin alter the subject line of messages it identifies as spam. This can make messages tagged as spam more readily visible when viewing a list of messages, and can be used to filter messages based on the subject line in some email clients. - (rewrite_header subject) |
|
integer |
No* |
0, 1, 2 |
1 |
In this section, you can set whether and how SpamAssassin alters the messages it tags as Spam. - (report_safe) |
* indicates that it’s actually required, but probably already has a valid default value.
Action: editAdvanced
¶
- Added in Version
4.7.0-339
- Description
Edit advanced spamassassin configuration options.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
test |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: listGlobalPreferences
¶
- Added in Version
4.8.0-393
- Description
Lists information about global spam preferences.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'id' => '1',
'username' => '@GLOBAL',
'preference' => 'add_header',
'value' => 'test',
'type' => 'global',
),
),
'reply_code' => 205,
)
Action: listPreferences
¶
- Added in Version
4.8.0-393
- Description
Lists information about current spam preferences.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'id' => '2',
'username' => '@~example.com',
'preference' => 'add_header',
'value' => 'test',
'type' => 'domain',
),
),
'reply_code' => 205,
)
Action: listSpamPreferenceIds
¶
- Added in Version
4.7.0-339
- Description
List e-mail spam preferences by id.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => '2',
1 => 'add_header',
),
),
'reply_code' => 205,
)
Action: queryEdit
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “edit”.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'enable_spam' => '0',
'dropscore' => 'no',
'spamscore' => '5',
'rewrite_subject' => 'no',
'report_safe' => '1',
),
'reply_code' => 205,
)
Action: queryEditAdvanced
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “editAdvanced”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'preference' => 'add_header',
'value' => 'test',
'pref_id' => '2',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.