emval 0.1.12

emval is a blazingly fast email validator
Documentation 
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use pyo3::prelude::*;
use std::net::IpAddr;

/// A structure representing a validated email address with various components and normalized forms.
#[pyclass]
pub struct ValidatedEmail {
    /// The email address provided to validate_email.
    #[pyo3(get)]
    pub original: String,
    /// The normalized email address should be used instead of the original. It converts IDNA ASCII domain names to Unicode and normalizes both the local part and domain. The normalized address combines the local part and domain name with an '@' sign.
    #[pyo3(get)]
    pub normalized: String,
    /// The ASCII (Punycode-encoded) form of the email address, if one exists.
    #[pyo3(get)]
    pub ascii_email: Option<String>,
    /// The local part of the email address (the part before the '@' sign) after it has been Unicode normalized.
    #[pyo3(get)]
    pub local_part: String,
    /// If the domain part is a domain literal, it will be an IPv4Address or IPv6Address object.
    #[pyo3(get)]
    pub domain_address: Option<IpAddr>,
    /// The domain part of the email address (the part after the '@' sign) after Unicode normalization.
    #[pyo3(get)]
    pub domain_name: String,
    /// The ASCII (Punycode-encoded) form of the domain part of the email address.
    #[pyo3(get)]
    pub ascii_domain: String,
    /// Whether the email address is deliverable.
    #[pyo3(get)]
    pub is_deliverable: bool,
}

/// A structure for customizing email validation.
#[pyclass]
pub struct EmailValidator {
    /// Whether to allow SMTPUTF8. [Default: true]
    pub allow_smtputf8: bool,
    /// Whether to allow empty local part. [Default: false]
    pub allow_empty_local: bool,
    /// Whether to allow quoted local part. [Default: false]
    pub allow_quoted_local: bool,
    /// Whether to allow domain literals. [Default: false]
    pub allow_domain_literal: bool,
    /// Whether to check if the email address is deliverable. [Default: true]
    pub deliverable_address: bool,
    /// Special-use domains to allow despite being in the reserved list. [Default: empty]
    pub allowed_special_domains: Vec<String>,
}

impl Default for EmailValidator {
    fn default() -> Self {
        Self {
            allow_smtputf8: true,
            allow_empty_local: false,
            allow_quoted_local: false,
            allow_domain_literal: false,
            deliverable_address: true,
            allowed_special_domains: Vec::new(),
        }
    }
}