Struct vsmtp_rule_engine::RuleEngine

pub struct RuleEngine { /* private fields */ }

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.

Implementations

impl RuleEngine

pub fn new(config: &Config, script_path: &Option<PathBuf>) -> Result<Self>

creates a new instance of the rule engine, reading all files in the script_path parameter. if script_path is None, a warning is emitted and a deny-all script is loaded.

Errors

• failed to register script_path as a valid module folder.
• failed to compile or load any script located at script_path.

pub fn from_script(config: &Config, script: &str) -> Result<Self>

create a rule engine instance from a script.

Errors

• failed to compile the script.

pub fn run_when(
    &self,
    rule_state: &mut RuleState,
    smtp_state: &StateSMTP
) -> Status

runs all rules from a stage using the current transaction state.

the server_address parameter is used to distinguish logs from each other, printing the address & port associated with this run session, not the current context. (because the context could have been pulled from the filesystem when receiving delegation results)

Panics

pub fn just_run_when(
    &self,
    state: &StateSMTP,
    config: &Config,
    resolvers: Arc<Resolvers>,
    mail_context: MailContext,
    mail_message: MessageBody
) -> (MailContext, MessageBody, Status, Option<Status>)

Instantiate a RuleState and run it for the only state provided

Return

A tuple with the mail context, body, result status, and skip status.

pub fn new_compiler(config: &Config) -> Engine

create a rhai engine to compile all scripts with vsl’s configuration.

pub fn compile_api(engine: &Engine) -> Result<Module>

compile vsl’s api into a module.

Errors

• Failed to compile the API.
• Failed to create a module from the API.