Enum MailDriver 

pub enum MailDriver {
    Log,
    File,
    Memory,
    Smtp,
}

Which Transport to build.

use rainier_mail::MailDriver;
use rainier_support::Setting;

assert!(!MailDriver::Log.delivers(), "nothing leaves the machine");
assert!(MailDriver::parse("smtp").unwrap().delivers());

Variants

Log

Write the message to the log and deliver nothing.

The default, and the only safe one to have by accident: a misconfigured production deployment fails to send mail rather than sending it to real people from a staging database.

File

Write each message to a .eml file under storage/mail.

Openable in a mail client, so you can check what a template actually renders to. Delivers nothing.

Memory

Keep messages in memory so a test can assert on them.

Never right outside a test — the messages go nowhere and the vector grows until the process ends.

Smtp

A real SMTP server.

Implementations

impl MailDriver

pub fn as_str(&self) -> &'static str

The wire spelling — what appears in .env and in the config tree.

Inherent as well as on the trait, so callers do not have to import Setting to print one.

impl MailDriver

pub fn delivers(&self) -> bool

Whether a message actually leaves the machine.

The check worth making before a seeder or a backfill: everything else here is safe to point a hundred thousand messages at.

pub fn is_inspectable(&self) -> bool

Whether the sent messages can be read back and asserted on.

Trait Implementations

impl AsRef<str> for MailDriver

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MailDriver

fn clone(&self) -> MailDriver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MailDriver

impl Debug for MailDriver

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

Formats the value using the given formatter.

impl Default for MailDriver

fn default() -> MailDriver

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MailDriver

fn deserialize<D>( deserializer: D, ) -> Result<MailDriver, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MailDriver

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

Formats the value using the given formatter.

impl Eq for MailDriver

impl FromStr for MailDriver

type Err = Error

The associated error which can be returned from parsing.

fn from_str(raw: &str) -> Result<MailDriver, <MailDriver as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for MailDriver

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MailDriver

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MailDriver

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Setting for MailDriver

const SETTING: &'static str = "mail driver"

What this setting is called in an error message — "cache driver".

const ALL: &'static [MailDriver]

Every variant, in the order they should be listed to a human.

fn as_str(&self) -> &'static str

The wire spelling — what appears in .env, in the config tree, and in serialised output.

fn parse(raw: &str) -> Result<Self, Error>

Parse a wire spelling.

fn options() -> String

The valid spellings, backtick-quoted and comma-separated.

impl StructuralPartialEq for MailDriver