Struct Mailer

pub struct Mailer {
    pub from_address: String,
    pub smtp_server: String,
    pub smtp_username: String,
    pub smtp_password: String,
    pub actually_send: bool,
    pub templates: Box<dyn EmailTemplates + Sync + Send>,
}

struct used to handle sending emails

Fields

from_address: String

the email address emails should be sent from

set by the SMTP_FROM_ADDRESS environment variable

smtp_server: String

the smtp server to connect to for purposes of sending emails

set by the SMTP_SERVER environment variable

smtp_username: String

username used to log into SMTP_SERVER

set by the SMTP_USERNAME environment variable

smtp_password: String

the password used to log into SMTP_SERVER

set by the SMTP_PASSWORD environment variable

actually_send: bool

whether or not emails should actually be sent when requested

it may be useful to set this to false in some devolopment environments while setting it to true in production

set by the SEND_MAIL environment variable

templates: Box<dyn EmailTemplates + Sync + Send>

Implementations

impl Mailer

pub fn new(templates: Box<dyn EmailTemplates + Sync + Send>) -> Self

pub fn check_environment_variables()

checks that the required environment variables are set

prints messages denoting which, if any, of the required environment variables were not set

Panics

panics if any of the required environment variables aren’t set properly

TODO: it’d be better to return a Result and let the user handle the error

pub fn send(&self, to: &str, subject: &str, text: &str, html: &str)

send an email with the specifified content and subject to the specified user

will only send an email if the SEND_MAIL environment variable was set to true when this mailer was initialized.

Arguments

• to - a string slice that holds the email address of the intended recipient
• subject - subject field of the email
• text - text content of the email
• html - html content of the email

Panics

panis if the to argument is not a valid email address

TODO: wouldn’t it be better to instead require the to argument be some wrapper around a string that is always a valid email address?

Trait Implementations

impl Clone for Mailer

fn clone(&self) -> Mailer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Mailer

fn default() -> Self

Returns the “default value” for a type.