Struct ProviderRule 

pub struct ProviderRule { /* private fields */ }

Normalization rule for one mail provider (a set of equivalent domains).

Construct with ProviderRule::new and refine with the builder-style setters. Fields are private so the rule can gain options without a breaking change.

Example

use structured_email_address::ProviderRule;

// A corporate provider that ignores dots and folds case, tag separator '+'.
let rule = ProviderRule::new(["mail.example.com"])
    .strip_dots(true)
    .lowercase_local(true)
    .freemail(false);
assert!(rule.matches("MAIL.EXAMPLE.COM"));

Implementations

impl ProviderRule

pub fn new<I, S>(domains: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Create a rule for the given domains.

Domains are stored in their IDNA-ASCII (punycode) canonical form so a rule registered as münchen.de and one as xn--mnchen-3ya.de are equivalent, and matching agrees with the canonical domain used elsewhere.

Defaults: no dot stripping, no case folding, + subaddress separator, and is_freemail = false (a custom rule is treated as a private domain unless you opt in with freemail(true)).

pub fn strip_dots(self, yes: bool) -> Self

Set whether dots in the local part are insignificant (e.g. Gmail).

pub fn lowercase_local(self, yes: bool) -> Self

Set whether the local part is case-insensitive (folded to lowercase).

pub fn subaddress_separator(self, sep: Option<char>) -> Self

Set the subaddress separator, or None if the provider has no subaddressing.

pub fn freemail(self, yes: bool) -> Self

Set whether this provider is a free webmail provider.

pub fn matches(&self, domain: &str) -> bool

Returns true if domain belongs to this provider.

The domain is canonicalized to IDNA-ASCII before comparison, so Unicode and punycode spellings of the same domain match.

pub fn strips_dots(&self) -> bool

Whether the local part’s dots are insignificant.

pub fn folds_case(&self) -> bool

Whether the local part is case-insensitive.

pub fn separator(&self) -> Option<char>

The provider’s subaddress separator, if any.

pub fn is_freemail(&self) -> bool

Whether this is a free webmail provider.

Trait Implementations

impl Clone for ProviderRule

fn clone(&self) -> ProviderRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderRule

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

Formats the value using the given formatter.