Rule sets

This command associates a <rulescript> with a <name> for later usage by ::fmail::process

Return value is the entered <name>.

::fmail::def spamblock {
    on {![input hasHeader to]} do junkit
    on {
	[input unwantedSender] ||
	!([input localSender] ||
	  [input localTarget])
    } do junkit
}
	    

This command executes a named set of <rules> for an <object>.

The argument <via> is actually without any meaning. Its only purpose is to allow syntactic sugar while using the command. Its contents are ignored.

The <object> is specified through the name of its object command. See input below too.

The rule script is executed in a separate interpreter and has no direct access to the outside world except through the language elements defined below and the methods of the <object>.

::fmail::process mail via spamblock
	    

This command is an alias of the <object> given as argument to ::fmail::process.

This command additionally provides all defined Predicates as methods of the object. Predicates take precedence over normal methods, i.e. a predicate with the same name as a real method of the object shadows that method.

input getHeader from
input hasHeader to
	    

This commands allows the definition of Actions from the inside of a rule script.

See ::fmail::action for a full explanation of the syntax.

This command allows the execution of a named <ruleset> from within another rule script.

See ::fmail::process too.

<args> must be either empty or contain two arguments. The first of these is a dummy serving as syntactic sugar, the second is the command of the object to use while executing the other rule script.

In case of an empty <args> the called rule script will use the object of the calling rulescript.

process rules
process rules for anotherObject
	    

The first command for building rules.

Evaluates the <condition> as an expression, then executes the named <action> if the result was 'true'. The additional <args> are given to the <action> as its first arguments.

The <condition> usually contains calls to the Predicates defined for the input object.

on {[input hasHeader to]} ...
	    

Equivalent to 'on 0'. Never executes its action.

never vacation
	    

Equivalent to 'on 1'. Always executes its action. The additional <args> are given to the <action> as its first arguments.

always process spamblock
	    

Equivalent to always, but implictly executes stop after the action.

Because of this it should be the last rule in a script, as no other rule will be executed after it.

In case of nested rule scripts its usage should be restricted to the toplevel ruleset too.

default store2mh-folder inbox
	    

Adds the <text> to the log maintained by the rule engine.

Useful for debugging complex rule sets.