Skip to main content

Mailer

Struct Mailer 

Source
pub struct Mailer { /* private fields */ }
Expand description

The primary entry point for sending transactional email.

Mailer loads Markdown templates, performs variable substitution, renders HTML and plain-text bodies, applies a layout, and delivers the resulting message over SMTP.

Cloning is cheap (Arc-based) and shares the SMTP connection, template source, and preloaded layouts.

§Construction

Implementations§

Source§

impl Mailer

Source

pub fn new(config: &EmailConfig) -> Result<Self>

Create a new Mailer with the default FileSource.

If config.cache_templates is true, the file source is wrapped in a CachedSource with config.template_cache_size capacity.

§Errors

Returns an error if the SMTP transport cannot be built (e.g., invalid host, mismatched credentials) or if the layouts directory cannot be read.

Source

pub fn with_source( config: &EmailConfig, source: Arc<dyn TemplateSource>, ) -> Result<Self>

Create a new Mailer with a custom TemplateSource.

Use this to supply an in-memory source, a database-backed source, or any other custom implementation.

§Errors

Returns an error if the SMTP transport cannot be built or if the layouts directory cannot be read.

Source

pub fn render(&self, email: &SendEmail) -> Result<RenderedEmail>

Render a template without sending.

Performs variable substitution, parses the YAML frontmatter, converts the Markdown body to HTML (with button syntax support), applies the layout, and generates the plain-text fallback.

Returns a RenderedEmail containing the subject, HTML, and text.

§Errors

Returns an error if the template cannot be loaded, the frontmatter is missing or malformed, or the requested layout is not found.

Source

pub async fn send(&self, email: SendEmail) -> Result<()>

Render and send an email via SMTP.

Calls Self::render internally, then builds a multipart/alternative MIME message (text/plain + text/html) and delivers it over the configured transport.

§Errors

Returns an error if the recipient list is empty, if any address is malformed, if the template cannot be rendered, or if the SMTP delivery fails.

Trait Implementations§

Source§

impl Clone for Mailer

Source§

fn clone(&self) -> Mailer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more