Skip to main content

EmailConfig

Struct EmailConfig 

Source
pub struct EmailConfig {
    pub provider: String,
    pub from: String,
    pub from_name: String,
    pub reply_to: String,
    pub api_key: String,
    pub api_secret: String,
    pub region: String,
    pub domain: String,
    pub timeout_secs: u64,
    pub smtp: SmtpConfig,
}
Expand description

Outbound email: which provider sends it, and the credentials to do so.

Off by default (provider = "none"): an app that never sends mail carries no configuration and no client. Turning it on is one line plus a key, and every provider is reached through the same send_email call from a function — swapping SendGrid for SES is a config change, not a code change.

Fields§

§provider: String

none (default), smtp, ses, sendgrid, brevo (aka sendinblue), mailjet, mailgun, postmark or resend.

§from: String

Envelope sender, e.g. no-reply@example.com. Required once enabled; a message may override it per-send.

§from_name: String

Display name shown beside from.

§reply_to: String

Default Reply-To. Empty = none.

§api_key: String

The provider’s API key. For ses this is the AWS access key id; for mailjet the public key; for smtp it is unused (see SmtpConfig).

§api_secret: String

The second half of a two-part credential: the AWS secret access key for ses, the private key for mailjet. Unused elsewhere.

§region: String

AWS region for ses, e.g. eu-west-1.

§domain: String

Sending domain for mailgun, e.g. mg.example.com.

§timeout_secs: u64

How long one send may take before it is abandoned.

§smtp: SmtpConfig

Connection details for provider = "smtp".

Implementations§

Source§

impl EmailConfig

Source

pub fn enabled(&self) -> bool

Whether a provider is configured at all. none and the empty string both mean “this app doesn’t send mail”.

Trait Implementations§

Source§

impl Clone for EmailConfig

Source§

fn clone(&self) -> EmailConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmailConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for EmailConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EmailConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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