Struct Mailboxes

pub struct Mailboxes(/* private fields */);

Represents a sequence of Mailbox instances.

This type contains a sequence of mailboxes (Some Name <user@domain.tld>, Another Name <other@domain.tld>, withoutname@domain.tld, …).

NOTE: Enable feature “serde” to be able serialize/deserialize it using serde.

Implementations

impl Mailboxes

pub fn new() -> Self

Creates a new list of Mailbox instances.

Examples

use lettre::message::Mailboxes;
let mailboxes = Mailboxes::new();

pub fn with(self, mbox: Mailbox) -> Self

Adds a new Mailbox to the list, in a builder style pattern.

Examples

use lettre::{
    message::{Mailbox, Mailboxes},
    Address,
};

let address = Address::new("example", "email.com")?;
let mut mailboxes = Mailboxes::new().with(Mailbox::new(None, address));

pub fn push(&mut self, mbox: Mailbox)

Adds a new Mailbox to the list, in a Vec::push style pattern.

Examples

use lettre::{
    message::{Mailbox, Mailboxes},
    Address,
};

let address = Address::new("example", "email.com")?;
let mut mailboxes = Mailboxes::new();
mailboxes.push(Mailbox::new(None, address));

pub fn into_single(self) -> Option<Mailbox>

Extracts the first Mailbox if it exists.

Examples

use lettre::{
    message::{Mailbox, Mailboxes},
    Address,
};

let empty = Mailboxes::new();
assert!(empty.into_single().is_none());

let mut mailboxes = Mailboxes::new();
let address = Address::new("example", "email.com")?;

mailboxes.push(Mailbox::new(None, address));
assert!(mailboxes.into_single().is_some());

pub fn iter(&self) -> Iter<'_, Mailbox>

Creates an iterator over the Mailbox instances that are currently stored.

Examples

use lettre::{
    message::{Mailbox, Mailboxes},
    Address,
};

let mut mailboxes = Mailboxes::new();

let address = Address::new("example", "email.com")?;
mailboxes.push(Mailbox::new(None, address));

let address = Address::new("example", "email.com")?;
mailboxes.push(Mailbox::new(None, address));

let mut iter = mailboxes.iter();

assert!(iter.next().is_some());
assert!(iter.next().is_some());

assert!(iter.next().is_none());

Trait Implementations

impl Clone for Mailboxes

fn clone(&self) -> Mailboxes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mailboxes

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

Formats the value using the given formatter.

impl Default for Mailboxes

fn default() -> Self

Returns the “default value” for a type.

impl Display for Mailboxes

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

Formats the value using the given formatter.

impl Extend<Mailbox> for Mailboxes

fn extend<T: IntoIterator<Item = Mailbox>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Bcc> for Mailboxes

fn from(this: Bcc) -> Mailboxes

Converts to this type from the input type.

impl From<Cc> for Mailboxes

fn from(this: Cc) -> Mailboxes

Converts to this type from the input type.

impl From<From> for Mailboxes

fn from(this: From) -> Mailboxes

Converts to this type from the input type.

impl From<Mailbox> for Mailboxes

fn from(mailbox: Mailbox) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for Bcc

fn from(mailboxes: Mailboxes) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for Cc

fn from(mailboxes: Mailboxes) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for From

fn from(mailboxes: Mailboxes) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for Option<Mailbox>

fn from(mailboxes: Mailboxes) -> Option<Mailbox>

Converts to this type from the input type.

impl From<Mailboxes> for ReplyTo

fn from(mailboxes: Mailboxes) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for To

fn from(mailboxes: Mailboxes) -> Self

Converts to this type from the input type.

impl From<Mailboxes> for Vec<Mailbox>

fn from(mailboxes: Mailboxes) -> Vec<Mailbox>

Converts to this type from the input type.

impl From<ReplyTo> for Mailboxes

fn from(this: ReplyTo) -> Mailboxes

Converts to this type from the input type.

impl From<To> for Mailboxes

fn from(this: To) -> Mailboxes

Converts to this type from the input type.

impl From<Vec<Mailbox>> for Mailboxes

fn from(vec: Vec<Mailbox>) -> Self

Converts to this type from the input type.

impl FromIterator<Mailbox> for Mailboxes

fn from_iter<T: IntoIterator<Item = Mailbox>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Mailboxes

type Err = AddressError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

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

impl Hash for Mailboxes

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

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 IntoIterator for Mailboxes

type Item = Mailbox

The type of the elements being iterated over.

type IntoIter = IntoIter<Mailbox>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Mailboxes

fn cmp(&self, other: &Mailboxes) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Mailboxes

fn eq(&self, other: &Mailboxes) -> 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 PartialOrd for Mailboxes

fn partial_cmp(&self, other: &Mailboxes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Mailboxes

impl StructuralPartialEq for Mailboxes