Struct Envelope

pub struct Envelope { /* private fields */ }

Simple email envelope representation

We only accept mailboxes, and do not support source routes (as per RFC).

Implementations

impl Envelope

pub fn new(from: Option<Address>, to: Vec<Address>) -> Result<Envelope, Error>

Creates a new envelope, which may fail if to is empty.

Examples

let sender = "sender@email.com".parse::<Address>()?;
let recipients = vec!["to@email.com".parse::<Address>()?];

let envelope = Envelope::new(Some(sender), recipients);

Errors

If to has no elements in it.

pub fn to(&self) -> &[Address]

Gets the destination addresses of the envelope.

Examples

let sender = "from@email.com".parse::<Address>()?;
let recipients = vec!["to@email.com".parse::<Address>()?];

let envelope = Envelope::new(Some(sender), recipients.clone())?;
assert_eq!(envelope.to(), recipients.as_slice());

pub fn from(&self) -> Option<&Address>

Gets the sender of the envelope.

Examples

let sender = "from@email.com".parse::<Address>()?;
let recipients = vec!["to@email.com".parse::<Address>()?];

let envelope = Envelope::new(Some(sender), recipients.clone())?;
assert!(envelope.from().is_some());

let senderless = Envelope::new(None, recipients.clone())?;
assert!(senderless.from().is_none());

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl PartialEq for Envelope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Headers> for Envelope

type Error = Error

The type returned in the event of a conversion error.

fn try_from(headers: &Headers) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Envelope

impl StructuralPartialEq for Envelope