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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
// check-if-email-exists
// Copyright (C) 2018-2022 Reacher
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//! `check-if-email-exists` lets you check if an email address exists without
//! sending any email.
//!
//! Under the hood, it connects to the email address's SMTP server, and,
//! analyzing the server's responses against some SMTP commands, finds out
//! information about the email address, such as:
//! - Email deliverability: Is an email sent to this address deliverable?
//! - Syntax validation. Is the address syntactically valid?
//! - DNS records validation. Does the domain of the email address have valid
//! MX DNS records?
//! - Disposable email address (DEA) validation. Is the address provided by a
//! known disposable email address provider?
//! - SMTP server validation. Can the mail exchanger of the email address
//! domain be contacted successfully?
//! - Mailbox disabled. Has this email address been disabled by the email
//! provider?
//! - Full inbox. Is the inbox of this mailbox full?
//! - Catch-all address. Is this email address a catch-all address?
//!
//! ```rust
//! use check_if_email_exists::{check_email, CheckEmailInput, CheckEmailInputProxy};
//!
//! async fn check() {
//! // Let's say we want to test the deliverability of someone@gmail.com.
//! let mut input = CheckEmailInput::new("someone@gmail.com".into());
//!
//! // Optionally, we can also tweak the configuration parameters used in the
//! // verification.
//! input
//! .set_from_email("me@example.org".into()) // Used in the `MAIL FROM:` command
//! .set_hello_name("example.org".into()) // Used in the `EHLO` command
//! .set_smtp_port(587) // Use port 587 instead of 25
//! .set_proxy(CheckEmailInputProxy { // Use a SOCKS5 proxy to verify the email
//! host: "my-proxy.io".into(),
//! port: 1080,
//! username: None, // You can also set it non-empty
//! password: None
//! });
//!
//! // Verify this input, using async/await syntax.
//! let result = check_email(&input).await;
//!
//! // `result` is a `Vec<CheckEmailOutput>`, where the CheckEmailOutput
//! // struct contains all information about one email.
//! println!("{:?}", result);
//! }
//! ```
mod haveibeenpwned;
pub mod misc;
pub mod mx;
pub mod smtp;
pub mod syntax;
mod util;
use misc::{check_misc, MiscDetails};
use mx::check_mx;
use rand::Rng;
use smtp::{check_smtp, SmtpDetails, SmtpError};
use syntax::{check_syntax, get_similar_mail_provider};
use trust_dns_proto::rr::rdata::MX;
pub use util::constants::LOG_TARGET;
pub use util::input_output::*;
/// Given an email's misc and smtp details, calculate an estimate of our
/// confidence on how reachable the email is.
///
/// Maybe we can switch to a points-based system?
/// ref: https://github.com/reacherhq/check-if-email-exists/issues/935
fn calculate_reachable(misc: &MiscDetails, smtp: &Result<SmtpDetails, SmtpError>) -> Reachable {
if let Ok(smtp) = smtp {
if misc.is_disposable || misc.is_role_account || smtp.is_catch_all || smtp.has_full_inbox {
return Reachable::Risky;
}
if !smtp.is_deliverable || !smtp.can_connect_smtp || smtp.is_disabled {
return Reachable::Invalid;
}
Reachable::Safe
} else {
Reachable::Unknown
}
}
/// The main function of this library: verify a single email. Performs, in the
/// following order, 4 types of verifications:
/// - syntax check: verify the email is well-formed,
/// - MX checks: verify the domain is configured to receive email,
/// - SMTP checks: connect to the SMTP server and verify the email is
/// deliverable,
/// - misc checks: metadata about the email provider.
///
/// Returns a `CheckEmailOutput` output, whose `is_reachable` field is one of
/// `Safe`, `Invalid`, `Risky` or `Unknown`.
pub async fn check_email(input: &CheckEmailInput) -> CheckEmailOutput {
let to_email = &input.to_email;
log::debug!(
target: LOG_TARGET,
"[email={}] Checking email \"{}\"",
to_email,
to_email
);
let mut my_syntax = check_syntax(to_email.as_ref());
if !my_syntax.is_valid_syntax {
return CheckEmailOutput {
input: to_email.to_string(),
is_reachable: Reachable::Invalid,
syntax: my_syntax,
..Default::default()
};
}
log::debug!(
target: LOG_TARGET,
"[email={}] Found the following syntax validation: {:?}",
to_email,
my_syntax
);
let my_mx = match check_mx(&my_syntax).await {
Ok(m) => m,
e => {
get_similar_mail_provider(&mut my_syntax);
// This happens when there's an internal error while checking MX
// records. Should happen fairly rarely.
return CheckEmailOutput {
input: to_email.to_string(),
is_reachable: Reachable::Unknown,
mx: e,
syntax: my_syntax,
..Default::default()
};
}
};
// Return if we didn't find any MX records.
if my_mx.lookup.is_err() {
get_similar_mail_provider(&mut my_syntax);
return CheckEmailOutput {
input: to_email.to_string(),
is_reachable: Reachable::Invalid,
mx: Ok(my_mx),
syntax: my_syntax,
..Default::default()
};
}
log::debug!(
target: LOG_TARGET,
"[email={}] Found the following MX hosts: {:?}",
to_email,
my_mx
.lookup
.as_ref()
.expect("If lookup is error, we already returned. qed.")
.iter()
.map(|host| host.to_string())
.collect::<Vec<String>>()
);
let my_misc = check_misc(
&my_syntax,
input.check_gravatar,
input.haveibeenpwned_api_key.clone(),
)
.await;
log::debug!(
target: LOG_TARGET,
"[email={}] Found the following misc details: {:?}",
to_email,
my_misc
);
// From the list of MX records, we only choose one: we don't choose the
// first or last ones, because some domains put dummy MX records at the
// beginning or end of the list (sorted by priority). Instead, we choose a
// random one in the middle of the list.
//
// See here for explanation: https://cwiki.apache.org/confluence/display/SPAMASSASSIN/OtherTricks
//
// If anyone has a better algorithm, let me know by creating an issue on
// Github.
// ref: https://github.com/reacherhq/check-if-email-exists/issues/1049
let mut mx_records = my_mx
.lookup
.as_ref()
.expect("If lookup is error, we already returned. qed.")
.iter()
.collect::<Vec<&MX>>();
mx_records.sort_by_key(|a| a.preference());
let host = if mx_records.len() >= 3 {
let mut rng = rand::thread_rng();
let index = rng.gen_range(1..mx_records.len() - 1);
mx_records[index]
} else {
mx_records[mx_records.len() - 1]
};
let my_smtp = check_smtp(
my_syntax
.address
.as_ref()
.expect("We already checked that the email has valid format. qed."),
host.exchange(),
input.smtp_port,
my_syntax.domain.as_ref(),
input,
)
.await;
if my_smtp.is_err() {
get_similar_mail_provider(&mut my_syntax);
}
CheckEmailOutput {
input: to_email.to_string(),
is_reachable: calculate_reachable(&my_misc, &my_smtp),
misc: Ok(my_misc),
mx: Ok(my_mx),
smtp: my_smtp,
syntax: my_syntax,
}
}