Struct Email 

pub struct Email { /* private fields */ }

Available on crate feature email only.

A high-level email interface for sending emails.

This struct wraps a Transport implementation and provides convenient methods for sending single or multiple email messages.

Examples

use cot::common_types::Email;
use cot::email::EmailMessage;
use cot::email::transport::console::Console;

let email = cot::email::Email::new(Console::new());
let message = EmailMessage::builder()
    .from(Email::try_from("no-reply@example.com").unwrap())
    .to(vec![Email::try_from("user@example.com").unwrap()])
    .subject("Greetings")
    .body("Hello from cot!")
    .build()?;
email.send(message).await?;

Implementations

impl Email

pub fn new(transport: impl Transport) -> Self

Create a new email sender using the given transport implementation.

Examples

use cot::email::transport::console::Console;
use cot::email::{Email, EmailMessage};

let email = Email::new(Console::new());

pub async fn send(&self, message: EmailMessage) -> EmailResult<()>

Send a single EmailMessage

Errors

Returns an EmailError::Transport error if sending the email fails.

Examples

use cot::common_types::Email;
use cot::email::EmailMessage;
use cot::email::transport::console::Console;

let email = cot::email::Email::new(Console::new());
let message = EmailMessage::builder()
    .from(Email::try_from("no-reply@example.com").unwrap())
    .to(vec![Email::try_from("user@example.com").unwrap()])
    .subject("Greetings")
    .body("Hello from cot!")
    .build()?;
email.send(message).await?;

pub async fn send_multiple(&self, messages: &[EmailMessage]) -> EmailResult<()>

Send multiple emails in sequence.

Errors

Returns an EmailError::Transport if sending any of the emails fails.

Examples

use cot::common_types::Email;
use cot::email::EmailMessage;
use cot::email::transport::console::Console;

let email = cot::email::Email::new(Console::new());
let message1 = EmailMessage::builder()
    .from(Email::try_from("no-reply@email.com").unwrap())
    .to(vec![Email::try_from("user1@example.com").unwrap()])
    .subject("Hello User 1")
    .body("This is the first email.")
    .build()?;

let message2 = EmailMessage::builder()
    .from(Email::try_from("no-reply@email.com").unwrap())
    .to(vec![Email::try_from("user2@example.com").unwrap()])
    .subject("Hello User 2")
    .body("This is the second email.")
    .build()?;
email.send_multiple(&[message1, message2]).await?;

pub fn from_config(config: &EmailConfig) -> EmailResult<Self>

Construct an Email from the provided EmailConfig.

Errors

Returns an EmailError::Transport error if creating the transport backend fails from the config.

Examples

use cot::config::{EmailConfig, EmailTransportConfig, EmailTransportTypeConfig};
use cot::email::Email;
use cot::email::transport::console::Console;

let config = EmailConfig {
    transport: EmailTransportConfig::builder()
        .transport_type(EmailTransportTypeConfig::Console)
        .build(),
    ..Default::default()
};
let email = Email::from_config(&config);

Trait Implementations

impl Clone for Email

fn clone(&self) -> Email

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Email

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

Formats the value using the given formatter.

impl FromRequestHead for Email

async fn from_request_head(head: &RequestHead) -> Result<Self>

Extracts data from the request head.