Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devmehq/email-validator-js
Verify email address checking MX records, and SMTP connection, check for disposable email addresses and free email providers.
https://github.com/devmehq/email-validator-js
disposable-email email email-dns-validation email-validation free-email smtp spam validation
Last synced: 3 months ago
JSON representation
Verify email address checking MX records, and SMTP connection, check for disposable email addresses and free email providers.
- Host: GitHub
- URL: https://github.com/devmehq/email-validator-js
- Owner: devmehq
- License: mit
- Created: 2021-11-11T10:18:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T22:02:28.000Z (3 months ago)
- Last Synced: 2024-11-08T05:42:15.338Z (3 months ago)
- Topics: disposable-email, email, email-dns-validation, email-validation, free-email, smtp, spam, validation
- Language: TypeScript
- Homepage: https://dev.me/products/email
- Size: 3.39 MB
- Stars: 82
- Watchers: 2
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-opensource-email - email-validator-js - Verify email address checking MX records, and SMTP connection, check for disposable email addresses and free email providers. - `MIT`, `Typescript` (Deliverability / Email Verification)
README
# Advanced Email Validator
[](https://npm.im/@devmehq/email-validator-js)
[](https://github.com/devmehq/email-validator-js/actions)
[](https://www.npmjs.com/package/email-validator-js)
[](https://unpkg.com/browse/@devmehq/email-validator-js@latest/)
Verify email address checking MX records, and SMTP connection, check for disposable email addresses and free email providers.
## Features
✅ 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
🚨 Check domain age and quality score - _**soon**_
🚨 Check domain registration status - _**soon**_
## Use cases
- 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
## API / Cloud Hosted Service
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](https://dev.me/products/email)
## Self-hosting - installation and usage instructions
## Installation
Install the module through YARN:
```yarn
yarn add @devmehq/email-validator-js
```
Or NPM
```npm
npm install @devmehq/email-validator-js
```
## Examples
```typescript
import { verifyEmail } from '@devmehq/email-validator-js';
const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: '[email protected]', verifyMx: true, verifySmtp: true, timeout: 3000 });
// validFormat: true
// validMx: true
// validSmtp: true
```
When a domain does not exist or has no MX records, the domain validation will fail, and the mailbox validation will return `null` because it could not be performed:
```typescript
const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: '[email protected]', verifyMx: true, verifySmtp: true, timeout: 3000 });
// validFormat: true
// validMx: false
// validSmtp: null
```
A valid Yahoo domain will still return `validSmtp` true because their SMTP servers do not allow verifying if a mailbox exists.
## Configuration options
### `timeout`
Set a timeout in seconds for the smtp connection. Default: `10000`.
### `verifyMx`
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 records.
Default: `false`.
### `verifySmtp`
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 existence.
Default: `false`.
### Disposable email providers database ( ✅ Always Updated )
[Disposable email providers](./src/disposable-email-providers.json)
### Free email providers database ( ✅ Always Updated )
[Free email providers](./src/free-email-providers.json)
## Testing
```bash
yarn test
```
## Contributing
Please feel free to open an issue or create a pull request and fix bugs or add features, All contributions are welcome. Thank you!
## LICENSE [MIT](LICENSE.md)