Struct Mailbox

pub struct Mailbox {
    pub name: Option<String>,
    pub email: Address,
}

Represents an email address with an optional name for the sender/recipient.

This type contains email address and the sender/recipient name (Some Name <user@domain.tld> or withoutname@domain.tld).

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

Examples

You can create a Mailbox from a string and an Address:

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

You can also create one from a string literal:

let mailbox: Mailbox = "John Smith <example@email.com>".parse()?;

Fields

name: Option<String>

The name associated with the address.

email: Address

The email address itself.

Implementations

impl Mailbox

pub fn new(name: Option<String>, email: Address) -> Self

Creates a new Mailbox using an email address and the name of the recipient if there is one.

Examples

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

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

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Mailbox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mailbox

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

Formats the value using the given formatter.

impl Display for Mailbox

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

fn from(mailbox: Mailbox) -> Self

Converts to this type from the input type.

impl From<Mailbox> for Sender

fn from(mailbox: Mailbox) -> Self

Converts to this type from the input type.

impl From<Sender> for Mailbox

fn from(this: Sender) -> Mailbox

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 Mailbox

type Err = AddressError

The associated error which can be returned from parsing.

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

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

impl Hash for Mailbox

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 Ord for Mailbox

fn cmp(&self, other: &Mailbox) -> 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 Mailbox

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

fn partial_cmp(&self, other: &Mailbox) -> 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<S: Into<String>, T: Into<String>> TryFrom<(S, T)> for Mailbox

type Error = AddressError

The type returned in the event of a conversion error.

fn try_from(header: (S, T)) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Mailbox

impl StructuralPartialEq for Mailbox