Struct EmailNotifier 

pub struct EmailNotifier { /* private fields */ }

Struct containing config and a tag. Associated methods are used to send email and to enclose functions in status updates.

Implementations

impl EmailNotifier

pub fn new(tag: impl ToString) -> Self

Constructs a new EmailNotifier. The parameter tag is a descriptive name given to the process that you are monitoring. This tag will be included in the subject line of any sent emails. Configuration is loaded from the default location.

Example

use email_notif::EmailNotifier;
let em = EmailNotifier::new();

pub fn send_update(&self, body: String)

Send an update email about the running process, with the given body text.

pub fn send_success(&self)

Send a message indicating the process has completed successfully.

pub fn send_error(&self)

Send a message indicating the process has resulted in a panic.

pub fn capture<F>(self, f: F)

where F: UnwindSafe + FnOnce(&EmailNotifier),

Run a closure and send an email when the closure completes successfully (EmailNotifier::send_success) or if the process results in a panic, send an error message (EmailNotifier::send_error)

Example

use email_notif::EmailNotifier;
EmailNotifier::new("Test").capture(|em|{
   for i in 0..10 {
     em.send_update(format!("iteration {i} complete."));
   }
});