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: AsRef<str>, D: AsRef<str>>( user: U, domain: D, ) -> Result<Self, AddressError>

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 new_dangerous<U: AsRef<str>, D: AsRef<str>>(user: U, domain: D) -> Self

Creates a new email address from a user and domain, without validation.

Danger

Use this method only if you are completely sure your input is known and valid, but rejected by the parser. Do not use this method if the contents of either user or domain are unknown and/or obtained from user input.

Prefer using Address::new() instead if possible.

Examples

use lettre::Address;

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

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 duplicate 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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Address

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl Eq for Address

impl From<Address> for Mailbox

Available on crate feature builder only.

fn from(value: Address) -> Self

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<Self, AddressError>

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

impl Hash for Address

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 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

Equality operator ==.

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

Inequality operator !=.

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 Serialize for Address

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Address

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((user, domain): (U, D)) -> Result<Self, Self::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<Self, AddressError>

Performs the conversion.