Struct EmailConfig 

pub struct EmailConfig {
    pub transport: EmailTransportConfig,
}

Available on crate feature email only.

Configuration for the email system.

This specifies all the configuration options for sending emails.

Examples

use cot::config::{EmailConfig, EmailTransportConfig, EmailTransportTypeConfig};

let config = EmailConfig::builder()
    .transport(
        EmailTransportConfig::builder()
            .transport_type(EmailTransportTypeConfig::Console)
            .build(),
    )
    .build();
assert_eq!(
    config.transport.transport_type,
    EmailTransportTypeConfig::Console
);

Fields

transport: EmailTransportConfig

The type of email transport backend to use.

This determines which type of email transport backend to use (console or smtp) along with its configuration options.

Examples

use cot::config::{EmailConfig, EmailTransportConfig, EmailTransportTypeConfig};

let config = EmailConfig::builder()
    .transport(
        EmailTransportConfig::builder()
            .transport_type(EmailTransportTypeConfig::Console)
            .build(),
    )
    .build();
assert_eq!(
    config.transport.transport_type,
    EmailTransportTypeConfig::Console
);

TOML Configuration

[email.transport]
type = "console"

# Or for SMTP:
# [email.transport]
# type = "smtp"
# auth_id = "your_auth_id"
# secret = "your_secret"
# mechanism = "plain" # or "login", "xoauth2"
# server = "smtp.gmail.com" # or "localhost"

Implementations

impl EmailConfig

pub fn builder() -> EmailConfigBuilder

Create a new EmailConfigBuilder to build an EmailConfig.

Examples

use cot::config::EmailConfig;

let config = EmailConfig::builder().build();

Trait Implementations

impl Clone for EmailConfig

fn clone(&self) -> EmailConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmailConfig

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

Formats the value using the given formatter.

impl Default for EmailConfig

fn default() -> Self

Returns the “default value” for a type.

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

where EmailConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EmailConfig

impl PartialEq for EmailConfig

fn eq(&self, other: &EmailConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for EmailConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EmailConfig