Struct EmailAddress 

pub struct EmailAddress { /* private fields */ }

A validated RFC 5322 addr-spec email address.

Domain case-folding

Per RFC 5321 §2.4 the domain part of an address is case-insensitive while the local part “MUST BE treated as case sensitive.” On construction this type lowercases the domain to ASCII-lowercase and preserves the local-part bytes verbatim, so "User.Name@Example.COM" and "User.Name@example.com" compare equal via the derived PartialEq / Eq / Hash. IP-literal domains ([192.0.2.1], [IPv6:::1]) are not case-folded, RFC 5321 §4.1.3 says address literals are case-sensitive, they keep the caller’s bytes.

The case fold is intentional: HashSet<EmailAddress> and Envelope::rcpt_to: Vec<EmailAddress> dedup paths previously kept differently-cased spellings of the same SMTP mailbox as distinct recipients. Callers who need byte-faithful preservation of the original input should keep the source String separately; this type is the SMTP-equivalence value.

Implementations

impl EmailAddress

pub fn as_str(&self) -> &str

Returns the normalized address string.

Trait Implementations

impl<'a> Arbitrary<'a> for EmailAddress

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<str> for EmailAddress

fn as_ref(&self) -> &str

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

impl Clone for EmailAddress

fn clone(&self) -> EmailAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmailAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmailAddress

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 EmailAddress

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

Formats the value using the given formatter.

impl From<EmailAddress> for Mailbox

fn from(email: EmailAddress) -> Self

Converts to this type from the input type.

impl From<EmailAddress> for String

fn from(value: EmailAddress) -> Self

Converts to this type from the input type.

impl FromStr for EmailAddress

type Err = EmailAddressParseError

The associated error which can be returned from parsing.

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

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

impl Hash for EmailAddress

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 JsonSchema for EmailAddress

Available on crate feature schemars only.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl PartialEq for EmailAddress

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

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 TryFrom<&str> for EmailAddress

fn try_from(value: &str) -> Result<Self, Self::Error>

Parses and validates an email from a string slice.

use email_message::EmailAddress;

let email = EmailAddress::try_from("jdoe@one.test").unwrap();
assert_eq!(email.as_str(), "jdoe@one.test");

type Error = EmailAddressParseError

The type returned in the event of a conversion error.

impl Eq for EmailAddress

impl StructuralPartialEq for EmailAddress