Controller: /nodeworx/mail/spam =============================== :Required Permissions: EMAIL Action: ``addAdvanced`` ----------------------- :Added in Version: 4.7.0-339 :Description: Displays the add advanced form. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``preference`` - 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_use_chi2_combining, bayes_use_hapaxes, 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, report_hostname, report_safe_copy_headers, ... - - * - ``value`` - string - Yes - - - Action: ``autoRestart`` ----------------------- :Added in Version: 4.7.0-339 :Description: Set the spamassassin auto-restart status. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``spam_autorestart`` - integer - No* - 1, 0 - 0 - * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually \* 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. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``pref_id`` - struct (integer) - Yes - - - Action: ``editAdvanced`` ------------------------ :Added in Version: 4.7.0-339 :Description: Edit advanced spamassassin configuration. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``pref_id`` - integer - Yes - - - * - ``value`` - string - No* - - test - \* indicates that it's actually required, but probably already has a valid default value. Action: ``fail`` ---------------- :Added in Version: 4.7.0-339 :Description: Magic function - test for failure mechanism. Action: ``isRunning`` --------------------- :Added in Version: 4.7.0-339 :Description: Checks if the service is running or not. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => true, 'reply_code' => 205, ) Action: ``isRunningOnNode`` --------------------------- :Added in Version: 4.7.0-339 :Description: Checks if the service is running on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``listGeneralName`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the "normal" name - ie "web server" instead of "httpd". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => '##LG_SPAM_FILTERING##', 'reply_code' => 205, ) Action: ``listPortNumbers`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists a string of the port numbers that this service uses, comma-seperated. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => '783', 'reply_code' => 205, ) Action: ``listPortNumbersArray`` -------------------------------- :Added in Version: 4.7.0-339 :Description: Lists array of port numbers and ranges that this service uses. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => 783, ), 'reply_code' => 205, ) Action: ``listPreferences`` --------------------------- :Added in Version: 4.8.0-393 :Description: Lists information about current spam preferences. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'username' => '@GLOBAL', 'preference' => 'add_header', 'value' => 'test', 'is_invalid_nw' => false, 'is_invalid_sw' => false, 'pref_id' => '1', ), ), 'reply_code' => 205, ) Action: ``listRequiredPermissions`` ----------------------------------- :Added in Version: 4.7.0-339 :Description: Lists an array of permissions required to control the service. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => 'EMAIL', ), 'reply_code' => 205, ) Action: ``listServiceInfo`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the service name, ports, page, and status. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'id' => 'spamassassin', 'name' => '##LG_SPAM_FILTERING##', 'ports' => '783', 'page' => '/nodeworx/mail/spam', 'ctrl' => '/nodeworx/mail/spam', 'is_running' => 1, ), 'reply_code' => 205, ) Action: ``listServiceName`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the service name - ie "httpd" instead of "web server". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => 'spamassassin', 'reply_code' => 205, ) Action: ``listServicePage`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the page that controls the service. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => '/nodeworx/mail/spam', 'reply_code' => 205, ) Action: ``queryAutoRestart`` ---------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "autoRestart". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'spam_autorestart' => '0', ), 'reply_code' => 205, ) Action: ``queryEditAdvanced`` ----------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editAdvanced". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``pref_id`` - integer - Yes - - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'preference' => 'add_header', 'value' => 'test', 'pref_id' => '1', ), 'reply_code' => 205, ) Action: ``queryUpdateBayes`` ---------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "updateBayes". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'bayes_scanning' => '1', 'bayes_auto_learn' => '1', 'bayes_imap_training' => '1', 'bayes_imap_training_limit' => '250', 'global_bayes_database' => '0', ), 'reply_code' => 205, ) Action: ``queryUpdateLists`` ---------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "updateLists". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'global_whitelist' => array ( ), 'global_blacklist' => array ( ), 'trusted_networks' => array ( ), ), 'reply_code' => 205, ) Action: ``queryUpdateOptions`` ------------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "updateOptions". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'smtp_level_scanning' => '0', 'smtp_level_spam_score' => '95', 'spam_max_filesize' => '262144', 'rewrite_header_subject' => '', 'report_safe' => '1', 'use_auto_whitelist' => '1', ), 'reply_code' => 205, ) Action: ``reroute`` ------------------- :Added in Version: 4.7.0-339 :Description: Action to re-route from the current controller to a different one. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``controller`` - string - Yes - Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, ... - - Action: ``restart`` ------------------- :Added in Version: 4.7.0-339 :Description: Restart the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually Action: ``restartOnNode`` ------------------------- :Added in Version: 4.7.0-339 :Description: Restarts the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``start`` ----------------- :Added in Version: 4.7.0-339 :Description: Start the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually Action: ``startonboot`` ----------------------- :Added in Version: 4.7.0-339 :Description: Set the spamassassin start-on-boot status. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``startonboot`` - integer - No* - 1, 0 - 1 - * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually \* indicates that it's actually required, but probably already has a valid default value. Action: ``startOnNode`` ----------------------- :Added in Version: 4.7.0-339 :Description: Starts the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``stop`` ---------------- :Added in Version: 4.7.0-339 :Description: Stop the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually Action: ``stopOnNode`` ---------------------- :Added in Version: 4.7.0-339 :Description: Stops the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``updateBayes`` ----------------------- :Added in Version: 4.7.0-339 :Description: Update spamassassin bayes configuration. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``bayes_scanning`` - integer - No* - 1, 0 - 1 - Use the dropdown to enable or disable Bayes scanning. Given training, Bayes will learn which emails are most likely spam and most likely ham (not spam) and deal with these emails according to your preferences. * - ``bayes_auto_learn`` - integer - No* - 1, 0 - 1 - Use the dropdown to enable or disable Bayes auto learning. If enabled, the system will automatically train the Bayes database by analyzing messages that have a score that strongly suggests that they are spam or non-spam. * - ``bayes_imap_training`` - integer - No* - 1, 0 - 1 - Use the dropdown to enable or disable IMAP training. With Bayes IMAP training enabled, there will be two folders created for all email accounts on the system: "Learn Spam" and "Learn Ham". You can then put SPAM emails in the "Learn Spam" folder and non-spam in the "Learn Ham" folder. This will train the Bayes system on which emails are Spam and which are Ham (not Spam). The training occurs once daily, after which the folders' contents are purged. * - ``bayes_imap_training_limit`` - integer - No* - - 250 - The maximum number of emails that will be trained from each of the IMAP Training Folders, "Learn Spam" and "Learn Ham," each day. - *Per Day* * - ``global_bayes_database`` - integer - No* - 1, 0 - 0 - Use the dropdown to enable or disable the Bayes global database. If enabled, all the Bayes data will be stored as a single global user. If disabled, each email box user will have their own Bayes database to store Bayesian data. "Disabled" is considered more effective for fighting Spam, but requires all email users to train their messages individually, and uses more disk space, compared to the global database option. \* indicates that it's actually required, but probably already has a valid default value. Action: ``updateLists`` ----------------------- :Added in Version: 4.7.0-339 :Description: Update spamassassin global white and black lists. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``global_whitelist`` - struct (string) - No - - - Use the whitelist text field to enter email addresses or domains that are valid to send email from on a server-wide level. * - ``global_blacklist`` - struct (string) - No - - - Use the blacklist text field to enter email addresses or domains that are not valid to send email from on a server-wide level. To block all emails from a domain, use '\*', as in '\*@domain.com'. * - ``trusted_networks`` - struct (string) - No - - - Relay hosts added here are considered to not be potentially operated by spammers, open relays, or open proxies. Action: ``updateOptions`` ------------------------- :Added in Version: 4.7.0-339 :Description: Update spamassassin options. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``smtp_level_scanning`` - integer - No* - 1, 0 - 0 - This option will scan all email using the SpamAssassin content filter as the email enters the server. The SMTP connection will be dropped only if the Spam Score is higher than the SMTP Spam Score option below. Otherwise, the email will still be delivered to the recipient.

WARNING: You may not want to enable this setting. It has no bearing on the SpamAssassin setting in SiteWorx, so email messages may be scanned twice if this setting is enabled. * - ``smtp_level_spam_score`` - double - No* - - 95 - SMTP Spam Score. This is the SpamAssassin score threshold at which the SMTP server will reject a message before local delivery begins. If you do not want to block any spam at the SMTP level, use a very high number. * - ``spam_max_filesize`` - double - No* - - 262144 - Set the maximum message size to be scanned -- any bigger than this threshold and the message will be returned unprocessed. * - ``rewrite_header_subject`` - string - No - - - Emails marked as Spam will have the email subject rewritten with what is entered here. * - ``report_safe`` - integer - No* - 0, 1, 2 - 1 - This option sets the method of delivering the actual email spam message. The email can be sent unchanged but with the subject rewritten, it can be attached to an email from SpamAssassin, or it can be attached as plain text to an email from SpamAssassin. * - ``use_auto_whitelist`` - integer - No* - 1, 0 - 1 - Enable or disable the SpamAssassin AutoWhitelist functionality. * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually \* indicates that it's actually required, but probably already has a valid default value. Action: ``win`` --------------- :Added in Version: 4.7.0-339 :Description: Magic function - test for testing success mechanism.