Struct Mailbox 

pub struct Mailbox { /* private fields */ }

A mailbox address with optional display name.

Implementations

impl Mailbox

pub fn name(&self) -> Option<&str>

Returns the optional display name.

pub const fn email(&self) -> &EmailAddress

Returns the mailbox email address.

Trait Implementations

impl<'a> Arbitrary<'a> for Mailbox

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

fn clone(&self) -> Mailbox

Returns a duplicate 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<'de> Deserialize<'de> for Mailbox

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 Mailbox

Renders the mailbox as "display name" <email> or just email if no display name is set.

The output is UTF-8-direct: a non-ASCII display name is emitted verbatim (e.g. "José" <jose@example.com>). This is the right shape for HTTP-API consumers (Postmark, Resend, Mailgun, Loops) which JSON-encode UTF-8 strings natively.

Do not use the result directly as an RFC 5322 header value. SMTP headers are 7-bit and require RFC 2047 encoded-word wrapping for non-ASCII display names; the wire renderer (email_message_wire::render_rfc822) applies that encoding separately. Routing Mailbox::to_string() straight into a From: or To: header would emit a malformed RFC 5322 line.

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

Formats the value using the given formatter.

impl Extend<Mailbox> for MailboxList

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<(Option<String>, EmailAddress)> for Mailbox

fn from((name, email): (Option<String>, EmailAddress)) -> Self

Converts to this type from the input type.

impl From<(String, EmailAddress)> for Mailbox

fn from((name, email): (String, EmailAddress)) -> Self

Converts to this type from the input type.

impl From<EmailAddress> for Mailbox

fn from(email: EmailAddress) -> Self

Converts to this type from the input type.

impl From<Mailbox> for Address

fn from(value: Mailbox) -> Self

Converts to this type from the input type.

impl FromIterator<Mailbox> for MailboxList

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

Creates a value from an iterator.

impl FromStr for Mailbox

type Err = MailboxParseError

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

Available on crate feature schemars only.

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.

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.

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

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 Mailbox

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

Parses a single mailbox from a string slice.

use email_message::Mailbox;

let mailbox = Mailbox::try_from("Mary Smith <mary@x.test>").unwrap();
assert_eq!(mailbox.name(), Some("Mary Smith"));
assert_eq!(mailbox.email().as_str(), "mary@x.test");

type Error = MailboxParseError

The type returned in the event of a conversion error.

impl Eq for Mailbox

impl StructuralPartialEq for Mailbox