Advanced email validation with MX records, SMTP verification, disposable email detection, batch processing, and caching. Production-ready with TypeScript support.
npm install @emailcheck/email-validator-js





๐ Advanced email validation library for Node.js with MX record checking, SMTP verification, disposable email detection, and much more. Now with batch processing, advanced caching, and detailed error reporting.
- Features
- Use Cases
- API / Cloud Service
- License
- Installation
- Quick Start
- Migration Guide (to v3.x)
- API Reference
- Configuration
- Examples
- Custom Cache Injection
- Performance & Caching
- Email Provider Databases
- Testing
- Contributing
โ Check email address validity
โ Check email address domain validity in domain TLD list
โ Check email address MX records
โ Check email address SMTP connection
โ Check email address disposable or burnable status
โ Check email address free email provider status
โ NEW: Batch email verification with concurrency control
โ NEW: Detailed verification results with error codes
โ NEW: Built-in caching for improved performance
โ NEW: Automatic retry mechanism for transient failures
โ NEW: RFC 5321 compliant validation
โ NEW: Enhanced SMTP verification with TLS/SSL support
โ NEW: Multi-port testing (25, 587, 465) with automatic port optimization
โ NEW: Custom SMTP sequences and command control (EHLO/HELO, VRFY, STARTTLS)
โ NEW: Smart caching for port performance and SMTP results
โ NEW: Enhanced name detection from email addresses with composite name support
โ NEW: Domain typo detection and suggestions with caching
โ NEW: Get domain age via WHOIS lookup
โ NEW: Get domain registration status via WHOIS lookup
โ NEW: Serverless support for AWS Lambda, Vercel Edge, Cloudflare Workers, and more
โ Code Quality: Comprehensive linting, type checking, and automated testing
- Increase delivery rate of email campaigns by removing spam emails
- Increase email open rate and your marketing IPs reputation
- Protect your website from spam, bots and fake emails
- Protect your product signup form from fake emails
- Protect your website forms from fake emails
- Protect your self from fraud orders and accounts using fake emails
- Integrate email address verification into your website forms
- Integrate email address verification into your backoffice administration and order processing
We offer this email verification and validation and more advanced features in our Scalable Cloud API Service Offering - You could try it here Email Verification
---
email-validator-js is licensed under Business Source License 1.1.
| Use Case | Is a commercial license required?|
|----------|-----------|
| Exploring email-validator-js for your own research, hobbies, and testing purposes | No |
| Using email-validator-js to build a proof-of-concept application | No |
| Using email-validator-js to build revenue-generating applications | Yes |
| Using email-validator-js to build software that is provided as a service (SaaS) | Yes |
| Forking email-validator-js for any production purposes | Yes |
๐ For commercial licensing, visit email-check.app/license/email-validator or contact us at sales@email-check.app.
---
Install the module through Yarn:
``bash`
yarn add @emailcheck/email-validator-js
Or NPM:
`bash`
npm install @emailcheck/email-validator-js
`typescript
import { verifyEmail } from '@emailcheck/email-validator-js';
// Basic usage
const result = await verifyEmail({
emailAddress: 'user@mydomain.com',
verifyMx: true,
verifySmtp: true,
timeout: 3000
});
console.log(result.validFormat); // true
console.log(result.validMx); // true or false
console.log(result.validSmtp); // true or false
`
> โ ๏ธ Breaking Change in v3.x: Enum values and constants now use camelCase instead of SCREAMING_SNAKE_CASE. See Migration Guide for details.
Version 3.x introduces a breaking change to improve code consistency with TypeScript/JavaScript conventions. All enum values and constants now use camelCase instead of SCREAMING_SNAKE_CASE.
#### Enum Values
| Before (v2.x) | After (v3.x) |
|---------------|--------------|
| EmailProvider.GMAIL | EmailProvider.gmail |EmailProvider.YAHOO
| | EmailProvider.yahoo |EmailProvider.HOTMAIL_B2C
| | EmailProvider.hotmailB2c |VerificationErrorCode.INVALID_FORMAT
| | VerificationErrorCode.invalidFormat |VerificationErrorCode.NO_MX_RECORDS
| | VerificationErrorCode.noMxRecords |SMTPStep.GREETING
| | SMTPStep.greeting |SMTPStep.EHLO
| | SMTPStep.ehlo |SMTPStep.MAIL_FROM
| | SMTPStep.mailFrom |
#### Constants
| Before (v2.x) | After (v3.x) |
|---------------|--------------|
| CHECK_IF_EMAIL_EXISTS_CONSTANTS.DEFAULT_TIMEOUT | checkIfEmailExistsConstants.defaultTimeout |CHECK_IF_EMAIL_EXISTS_CONSTANTS.GMAIL_DOMAINS
| | checkIfEmailExistsConstants.gmailDomains |WHOIS_SERVERS
| | whoisServers |
#### Step 1: Update Enum References
`typescript
// Before
import { EmailProvider, VerificationErrorCode, SMTPStep } from '@emailcheck/email-validator-js';
if (provider === EmailProvider.GMAIL) { / ... / }
if (error === VerificationErrorCode.INVALID_FORMAT) { / ... / }
const steps = [SMTPStep.GREETING, SMTPStep.EHLO, SMTPStep.MAIL_FROM];
// After
import { EmailProvider, VerificationErrorCode, SMTPStep } from '@emailcheck/email-validator-js';
if (provider === EmailProvider.gmail) { / ... / }
if (error === VerificationErrorCode.invalidFormat) { / ... / }
const steps = [SMTPStep.greeting, SMTPStep.ehlo, SMTPStep.mailFrom];
`
#### Step 2: Update Constant References
`typescript
// Before
import { CHECK_IF_EMAIL_EXISTS_CONSTANTS } from '@emailcheck/email-validator-js';
const timeout = CHECK_IF_EMAIL_EXISTS_CONSTANTS.DEFAULT_TIMEOUT;
const domains = CHECK_IF_EMAIL_EXISTS_CONSTANTS.GMAIL_DOMAINS;
// After
import { checkIfEmailExistsConstants } from '@emailcheck/email-validator-js';
const timeout = checkIfEmailExistsConstants.defaultTimeout;
const domains = checkIfEmailExistsConstants.gmailDomains;
`
#### Step 3: Update Switch Statements
`typescript
// Before
switch (provider) {
case EmailProvider.YAHOO:
// Handle Yahoo
break;
case EmailProvider.HOTMAIL_B2C:
// Handle Hotmail
break;
}
// After
switch (provider) {
case EmailProvider.yahoo:
// Handle Yahoo
break;
case EmailProvider.hotmailB2c:
// Handle Hotmail
break;
}
`
1. String values remain unchanged: The underlying string values (e.g., 'gmail', 'INVALID_FORMAT') are preserved. Only the property names changed.
2. Runtime compatibility: If you're comparing enum values to strings from external sources, the string values still work:
`typescript`
// Still works in v3.x
if (provider === 'gmail') { / ... / }
3. TypeScript strict mode: Ensure you update all references before compiling, or TypeScript will report errors.
4. Test your code: After updating, run your test suite to ensure all enum and constant references are updated correctly.
If you're using an IDE with refactoring support (like VS Code), you can use find-and-replace:
1. Find all references to old enum values
2. Replace with new camelCase versions
3. Run TypeScript compiler to verify no errors
- ๐ Check the API Reference for updated enum definitions
- ๐ฌ Open an issue if you encounter problems
- ๐ง Contact support@email-check.app
#### verifyEmail(params: IVerifyEmailParams): Promise
Comprehensive email verification with detailed results and error codes.
Parameters:
- emailAddress (string, required): Email address to verifytimeout
- (number): Timeout in milliseconds (default: 4000)verifyMx
- (boolean): Check MX records (default: true)verifySmtp
- (boolean): Verify SMTP connection (default: false)smtpPort
- (number): Custom SMTP portdebug
- (boolean): Enable debug logging (default: false)checkDisposable
- (boolean): Check for disposable emails (default: true)checkFree
- (boolean): Check for free email providers (default: true)retryAttempts
- (number): Retry attempts for failures (default: 1)detectName
- (boolean): Detect names from email address (default: false)nameDetectionMethod
- (function): Custom name detection methodsuggestDomain
- (boolean): Enable domain typo suggestions (default: true)domainSuggestionMethod
- (function): Custom domain suggestion methodcommonDomains
- (string[]): Custom list of domains for suggestionscheckDomainAge
- (boolean): Check domain age (default: false)checkDomainRegistration
- (boolean): Check domain registration status (default: false)whoisTimeout
- (number): WHOIS lookup timeout (default: 5000)debug
- (boolean): Enable debug logging including WHOIS lookups (default: false)cache
- (ICache): Optional custom cache instance
Returns:
`typescript`
{
email: string;
validFormat: boolean;
validMx: boolean | null;
validSmtp: boolean | null;
isDisposable: boolean;
isFree: boolean;
detectedName?: DetectedName | null;
domainAge?: DomainAgeInfo | null;
domainRegistration?: DomainRegistrationInfo | null;
domainSuggestion?: DomainSuggestion | null;
metadata?: {
verificationTime: number;
cached: boolean;
error?: VerificationErrorCode;
};
}
#### verifyEmailBatch(params: IBatchVerifyParams): Promise
Verify multiple emails in parallel with concurrency control.
Parameters:
- emailAddresses (string[], required): Array of emails to verifyconcurrency
- (number): Parallel processing limit (default: 5)detectName
- (boolean): Detect names from email addressessuggestDomain
- (boolean): Enable domain typo suggestionsverifyEmail
- Other parameters from
Returns:
`typescript`
{
results: Map
summary: {
total: number;
valid: number;
invalid: number;
errors: number;
processingTime: number;
};
}
#### detectName(email: string): DetectedName | null
Detect first and last name from email address.
`typescript`
const name = detectName('john.doe@mydomain.com');
// Returns: { firstName: 'John', lastName: 'Doe', confidence: 0.9 }
Detection Patterns:
- Dot separator: john.doe โ John Doe (90% confidence)jane_smith
- Underscore: โ Jane Smith (80% confidence)mary-johnson
- Hyphen: โ Mary Johnson (80% confidence)johnDoe
- CamelCase: โ John Doe (70% confidence)mo1.test2
- Composite names: โ Mo1 Test2 (60% confidence)user1.admin2
- Mixed alphanumeric: โ User1 Admin2 (60% confidence)john.doe123
- Smart number handling: โ John Doe (80% confidence)john.doe.dev
- Contextual suffixes: โ John Doe (70% confidence)alice
- Single name: โ Alice (50% confidence)
Enhanced Features:
- Removes email aliases (text after +)
- Smart handling of numbers (preserves in composite names, removes trailing)
- Recognizes contextual suffixes (dev, company, sales, years)
- Handles complex multi-part names
- Proper name capitalization
- Filters out common non-name prefixes (admin, support, info, etc.)
#### detectNameFromEmail(params: IDetectNameParams): DetectedName | null
Advanced name detection with custom method support.
`typescript
const customMethod = (email: string) => {
// Your custom logic
return { firstName: 'Custom', lastName: 'Name', confidence: 1.0 };
};
const name = detectNameFromEmail({
email: 'user@mydomain.com',
customMethod: customMethod
});
`
Parameters:
- email (string): Email addresscustomMethod
- (function): Custom detection logic
#### defaultNameDetectionMethod(email: string): DetectedName | null
The default name detection implementation, exported for custom extensions.
#### Algorithm-Specific Name Cleaning
##### cleanNameForAlgorithm(name: string): string
Clean a name by removing special characters (dots, underscores, asterisks). Specifically designed for Algorithm name processing.
`typescript
import { cleanNameForAlgorithm } from '@emailcheck/email-validator-js';
const cleanedName = cleanNameForAlgorithm('john.doe_smith*');
// Returns: 'johndoesmith'
const cleanedName2 = cleanNameForAlgorithm('first_name.last');
// Returns: 'firstnamelast'
`
##### detectNameForAlgorithm(email: string): DetectedName | null
Enhanced name detection for Algorithm with aggressive cleaning. Removes dots, underscores, and asterisks from detected names.
`typescript
import { detectNameForAlgorithm } from '@emailcheck/email-validator-js';
const result = detectNameForAlgorithm('john.doe_smith@company.com');
// Returns: { firstName: 'John', lastName: 'Doesmith', confidence: 0.9025 }
// Compared to regular detection:
import { detectName } from '@emailcheck/email-validator-js';
const normalResult = detectName('john.doe_smith@company.com');
// Returns: { firstName: 'John', lastName: 'Doe_smith', confidence: 0.95 }
`
Key Differences:
- Removes all dots (.), underscores (_), and asterisks (*) from detected names
- Slightly reduces confidence (95% of original) due to cleaning process
- Ideal for systems requiring clean, sanitized names without special characters
- Normalizes multiple spaces to single spaces
#### suggestEmailDomain(email: string, commonDomains?: string[]): DomainSuggestion | null
Detect and suggest corrections for misspelled email domains.
`typescript
const suggestion = suggestEmailDomain('user@gmial.com');
// Returns: { original: 'user@gmial.com', suggested: 'user@gmail.com', confidence: 0.95 }
// With custom domain list
const customDomains = ['company.com', 'enterprise.org'];
const customSuggestion = suggestEmailDomain('user@compny.com', customDomains);
`
Features:
- 70+ common email domains by default
- String similarity algorithm
- Known typo patterns (95% confidence)
- Smart thresholds based on domain length
- 24-hour caching for performance
#### suggestDomain(params: ISuggestDomainParams): DomainSuggestion | null
Advanced domain suggestion with custom method support.
`typescript`
const suggestion = suggestDomain({
domain: 'gmial.com',
customMethod: myCustomMethod,
commonDomains: ['company.com']
});
Parameters:
- domain (string): Domain to checkcustomMethod
- (function): Custom suggestion logiccommonDomains
- (string[]): Custom domain list
#### defaultDomainSuggestionMethod(domain: string, commonDomains?: string[]): DomainSuggestion | null
The default domain suggestion implementation, exported for custom extensions.
#### isCommonDomain(domain: string, commonDomains?: string[]): boolean
Check if a domain is in the common domains list.
`typescript
isCommonDomain('gmail.com'); // true
isCommonDomain('mycompany.com'); // false
// With custom list
isCommonDomain('mycompany.com', ['mycompany.com']); // true
`
#### getDomainSimilarity(domain1: string, domain2: string): number
Calculate similarity score between two domains (0-1).
`typescript`
getDomainSimilarity('gmail.com', 'gmial.com'); // 0.8
getDomainSimilarity('gmail.com', 'yahoo.com'); // 0.3
> Note: WHOIS functions use PSL (Public Suffix List) validation to ensure domain validity before performing lookups. Invalid domains or domains without valid TLDs will return null.
#### getDomainAge(domain: string, timeout?: number): Promise
Get domain age information via WHOIS lookup.
`typescript
const ageInfo = await getDomainAge('mydomain.com');
// Returns:
// {
// domain: 'mydomain.com',
// creationDate: Date,
// ageInDays: 7890,
// ageInYears: 21.6,
// expirationDate: Date,
// updatedDate: Date
// }
// Works with email addresses and URLs too
await getDomainAge('user@mydomain.com');
await getDomainAge('https://mydomain.com/path');
`
Parameters:
- domain (string): Domain, email, or URL to checktimeout
- (number): Timeout in milliseconds (default: 5000)
Returns: DomainAgeInfo object or null if lookup fails
#### getDomainRegistrationStatus(domain: string, timeout?: number): Promise
Get detailed domain registration status via WHOIS.
`typescript`
const status = await getDomainRegistrationStatus('mydomain.com');
// Returns:
// {
// domain: 'mydomain.com',
// isRegistered: true,
// isAvailable: false,
// status: ['clientTransferProhibited'],
// registrar: 'Example Registrar',
// nameServers: ['ns1.mydomain.com', 'ns2.mydomain.com'],
// expirationDate: Date,
// isExpired: false,
// daysUntilExpiration: 365,
// isPendingDelete: false,
// isLocked: true
// }
Parameters:
- domain (string): Domain, email, or URL to checktimeout
- (number): Timeout in milliseconds (default: 5000)
Returns: DomainRegistrationInfo object or null if lookup fails
Features:
- Supports 50+ TLDs with specific WHOIS servers
- Automatic WHOIS server discovery for unknown TLDs
- Parses various WHOIS response formats
- Uses PSL (Public Suffix List) for domain validation
- 1-hour result caching
- Extracts domain from emails and URLs
#### isDisposableEmail(emailOrDomain: string, cache?: ICache, options?: { skipMxCheck?: boolean; skipDomain?: boolean }): boolean
Check if email uses a disposable provider.
`typescript
// Basic usage
isDisposableEmail('user@tempmail.com'); // true
isDisposableEmail('tempmail.com'); // true
isDisposableEmail('gmail.com'); // false
// With options
isDisposableEmail('user@tempmail.com', null, {
skipMxCheck: true, // Skip MX record validation
skipDomain: true // Skip domain validation
}); // true
`
#### isFreeEmail(emailOrDomain: string, cache?: ICache, options?: { skipMxCheck?: boolean; skipDomain?: boolean }): boolean
Check if email uses a free provider.
`typescript
// Basic usage
isFreeEmail('user@gmail.com'); // true
isFreeEmail('yahoo.com'); // true
isFreeEmail('corporate.com'); // false
// With options
isFreeEmail('user@gmail.com', null, {
skipMxCheck: true, // Skip MX record validation
skipDomain: true // Skip domain validation
}); // true
`
#### isValidEmail(emailAddress: string): boolean
Validate email format (RFC 5321 compliant).
`typescript`
isValidEmail('user@mydomain.com'); // true
isValidEmail('invalid.email'); // false
Validation Rules:
- Proper @ symbol placement
- Local part max 64 characters
- Domain max 253 characters
- No consecutive dots
- No leading/trailing dots
- Valid domain TLD
#### isValidEmailDomain(emailOrDomain: string): boolean
Validate if a domain has a valid TLD.
`typescript`
isValidEmailDomain('mydomain.com'); // true
isValidEmailDomain('example.invalid'); // false
#### Cache Management
`typescript
import { getDefaultCache, clearDefaultCache, resetDefaultCache } from '@emailcheck/email-validator-js';
// Get the default cache instance (singleton)
const defaultCache = getDefaultCache();
// Clear all entries from the default cache
clearDefaultCache();
// Reset to a fresh cache instance
resetDefaultCache();
`
#### DetectedName`typescript`
interface DetectedName {
firstName?: string;
lastName?: string;
confidence: number; // 0-1 scale
}
#### DomainSuggestion`typescript`
interface DomainSuggestion {
original: string;
suggested: string;
confidence: number; // 0-1 scale
}
#### NameDetectionMethod`typescript`
type NameDetectionMethod = (email: string) => DetectedName | null;
#### DomainSuggestionMethod`typescript`
type DomainSuggestionMethod = (domain: string) => DomainSuggestion | null;
#### DomainAgeInfo`typescript`
interface DomainAgeInfo {
domain: string;
creationDate: Date;
ageInDays: number;
ageInYears: number;
expirationDate: Date | null;
updatedDate: Date | null;
}
#### DomainRegistrationInfo`typescript`
interface DomainRegistrationInfo {
domain: string;
isRegistered: boolean;
isAvailable: boolean;
status: string[];
registrar: string | null;
nameServers: string[];
expirationDate: Date | null;
isExpired: boolean;
daysUntilExpiration: number | null;
isPendingDelete?: boolean;
isLocked?: boolean;
}
#### COMMON_EMAIL_DOMAINS
Array of 70+ common email domains used for typo detection.
`typescript
import { COMMON_EMAIL_DOMAINS } from '@emailcheck/email-validator-js';
console.log(COMMON_EMAIL_DOMAINS);
// ['gmail.com', 'yahoo.com', 'outlook.com', 'hotmail.com', ...]
`
Includes:
- Popular free providers (Gmail, Yahoo, Outlook, etc.)
- Business email services (Google Workspace, Microsoft, etc.)
- Privacy-focused providers (ProtonMail, Tutanota, etc.)
- Regional providers (GMX, Yandex, QQ, etc.)
- Hosting services (GoDaddy, Namecheap, etc.)
`typescript`
enum VerificationErrorCode {
invalidFormat = 'INVALID_FORMAT',
invalidDomain = 'INVALID_DOMAIN',
noMxRecords = 'NO_MX_RECORDS',
smtpConnectionFailed = 'SMTP_CONNECTION_FAILED',
smtpTimeout = 'SMTP_TIMEOUT',
mailboxNotFound = 'MAILBOX_NOT_FOUND',
mailboxFull = 'MAILBOX_FULL',
networkError = 'NETWORK_ERROR',
disposableEmail = 'DISPOSABLE_EMAIL',
freeEmailProvider = 'FREE_EMAIL_PROVIDER'
}
.$3
Enable or disable domain checking. This is done in two steps:
1. Verify that the domain does indeed exist
2. Verify that the domain has valid MX recordsDefault:
false.$3
Enable or disable mailbox checking. Only a few SMTP servers allow this, and even then whether it works depends on your IP's reputation with those servers. This library performs a best effort validation:
* It returns null for Yahoo addresses, for failed connections, for unknown SMTP errors
* It returns true for valid SMTP responses
* It returns false for SMTP errors specific to the address's formatting or mailbox existenceDefault:
false.$3
Check if the email domain is a known disposable email provider. Default: false.$3
Check if the email domain is a known free email provider. Default: false.$3
Return detailed verification results with error codes. Default: false.$3
Number of retry attempts for transient failures. Default: 1.Examples
$3
`typescript
import { verifyEmail } from '@emailcheck/email-validator-js';const result = await verifyEmail({
emailAddress: 'foo@email.com',
verifyMx: true,
verifySmtp: true,
timeout: 3000
});
console.log(result.validFormat); // true
console.log(result.validMx); // true
console.log(result.validSmtp); // true
`$3
`typescript
import { verifyEmail } from '@emailcheck/email-validator-js';const result = await verifyEmail({
emailAddress: 'foo@email.com',
verifyMx: true,
verifySmtp: true,
checkDisposable: true,
checkFree: true
});
// result.validFormat: true
// result.validMx: true
// result.validSmtp: true
// result.isDisposable: false
// result.isFree: false
// result.metadata.verificationTime: 125
`$3
`typescript
import { verifyEmailBatch } from '@emailcheck/email-validator-js';const emails = ['user1@gmail.com', 'user2@mydomain.com', 'invalid@fake.com'];
const result = await verifyEmailBatch({
emailAddresses: emails,
concurrency: 5,
verifyMx: true,
checkDisposable: true,
checkFree: true
});
// result.summary.valid: 2
// result.summary.invalid: 1
// result.summary.processingTime: 234
`$3
`typescript
import { verifyMailboxSMTP } from '@emailcheck/email-validator-js';
import { getDefaultCache } from '@emailcheck/email-validator-js';// Direct SMTP verification with enhanced features
const { result, port, cached, portCached } = await verifyMailboxSMTP({
local: 'user',
domain: 'example.com',
mxRecords: ['mx.example.com'],
options: {
ports: [25, 587, 465], // Test multiple ports with TLS support
timeout: 5000,
cache: getDefaultCache(), // Smart caching for performance
debug: false,
tls: {
rejectUnauthorized: false, // Lenient TLS for compatibility
minVersion: 'TLSv1.2',
},
hostname: 'your-domain.com', // Custom EHLO hostname
useVRFY: true, // Enable VRFY command as fallback
},
});
// result: boolean - SMTP verification result
// port: number - The successful port used
// cached: boolean - If result was cached
// portCached: boolean - If port was cached from previous successful attempts
console.log(
SMTP result: ${result} via port ${port} (cached: ${cached || portCached}));
`$3
`typescript
import { verifyMailboxSMTP, SMTPStep } from '@emailcheck/email-validator-js';// Custom SMTP command sequence
const { result } = await verifyMailboxSMTP({
local: 'user',
domain: 'example.com',
mxRecords: ['mx.example.com'],
options: {
sequence: {
steps: [
SMTPStep.greeting,
SMTPStep.ehlo, // Extended SMTP
SMTPStep.startTls, // Upgrade to TLS
SMTPStep.mailFrom,
SMTPStep.rcptTo,
SMTPStep.vrfy, // Additional verification
],
from: '', // Custom MAIL FROM
},
ports: [587, 465], // Try STARTTLS first, then implicit TLS
maxRetries: 2,
},
});
// Port-specific optimization
const testPorts = async (email: string, mxHosts: string[]) => {
const [local, domain] = email.split('@');
const { result, port, portCached } = await verifyMailboxSMTP({
local,
domain,
mxRecords: mxHosts,
options: {
cache: getDefaultCache(),
// Port order matters: tests in sequence, stops at first success
ports: [587, 465, 25], // STARTTLS -> SMTPS -> SMTP
},
});
console.log(
Optimal port for ${domain}: ${port} (cached: ${portCached}));
return { result, port };
};
`$3
All examples have been recently improved with:
- โ
Consistent import styles and error handling
- โ
Fixed async/await patterns
- โ
Enhanced documentation and comments
- โ
Renamed files for better clarity
Development (Recommended):
`bash
Run examples with ts-node for full type checking
npx ts-node examples/smtp-usage.ts
npx ts-node examples/smtp-test.ts
npx ts-node examples/smtp-enhanced.ts
npx ts-node examples/smtp-comprehensive-tests.ts
npx ts-node examples/custom-cache-memory.ts
npx ts-node examples/smtp-sequences.ts
npx ts-node examples/algolia-integration.ts
`Direct TypeScript Execution (v2.14.0+):
`bash
After the next release (v2.14.0) with updated distribution exports:
yarn build
node --experimental-strip-types examples/smtp-usage.tsRequires Node.js 20.10+ or Node.js 21.0+ for --experimental-strip-types support
`For current development, use
npx ts-node which imports directly from source files with full type checking.$3
`typescript
import { detectName, verifyEmail } from '@emailcheck/email-validator-js';// Standalone name detection - now with composite name support
const name = detectName('john.doe@mydomain.com');
// name: { firstName: 'John', lastName: 'Doe', confidence: 0.9 }
// Handle alphanumeric composite names
const composite = detectName('mo1.test2@mydomain.com');
// composite: { firstName: 'Mo1', lastName: 'Test2', confidence: 0.6 }
// Smart handling of numbers and suffixes
const withNumbers = detectName('john.doe123@mydomain.com');
// withNumbers: { firstName: 'John', lastName: 'Doe', confidence: 0.8 }
const withSuffix = detectName('jane.smith.dev@mydomain.com');
// withSuffix: { firstName: 'Jane', lastName: 'Smith', confidence: 0.7 }
// Integrated with email verification
const result = await verifyEmail({
emailAddress: 'jane_smith@mydomain.com',
detectName: true
});
// result.detectedName: { firstName: 'Jane', lastName: 'Smith', confidence: 0.8 }
// Custom detection method
const customMethod = (email: string) => {
// Your custom logic here
return { firstName: 'Custom', lastName: 'Name', confidence: 1.0 };
};
const resultCustom = await verifyEmail({
emailAddress: 'user@mydomain.com',
detectName: true,
nameDetectionMethod: customMethod
});
`$3
`typescript
import { suggestEmailDomain, verifyEmail } from '@emailcheck/email-validator-js';// Standalone domain suggestion
const suggestion = suggestEmailDomain('user@gmial.com');
// suggestion: { original: 'user@gmial.com', suggested: 'user@gmail.com', confidence: 0.95 }
// Integrated with email verification (enabled by default in detailed mode)
const result = await verifyEmail({
emailAddress: 'john@yaho.com',
suggestDomain: true // Default: true for detailed verification
});
// result.domainSuggestion: { original: 'john@yaho.com', suggested: 'john@yahoo.com', confidence: 0.9 }
// With custom domain list
const customDomains = ['company.com', 'enterprise.org'];
const resultCustom = await verifyEmail({
emailAddress: 'user@compny.com',
suggestDomain: true,
commonDomains: customDomains
});
// resultCustom.domainSuggestion: { suggested: 'user@company.com', confidence: 0.85 }
`$3
When a domain does not exist or has no MX records:
`typescript
const result = await verifyEmail({
emailAddress: 'foo@bad-domain.com',
verifyMx: true,
verifySmtp: true
});
// result.validFormat: true (format is valid)
// result.validMx: false (no MX records)
// result.validSmtp: null (couldn't be performed)
`$3
`typescript
const result = await verifyEmail({
emailAddress: 'user@suspicious-domain.com',
verifyMx: true,
verifySmtp: true,
checkDisposable: true,
checkFree: true
});if (!result.validFormat) {
console.log('Invalid email format');
} else if (!result.validMx) {
console.log('Invalid domain - no MX records');
} else if (result.isDisposable) {
console.log('Disposable email detected');
} else if (result.metadata?.error) {
switch (result.metadata.error) {
case VerificationErrorCode.disposableEmail:
console.log('Rejected: Disposable email');
break;
case VerificationErrorCode.noMxRecords:
console.log('Rejected: Invalid domain');
break;
case VerificationErrorCode.mailboxNotFound:
console.log('Rejected: Mailbox does not exist');
break;
}
}
`$3
`typescript
const emails = [
'valid@gmail.com',
'test@tempmail.com',
'user@company.com',
// ... hundreds more
];const batch = await verifyEmailBatch({
emailAddresses: emails,
concurrency: 10, // Process 10 emails simultaneously
verifyMx: true,
checkDisposable: true,
detailed: true
});
console.log(
Processed ${batch.summary.total} emails);
console.log(Valid: ${batch.summary.valid});
console.log(Invalid: ${batch.summary.invalid});
console.log(Time: ${batch.summary.processingTime}ms);// Filter out invalid emails
const validEmails = [];
for (const [email, result] of batch.results) {
if (result.validFormat) {
validEmails.push(email);
}
}
`$3
`typescript
// First verification - hits DNS and SMTP
const first = await verifyEmail({
emailAddress: 'cached@mydomain.com',
verifyMx: true
});
// Takes ~500ms// Second verification - uses cache
const second = await verifyEmail({
emailAddress: 'cached@mydomain.com',
verifyMx: true
});
// Takes ~1ms (cached)
// Clear cache if needed
clearAllCaches();
`๐ Custom Cache Injection
The library supports parameter-based cache injection, allowing you to use custom cache backends like Redis, Memcached, or any LRU-compatible cache implementation.
$3
The library includes a built-in LRU cache for all operations. By default, it uses a lazy-loaded singleton cache instance.
#### Default Cache Usage
`typescript
import { verifyEmail } from '@emailcheck/email-validator-js';// No cache setup needed - uses default LRU cache automatically
const result = await verifyEmail({
emailAddress: 'user@example.com',
verifyMx: true,
verifySmtp: true
});
// Subsequent calls with the same email will use cached results
const result2 = await verifyEmail({
emailAddress: 'user@example.com',
verifyMx: true,
verifySmtp: true
});
`#### Custom Cache Implementation
Create your own cache by implementing the
ICache interface:`typescript
import { verifyEmail, type ICache, ICacheStore, DEFAULT_CACHE_OPTIONS } from '@emailcheck/email-validator-js';
import { LRUAdapter } from '@emailcheck/email-validator-js';// Create custom cache with LRU adapters
const customCache: ICache = {
mx: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.mx, DEFAULT_CACHE_OPTIONS.ttl.mx),
disposable: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.disposable, DEFAULT_CACHE_OPTIONS.ttl.disposable),
free: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.free, DEFAULT_CACHE_OPTIONS.ttl.free),
domainValid: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.domainValid, DEFAULT_CACHE_OPTIONS.ttl.domainValid),
smtp: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.smtp, DEFAULT_CACHE_OPTIONS.ttl.smtp),
domainSuggestion: new LRUAdapter<{ suggested: string; confidence: number } | null>(
DEFAULT_CACHE_OPTIONS.maxSize.domainSuggestion,
DEFAULT_CACHE_OPTIONS.ttl.domainSuggestion
),
whois: new LRUAdapter(DEFAULT_CACHE_OPTIONS.maxSize.whois, DEFAULT_CACHE_OPTIONS.ttl.whois),
};
// Use with email verification
const result = await verifyEmail({
emailAddress: 'user@mydomain.com',
verifyMx: true,
verifySmtp: true,
cache: customCache // Pass the cache instance
});
`#### Redis Cache Implementation
`typescript
import { verifyEmail, type ICache, ICacheStore } from '@emailcheck/email-validator-js';
import { RedisAdapter } from '@emailcheck/email-validator-js';
import Redis from 'ioredis';// Create Redis client
const redis = new Redis({
host: 'localhost',
port: 6379,
});
// Create Redis cache
const redisCache: ICache = {
mx: new RedisAdapter(redis, {
keyPrefix: 'email:mx:',
ttl: 1800000, // 30 minutes
}),
disposable: new RedisAdapter(redis, {
keyPrefix: 'email:disposable:',
ttl: 86400000, // 24 hours
}),
free: new RedisAdapter(redis, {
keyPrefix: 'email:free:',
ttl: 86400000, // 24 hours
}),
domainValid: new RedisAdapter(redis, {
keyPrefix: 'email:domain:',
ttl: 86400000, // 24 hours
}),
smtp: new RedisAdapter(redis, {
keyPrefix: 'email:smtp:',
ttl: 1800000, // 30 minutes
}),
domainSuggestion: new RedisAdapter(redis, {
keyPrefix: 'email:suggest:',
ttl: 86400000, // 24 hours
}),
whois: new RedisAdapter(redis, {
keyPrefix: 'email:whois:',
ttl: 3600000, // 1 hour
}),
};
// Use with batch verification
import { verifyEmailBatch } from '@emailcheck/email-validator-js';
const batchResult = await verifyEmailBatch({
emailAddresses: ['user1@mydomain.com', 'user2@mydomain.com'],
verifyMx: true,
verifySmtp: true,
cache: redisCache,
concurrency: 10
});
`#### Custom Cache Store Implementation
Create your own cache adapter by implementing the
ICacheStore interface:`typescript
import { verifyEmail, type ICacheStore } from '@emailcheck/email-validator-js';class MyCustomCache implements ICacheStore {
private store = new Map();
async get(key: string): Promise {
const item = this.store.get(key);
if (!item) return null;
if (Date.now() > item.expiry) {
this.store.delete(key);
return null;
}
return item.value;
}
async set(key: string, value: T, ttlMs?: number): Promise {
const expiry = Date.now() + (ttlMs || 3600000);
this.store.set(key, { value, expiry });
}
async delete(key: string): Promise {
return this.store.delete(key);
}
async has(key: string): Promise {
const item = this.store.get(key);
if (!item) return false;
if (Date.now() > item.expiry) {
this.store.delete(key);
return false;
}
return true;
}
async clear(): Promise {
this.store.clear();
}
size(): number {
return this.store.size;
}
}
// Use custom cache store
const customCache = {
mx: new MyCustomCache(),
disposable: new MyCustomCache(),
free: new MyCustomCache(),
domainValid: new MyCustomCache(),
smtp: new MyCustomCache(),
domainSuggestion: new MyCustomCache<{ suggested: string; confidence: number } | null>(),
whois: new MyCustomCache(),
};
const result = await verifyEmail({
emailAddress: 'user@example.com',
cache: customCache
});
`$3
Default cache TTL and size settings:
`typescript
import { DEFAULT_CACHE_OPTIONS } from '@emailcheck/email-validator-js';// TTL (Time To Live) in milliseconds
DEFAULT_CACHE_OPTIONS.ttl = {
mx: 3600000, // 1 hour
disposable: 86400000, // 24 hours
free: 86400000, // 24 hours
domainValid: 86400000, // 24 hours
smtp: 1800000, // 30 minutes
domainSuggestion: 86400000, // 24 hours
whois: 3600000, // 1 hour
};
// Maximum number of entries per cache type
DEFAULT_CACHE_OPTIONS.maxSize = {
mx: 500,
disposable: 1000,
free: 1000,
domainValid: 1000,
smtp: 500,
domainSuggestion: 1000,
whois: 200,
};
`
๐ Serverless Deployment
The package includes serverless adapters for major cloud platforms. The serverless implementation provides email validation without Node.js dependencies, making it suitable for edge computing environments.
$3
`javascript
import { apiGatewayHandler } from '@emailcheck/email-validator-js/serverless/aws';export const handler = apiGatewayHandler;
`$3
`javascript
import { edgeHandler } from '@emailcheck/email-validator-js/serverless/vercel';export const config = {
runtime: 'edge',
};
export default edgeHandler;
`$3
`javascript
import { workerHandler } from '@emailcheck/email-validator-js/serverless/cloudflare';export default {
async fetch(request, env, ctx) {
return workerHandler(request, env, ctx);
},
};
`$3
- โ
Syntax validation
- โ
Typo detection and domain suggestions
- โ
Disposable email detection (full database)
- โ
Free email provider detection (full database)
- โ
Batch processing
- โ
Built-in caching
- โ MX record validation (requires DNS)
- โ SMTP verification (requires TCP sockets)
For detailed serverless documentation and more platform examples, see docs/SERVERLESS.md.
๐ Performance & Caching
The library includes intelligent caching to improve performance:
| Cache Type | TTL | Description |
|------------|-----|-------------|
| MX Records | 1 hour | DNS MX record lookups |
| Disposable | 24 hours | Disposable email checks |
| Free Provider | 24 hours | Free email provider checks |
| Domain Valid | 24 hours | Domain validation results |
| SMTP | 30 minutes | SMTP verification results |
| Domain Suggestions | 24 hours | Domain typo suggestions |
$3
1. Use Batch Processing: For multiple emails, use
verifyEmailBatch() for parallel processing
2. Enable Caching: Caching is automatic and reduces repeated lookups by ~90%
3. Adjust Timeouts: Lower timeouts for faster responses, higher for accuracy
4. Skip SMTP: If you only need format/MX validation, skip SMTP for 10x faster results
5. Domain Suggestions: Cached for 24 hours to avoid recalculating similarity scores
6. Name Detection: Lightweight operation with minimal performance impact๐๏ธ Email Provider Databases
$3
View List - 5,000+ disposable email domains$3
View List - 1,000+ free email providers$3
Access the list of 70+ common email domains used for typo detection:`typescript
import { COMMON_EMAIL_DOMAINS } from '@emailcheck/email-validator-js';console.log(COMMON_EMAIL_DOMAINS);
// ['gmail.com', 'yahoo.com', 'outlook.com', 'hotmail.com', ...]
// Use with your own domain validation
const isCommon = COMMON_EMAIL_DOMAINS.includes('gmail.com'); // true
`Testing
Run the test suite:
`bash
yarn test
`Run with coverage:
`bash
yarn test --coverage
`Lint the code:
`bash
yarn lint
yarn lint-fix # Auto-fix issues
`Build the project:
`bash
yarn build
`Code Quality & Maintenance
$3
- โ
TypeScript Strict Mode: Full type safety with comprehensive type checking
- โ
ESLint + Biome: Automated code quality and formatting
- โ
Jest Test Suite: Comprehensive test coverage with 600+ test cases
- โ
CI/CD Pipeline: Automated testing and linting on all PRs
- โ
All Tests Pass: 615 tests passing, 1 skipped$3
- Naming Convention Migration: All enum values and constants now use camelCase for consistency with TypeScript/JavaScript conventions
- Async Code Fixes: Replaced forEach with for...of loops for proper async handling
- Import Standardization: Consistent ES6 imports across all files
- Mock Improvements: Enhanced Jest spy usage with proper cleanup
- Error Handling: Added null checks and better error boundaries
- File Organization: Split long test files and renamed for clarity
- Type Safety: Fixed enum usage and property naming consistency
- Documentation Updates: Comprehensive README with migration guide and updated examples$3
- Enum camelCase Migration: EmailProvider.GMAIL โ EmailProvider.gmail
- Error Code camelCase Migration: VerificationErrorCode.INVALID_FORMAT โ VerificationErrorCode.invalidFormat
- SMTP Step camelCase Migration: SMTPStep.GREETING โ SMTPStep.greeting
- Constants camelCase Migration: CHECK_IF_EMAIL_EXISTS_CONSTANTS.DEFAULT_TIMEOUT โ checkIfEmailExistsConstants.defaultTimeout$3
`
email-validator-js/
โโโ src/ # Source code
โ โโโ index.ts # Main entry point
โ โโโ smtp.ts # SMTP verification
โ โโโ dns.ts # DNS/MX lookups
โ โโโ validator.ts # Format validation
โ โโโ cache.ts # Caching system
โ โโโ batch.ts # Batch processing
โ โโโ types.ts # TypeScript types
โโโ __tests__/ # Test files (200+ tests)
โโโ examples/ # Usage examples (20+ files)
โโโ dist/ # Compiled output
`$3
`bash
yarn build # Build TypeScript with Rollup
yarn test # Run tests with Jest
yarn lint # Run Biome linting
yarn lint-fix # Auto-fix linting issues
yarn typecheck # Run TypeScript type checking
`$3
- Type Safety: Improved type inference reduces redundant type declarations
- Bundle Size: Optimized with tree-shaking and minification
- Performance: Faster builds with parallelized compilation
- Code Quality: Strict TypeScript mode with comprehensive type checkingContributing
We welcome contributions! Please feel free to open an issue or create a pull request and fix bugs or add features. All contributions are welcome!
$3
1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request$3
`bash
Clone the repo
git clone https://github.com/email-check-app/email-validator-js.git
cd email-validator-jsInstall dependencies
yarn installRun tests
yarn testBuild
yarn build
``For issues, questions, or commercial licensing:
๐ Open an Issue
๐ง Email Support
๐ Commercial License
๐ Visit email-check.app
The BSL allows use only for non-production purposes. Here's a comprehensive guide to help you understand when you need a commercial license:
| Use Case | Commercial License Required? | Details |
|----------|-----------|---------|
| Personal & Learning | | |
| ๐ฌ Exploring email-validator-js for research or learning | โ
No | Use freely for educational purposes |
| ๐จ Personal hobby projects (non-commercial) | โ
No | Build personal tools and experiments |
| ๐งช Testing and evaluation in development environment | โ
No | Test all features before purchasing |
| Development & Prototyping | | |
| ๐ก Building proof-of-concept applications | โ
No | Create demos and prototypes |
| ๐ ๏ธ Internal tools (not customer-facing) | โ
No | Use for internal development tools |
| ๐ Open source projects (non-commercial) | โ
No | Contribute to the community |
| Commercial & Production Use | | |
| ๐ฐ Revenue-generating applications | โ Yes | Any app that generates income |
| โ๏ธ Software as a Service (SaaS) products | โ Yes | Cloud-based service offerings |
| ๐ฆ Distributed commercial software | โ Yes | Software sold to customers |
| ๐ข Enterprise production systems | โ Yes | Business-critical applications |
| ๐ Forking for commercial purposes | โ Yes | Creating derivative commercial products |
| ๐ญ Production use in any form | โ Yes | Live systems serving real users |
| Specific Scenarios | | |
| ๐ Student projects and coursework | โ
No | Academic use is encouraged |
| ๐๏ธ CI/CD pipelines (for commercial products) | โ Yes | Part of commercial development |
| ๐ง Email validation in production APIs | โ Yes | Production service usage |
| ๐ E-commerce checkout validation | โ Yes | Revenue-related validation |
| ๐ฑ Mobile apps (free with ads or paid) | โ Yes | Monetized applications |
Ask yourself these questions:
1. Will real users interact with this in production? โ You need a license
2. Will this help generate revenue? โ You need a license
3. Is this for learning or testing only? โ No license needed
4. Is this an internal prototype or POC? โ No license needed
โจ Unlimited Usage - Use in all your production applications
๐ Priority Support - Direct support from our engineering team
๐ Regular Updates - Get the latest features and improvements
๐ก๏ธ Legal Protection - Full commercial rights and warranty
๐ข Enterprise Ready - Suitable for large-scale deployments
Ready to use email-validator-js in production?
๐๏ธ Purchase a License - Simple pricing, instant activation
๐ง Contact Sales - For enterprise or custom needs