Struct ExtensionEmailTemplateBuilder 

pub struct ExtensionEmailTemplateBuilder {
    pub templates: Vec<EmailTemplate>,
    pub variables: Vec<EmailVariable>,
}

Fields

templates: Vec<EmailTemplate>

variables: Vec<EmailVariable>

Implementations

impl ExtensionEmailTemplateBuilder

pub fn add_template(self, template: EmailTemplate) -> Self

Add a new email template to the system, this will not override any existing templates, if you want to override an existing template, use mutate_template instead

pub fn mutate_template( self, identifier: &'static str, mutation: impl FnOnce(&mut EmailTemplate), ) -> Self

Mutate an existing template, useful for changing the default content, should not extend the variables, as the caller will not be aware of the new variables and thus will not be able to use them, if you need to add variables, consider adding a new template instead

pub fn add_template_variable( self, template_identifier: Option<&'static str>, name: &'static str, default_value: &'static str, ) -> Self

Declare a system variable with its English default, available to the given template as {{ vars.<name> }} (or to every template when template_identifier is None). Existing variables are left untouched.

pub fn add_template_variables(self, directory: &Dir<'_>) -> Self

Declare variables and their translations from an embedded directory of <language>.json files, the same layout the panel uses for its own templates: en.json holds { "<template identifier>": { "<name>": "<fragment>" } }, every other file the translations.

pub fn add_template_variable_translation( self, template_identifier: Option<&'static str>, name: &'static str, language: &'static str, value: &'static str, ) -> Self

Ship a translated default for a variable declared with add_template_variable.

pub fn mutate_template_variable( self, template_identifier: Option<&'static str>, name: &'static str, mutation: impl FnOnce(&mut EmailVariable), ) -> Self

Mutate an existing variable, useful for changing the default wording of a core template without replacing its layout.

Trait Implementations

impl Clone for ExtensionEmailTemplateBuilder

fn clone(&self) -> ExtensionEmailTemplateBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ExtensionEmailTemplateBuilder

fn default() -> Self

Returns the “default value” for a type.