Struct MailConfig 

#[non_exhaustive]
pub struct MailConfig {
    pub mailer: MailDriver,
    pub host: String,
    pub port: Option<u16>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub encryption: MailEncryption,
    pub from_address: String,
    pub from_name: Option<String>,
    pub timeout: Duration,
    pub failover: Vec<String>,
}

Mail settings, from MAIL_*.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mailer: MailDriver

How mail is sent: SMTP, the log or memory.

host: String

SMTP server, from MAIL_HOST (default localhost).

port: Option<u16>

SMTP port, from MAIL_PORT; None uses the encryption’s usual port.

username: Option<String>

SMTP user name, from MAIL_USERNAME.

password: Option<String>

SMTP password, from MAIL_PASSWORD.

encryption: MailEncryption

tls (usually port 465), starttls (587) or none (e.g. Mailpit on 1025).

from_address: String

Sender address, from MAIL_FROM_ADDRESS (default hello@example.com).

from_name: Option<String>

Sender name, from MAIL_FROM_NAME.

timeout: Duration

How long sending one mail over SMTP may take, from MAIL_TIMEOUT in seconds (default 10).

failover: Vec<String>

Mailers (App::mailer names) to try in order when this one fails, from MAIL_FAILOVER (comma-separated), e.g. backup for a second SMTP provider.

Implementations

impl MailConfig

pub fn from_env(config: &Config, prefix: &str) -> Result<Self>

A mailer’s settings from variables starting with prefix, for App::mailer: <PREFIX>_MAILER (smtp, log or memory; default: the app’s MAIL_MAILER, so it logs while developing and keeps mail in memory in tests), <PREFIX>_HOST, _PORT, _USERNAME, _PASSWORD, _ENCRYPTION, _TIMEOUT (seconds), and <PREFIX>_FROM_ADDRESS / _FROM_NAME, which fall back to the app’s MAIL_FROM_*. A value that doesn’t fit (an unknown driver, a port that isn’t a number) is an error naming the variable, and the app doesn’t boot.

Trait Implementations

impl Clone for MailConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MailConfig

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

Formats the value using the given formatter.

impl Default for MailConfig

fn default() -> Self

Returns the “default value” for a type.