Struct Address

pub struct Address { /* private fields */ }

Represents an email address with a user and a domain name.

This type contains email in canonical form (user@domain.tld).

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

Examples

You can create an Address from a user and a domain:

use lettre::Address;

let address = Address::new("user", "email.com")?;
assert_eq!(address.user(), "user");
assert_eq!(address.domain(), "email.com");

You can also create an Address from a string literal by parsing it:

use lettre::Address;

let address = "user@email.com".parse::<Address>()?;
assert_eq!(address.user(), "user");
assert_eq!(address.domain(), "email.com");

Implementations

impl Address

pub fn new<U, D>(user: U, domain: D) -> Result<Address, AddressError>

where U: AsRef<str>, D: AsRef<str>,

Creates a new email address from a user and domain.

Examples

use lettre::Address;

let address = Address::new("user", "email.com")?;
let expected = "user@email.com".parse::<Address>()?;
assert_eq!(expected, address);

pub fn user(&self) -> &str

Gets the user portion of the Address.

Examples

use lettre::Address;

let address = Address::new("user", "email.com")?;
assert_eq!(address.user(), "user");

pub fn domain(&self) -> &str

Gets the domain portion of the Address.

Examples

use lettre::Address;

let address = Address::new("user", "email.com")?;
assert_eq!(address.domain(), "email.com");

Trait Implementations

impl AsRef<OsStr> for Address

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Address

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Display for Address

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

Formats the value using the given formatter.

impl From<Address> for Mailbox

fn from(value: Address) -> Mailbox

Converts to this type from the input type.

impl FromStr for Address

type Err = AddressError

The associated error which can be returned from parsing.

fn from_str(val: &str) -> Result<Address, AddressError>

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

impl Hash for Address

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

where __H: Hasher,

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 Address

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

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

fn partial_cmp(&self, other: &Address) -> 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<U, D> TryFrom<(U, D)> for Address

where U: AsRef<str>, D: AsRef<str>,

type Error = AddressError

The type returned in the event of a conversion error.

fn try_from(_: (U, D)) -> Result<Address, <Address as TryFrom<(U, D)>>::Error>

Performs the conversion.

impl TryFrom<String> for Address

type Error = AddressError

The type returned in the event of a conversion error.

fn try_from(serialized: String) -> Result<Address, AddressError>

Performs the conversion.

impl Eq for Address

impl StructuralPartialEq for Address