User Tools

Site Tools


reference:spamrules_statement_definesetting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

reference:spamrules_statement_definesetting [2018/11/14 10:45] (current)
Line 1: Line 1:
 +======Spam Filter Rules: DefineSetting======
 +^Statement ​ |DefineSetting |
 +^Version ​ |2.1.9+ |
 +^Purpose ​ |Defines a generic setting, the default value and description |
  
 +The **DefineSetting** statement requires a name, default value and description,​ in the format
 +  DefineSetting "<​name>"​ <default value> "<​description>"​
 +
 +Defining settings like this allows the filter script to be customisable by the user without them having to edit the script itself, as the rule settings can be modified via ''​Settings -> Spam Filter -> General -> Script Configuration''​ in VPOP3'​s Administration Settings.
 +
 +Settings can be referred to in the script by using the variable name **${setting_''<​settingname>''​}**.
 +
 +
 +=====Examples=====
 +Defining a setting
 +<​code>​
 +DefineSetting Redirect ""​ "The user to redirect detected spam to (leave blank for none)"
 +</​code>​
 +
 +Entering a setting value into the log file
 +<​code>​
 +#This logs the '​Redirect'​ setting value
 +Log "​${setting_redirect}"​
 +</​code>​
reference/spamrules_statement_definesetting.txt ยท Last modified: 2018/11/14 10:45 (external edit)