Struct Mailbox 

pub struct Mailbox { /* private fields */ }

A visible mailbox: optional display name plus email address.

Implementations

impl Mailbox

pub fn new( display_name: Option<&str>, address: impl AsRef<str>, ) -> Result<Mailbox, AddressValidationError>

Creates a mailbox from optional display name text and address text.

Examples found in repository

examples/email_facade_basic_usage.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mailbox = address::Mailbox::new(Some("Jane Doe"), "jane@example.com")?;
    let message_id: id::MessageId = "welcome@example.com".parse()?;
    let message = message::EmailMessage::plain_text("Welcome", "A short note.")
        .with_header("From", mailbox.to_string())?;
    let envelope = envelope::Envelope::new(envelope::EnvelopeSender::new("bounce@example.com")?)
        .with_recipient(envelope::EnvelopeRecipient::new("jane@example.com")?);
    let mailto_uri = mailto::MailtoBuilder::new()
        .to("jane@example.com")?
        .subject("Welcome")
        .build();
    let reply = smtp::SmtpReply::new(smtp::SmtpReplyCode::new(250)?, "OK")?;
    let spf = auth::spf::SpfRecord::new().with_term(auth::spf::SpfTerm::new(
        auth::spf::SpfQualifier::Fail,
        auth::spf::SpfMechanism::All,
    ));

    assert_eq!(message.subject(), Some("Welcome"));
    assert_eq!(message_id.to_string(), "<welcome@example.com>");
    assert_eq!(envelope.recipients().len(), 1);
    assert_eq!(
        mailto_uri.to_string(),
        "mailto:jane@example.com?subject=Welcome"
    );
    assert_eq!(reply.to_string(), "250 OK");
    assert_eq!(spf.to_string(), "v=spf1 -all");

    Ok(())
}

pub const fn from_address(address: EmailAddress) -> Mailbox

Creates a mailbox from an already validated address.

pub fn with_display_name( self, display_name: impl AsRef<str>, ) -> Result<Mailbox, AddressValidationError>

Adds a display name to the mailbox.

pub const fn display_name(&self) -> Option<&DisplayName>

Returns the display name, when present.

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

Returns the mailbox address.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl Display for Mailbox

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

Formats the value using the given formatter.

impl FromStr for Mailbox

type Err = AddressValidationError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Mailbox, <Mailbox as FromStr>::Err>

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

impl Hash for Mailbox

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

impl StructuralPartialEq for Mailbox