Struct MailConfig 

pub struct MailConfig {
    pub host: String,
    pub port: u16,
    pub username: Option<String>,
    pub password: Option<String>,
    pub from: String,
    pub from_name: Option<String>,
    pub tls: bool,
}

SMTP mail configuration.

Fields

host: String

SMTP host.

port: u16

SMTP port.

username: Option<String>

SMTP username.

password: Option<String>

SMTP password.

from: String

Default from address.

from_name: Option<String>

Default from name.

tls: bool

Use TLS.

Implementations

impl MailConfig

pub fn new(host: impl Into<String>, port: u16, from: impl Into<String>) -> Self

Create a new mail config.

pub fn from_env() -> Option<Self>

Create mail configuration from environment variables.

Returns None if MAIL_HOST is not set.

Reads the following environment variables:

• MAIL_HOST: SMTP server host (required)
• MAIL_PORT: SMTP server port (default: 587)
• MAIL_USERNAME: SMTP username (optional)
• MAIL_PASSWORD: SMTP password (optional)
• MAIL_FROM_ADDRESS: Default from email address (required)
• MAIL_FROM_NAME: Default from name (optional)
• MAIL_ENCRYPTION: “tls” or “none” (default: “tls”)

Example

use ferro_notifications::MailConfig;

if let Some(config) = MailConfig::from_env() {
    // Mail is configured
}

pub fn credentials( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Set SMTP credentials.

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

Set the from name.

pub fn no_tls(self) -> Self

Disable TLS.

Trait Implementations

impl Clone for MailConfig

fn clone(&self) -> MailConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.