A comprehensive TypeScript/JavaScript library for detecting generic email addresses and extracting metadata such as department, seniority, and position information. This package contains a curated list of over 27,000 generic email patterns found on the web.
- Check if an email address is generic (e.g., info@, contact@, support@)
- Validate email address format
- Extract department information (engineering, sales, hr, etc.)
- Identify seniority level (junior, senior, executive)
- Determine position type
- Extensive database of 27,000+ generic email patterns
- TypeScript support with full type definitions
- Works in Node.js and browsers
- Zero dependencies (runtime)
npm install generic-emailsor using yarn:
yarn add generic-emailsconst { GenericEmail } = require('generic-emails')
// Check if an email is generic
const result = await GenericEmail.isGeneric('info@company.com')
console.log(result)
// Output:
// {
// email: 'info@company.com',
// isgeneric: true,
// department: null,
// position: null,
// seniority: null
// }The main functionality is to determine if an email address is generic and retrieve associated metadata:
const { GenericEmail } = require('generic-emails');
async function checkEmail() {
const result = await GenericEmail.isGeneric('sales@company.com');
if (result.isgeneric) {
console.log('This is a generic email');
console.log('Department:', result.department);
console.log('Position:', result.position);
console.log('Seniority:', result.seniority);
} else {
console.log('This is a personal email');
}
}
checkEmail();
```### Email Validation
Validate email addresses and detect hash-based patterns:
```javascript
const { Emails } = require('generic-emails');
try {
const isValid = Emails.validate('user@example.com');
console.log('Email is valid:', isValid);
} catch (error) {
console.error('Invalid email:', error.message);
}Validate department names against supported types:
const { Department } = require('generic-emails')
const isValid = Department.validate('engineering')
console.log('Valid department:', isValid)Supported departments: engineering, sales, finance, it, hr, marketing, operations, management, executive, legal, support, communication, software, security, pr, warehouse, diversity, administrative, facilities, accounting
Check seniority levels:
const { Seniority } = require('generic-emails')
const isValid = Seniority.validate('senior')
console.log('Valid seniority:', isValid)Supported seniority levels: junior, senior, executive
The library is written in TypeScript and includes full type definitions:
import { GenericEmail, GenericData, Email } from 'generic-emails'
import { Departmentname } from 'generic-emails'
import { Seniorityname } from 'generic-emails'
async function checkGenericEmail(email: string): Promise<GenericData> {
const result = await GenericEmail.isGeneric(email)
return result
}
// Use type-safe department names
const department: Departmentname = 'engineering'
// Use type-safe seniority names
const seniority: Seniorityname = 'senior'Checks if an email address is generic and returns metadata.
Parameters:
email(string): The email address to check (can be full email or just the local part)
Returns: Promise<GenericData>
interface GenericData {
email?: string
isgeneric?: boolean
department?: string
position?: string
seniority?: string
}Validates an email address format and checks for hash-based patterns.
Parameters:
email(string): The email address to validate
Returns: boolean - Returns true if valid, throws error if invalid
Validates a department name.
Parameters:
name(Departmentname): The department name to validate
Returns: boolean
Validates a seniority level.
Parameters:
name(Seniorityname): The seniority level to validate
Returns: boolean
Check out the examples directory for more detailed usage examples:
- Basic Usage - Simple generic email checking
- Validation - Email, department, and seniority validation
- TypeScript Usage - Using with TypeScript
- Batch Processing - Processing multiple emails
The package includes a comprehensive emails.json file containing over 27,000 generic email patterns collected from the web. Each entry may include:
- Email pattern (local part before @)
- Department classification
- Position information
- Seniority level
- Lead Qualification: Filter out generic emails to focus on personal contacts
- Email List Cleaning: Remove generic addresses from marketing campaigns
- Contact Discovery: Identify department-specific emails for targeted outreach
- Data Enrichment: Add department and seniority metadata to email addresses
- Form Validation: Encourage users to provide personal rather than generic emails
We welcome contributions! Here's how you can help:
- Fork it (https://github.com/tomba-io/generic-emails/fork)
- Create your feature branch (
git checkout -b my-new-email) - Add generic emails to
emails.jsonwith appropriate metadata - Run jq command to sort emails.json (
jq -S . emails.json > temp.json && mv temp.json emails.json) - Run tests to ensure everything works (
npm test) - Commit your changes (
git commit -am 'Add new email patterns') - Push to the branch (
git push origin my-new-email) - Create a new Pull Request
When adding new entries to emails.json, please follow this format:
{
"email": "support",
"department": "support",
"position": "support",
"seniority": null
}- Node.js >= 16.x
- TypeScript >= 3.0 (for development)
- Mohamed Ben - creator and maintainer
- abedrahim - maintainer
MIT License - see the LICENSE file for details
- Tomba.io - Email Finder and Verification API
For questions and support, please open an issue on GitHub.