Struct EmailAddress

pub struct EmailAddress(/* private fields */);

Type representing a single email address. This is basically a wrapper around a String, the email address is parsed for correctness with FromStr::from_str, which is the only want to create an instance. The various components of the email are not parsed out to be accessible independently.

Implementations

impl EmailAddress

pub fn new_unchecked<S>(address: S) -> Self

where S: Into<String>,

Creates an EmailAddress without checking if the email is valid. Only call this method if the address is known to be valid.

use std::str::FromStr;
use email_address::EmailAddress;

let unchecked = "john.doe@example.com";
let email = EmailAddress::from_str(unchecked).expect("email is not valid");
let valid_email = String::from(email);
let email = EmailAddress::new_unchecked(valid_email);

assert_eq!("John Doe <john.doe@example.com>", email.to_display("John Doe"));

pub fn is_valid(address: &str) -> bool

Determine whether the address string is a valid email address. Note this is equivalent to the following:

use email_address::*;
use std::str::FromStr;

let is_valid = EmailAddress::from_str("johnstonskj@gmail.com").is_ok();

pub fn is_valid_local_part(part: &str) -> bool

Determine whether the part string would be a valid local-part if it were in an email address.

pub fn is_valid_domain(part: &str) -> bool

Determine whether the part string would be a valid domain if it were in an email address.

pub fn to_uri(&self) -> String

Return this email address formatted as a URI. This will also URI-encode the email address itself. So, name@example.org becomes mailto:name@example.org.

use email_address::*;
use std::str::FromStr;

assert_eq!(
    EmailAddress::from_str("name@example.org").unwrap().to_uri(),
    String::from("mailto:name@example.org")
);

pub fn to_display(&self, display_name: &str) -> String

Return a string formatted as a display email with the user name. This is commonly used in email headers and other locations where a display name is associated with the address.

use email_address::*;
use std::str::FromStr;

assert_eq!(
    EmailAddress::from_str("name@example.org").unwrap().to_display("My Name"),
    String::from("My Name <name@example.org>")
);

pub fn local_part(&self) -> &str

Returns the local part of the email address. This is borrowed so that no additional allocation is required.

use email_address::*;
use std::str::FromStr;

assert_eq!(
    EmailAddress::from_str("name@example.org").unwrap().local_part(),
    String::from("name")
);

pub fn domain(&self) -> &str

Returns the domain of the email address. This is borrowed so that no additional allocation is required.

use email_address::*;
use std::str::FromStr;

assert_eq!(
    EmailAddress::from_str("name@example.org").unwrap().domain(),
    String::from("example.org")
);

pub fn as_str(&self) -> &str

Returns the email address as a string reference.

Trait Implementations

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 copy 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 Display for EmailAddress

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

Formats the value using the given formatter.

impl From<EmailAddress> for String

fn from(email: EmailAddress) -> Self

Converts to this type from the input type.

impl FromStr for EmailAddress

type Err = Error

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

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