Crate vsmtp_rule_engine

vSMTP rule engine

vSMTP server is built with a runtime also called rule engine. This runtime can execute code provided in our superset of the https://rhai.rs language.

The viridIT scripting language (vsl) is a simple language that allow you to define rules and object to control the traffic on your MTA.

Further details on the official book of vSMTP: https://vsmtp.rs/reference/vSL/vsl.html

Modules

api

Module containing the backend for the vsl’s Rust API.

sub_domain_hierarchy

Build sub domain hierarchy configurations.

Macros

get_global

Fetch rule engine global variables by calling the rhai system functions.

vsl_bail

A bail macro for rhai context similar to anyhow::bail macro.

vsl_err

An error formatting macro for rhai context similar to the anyhow::anyhow macro.

vsl_generic_ok

Transforms a generic error into the rhai boxed eval alt result.

vsl_guard_ok

checks if the mutex is poisoned & return a rhai runtime error if it is.

vsl_ok

Transforms a generic error in a result into the rhai boxed eval alt result.

Structs

RuleEngine

a sharable rhai engine. contains an ast representation of the user’s parsed .vsl script files, and modules / packages to create a cheap rhai runtime.

RuleState

a state container that bridges rhai’s & rust contexts.

Enums

Directive

ExecutionStage

State of vsl rules execution

Functions

new_module_cmd

Create a new command module.

new_module_smtp

Create a new smtp module.