1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
//! An [RFC 5322](https://tools.ietf.org/html/rfc5322) compliant email address parser.
//!
//! # Examples
//! You can parse string for email address like this.
//! ```
//! use email_address_parser::EmailAddress;
//!
//! let email = EmailAddress::parse("foo@bar.com", None).unwrap();
//! assert_eq!(email.get_local_part(), "foo");
//! assert_eq!(email.get_domain(), "bar.com");
//! ```
//!
//! For an input string that is an invalid email address, it returns `None`.
//! ```
//! use email_address_parser::EmailAddress;
//!
//! assert!(EmailAddress::parse("test@-iana.org", None).is_none());
//! ```
//!
//! To parse an email address with obsolete parts (as per RFC 5322) in it, pass `None` as the second argument to have non-strict parsing.
//! ```
//! use email_address_parser::*;
//!
//! let email = EmailAddress::parse("\u{0d}\u{0a} \u{0d}\u{0a} test@iana.org", Some(ParsingOptions::new(true)));
//! assert!(email.is_some());
//! ```
//!
//! ## Unicode support
//! In compliance to [RFC 6532](https://tools.ietf.org/html/rfc6532), it supports parsing, validating, and instantiating email addresses with Unicode characters.
//!
//! ```rust
//! use email_address_parser::*;
//!
//! assert!(format!("{}", EmailAddress::new("foö", "bücher.de", None).unwrap()) == "foö@bücher.de");
//! assert!(format!("{}", EmailAddress::parse("foö@bücher.de", None).unwrap()) == "foö@bücher.de");
//! assert!(EmailAddress::is_valid("foö@bücher.de", None));
//! ```
#[macro_use]
extern crate pest_derive;
mod email_address;
#[doc(inline)]
pub use self::email_address::EmailAddress;
pub use self::email_address::ParsingOptions;