Skip to main content

SendEmail

Struct SendEmail 

Source
pub struct SendEmail {
    pub template: String,
    pub to: Vec<String>,
    pub cc: Vec<String>,
    pub bcc: Vec<String>,
    pub locale: Option<String>,
    pub vars: HashMap<String, String>,
    pub sender: Option<SenderProfile>,
}
Expand description

Builder for composing an email to send.

Created with SendEmail::new and configured via builder-style methods. Pass the completed value to Mailer::send.

Fields§

§template: String

Template name to render (without locale prefix or .md extension).

§to: Vec<String>

Primary recipients (To header).

§cc: Vec<String>

Carbon-copy recipients (Cc header).

§bcc: Vec<String>

Blind carbon-copy recipients (Bcc header).

§locale: Option<String>

Optional locale override. Falls back to EmailConfig::default_locale.

§vars: HashMap<String, String>

Variables substituted into {{var_name}} placeholders in the template.

§sender: Option<SenderProfile>

Optional sender override. Falls back to EmailConfig defaults.

Implementations§

Source§

impl SendEmail

Source

pub fn new(template: impl Into<String>, to: impl Into<String>) -> Self

Create a new email builder for the given template and first recipient.

Additional recipients can be added with Self::to, Self::cc, and Self::bcc.

Source

pub fn to(self, addr: impl Into<String>) -> Self

Add a To recipient.

Source

pub fn cc(self, addr: impl Into<String>) -> Self

Add a Cc recipient.

Source

pub fn bcc(self, addr: impl Into<String>) -> Self

Add a Bcc recipient.

Source

pub fn locale(self, locale: impl Into<String>) -> Self

Override the locale used to load this template.

Source

pub fn var(self, key: impl Into<String>, value: impl Into<String>) -> Self

Insert or overwrite a template variable.

The value is substituted for every {{key}} occurrence in both frontmatter and body.

Source

pub fn sender(self, profile: SenderProfile) -> Self

Override the sender profile for this email.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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