Standard functions & operators

The following modules lists:

  • All standard functions available for email filtering. (referred by the fn keyword)
  • Operators. (referred by the op keyword)
  • Objects getters. (referred by the get keyword)
  • Objects setters. (referred by the set keyword)

Documentation for each function is written using markdown, and is split between sections:

NameDescription
ArgsArguments to pass to the function.
ReturnWhat result does the function return.
Effective smtp stageStage of the rule engine where this function can be called from.
NoteAdditional comments for the function.
ExamplesvSL examples using the function.
ErrorsErrors that can happen during the execution of the function. WARNING: this means that the function can throw an exception. Exceptions stops the evaluation of the rule engine and return a deny code. To handle exceptions, checkout the try catch statement in Rhai.

Available documentation sections and their purpose