# email-chk

> Check if an email exists

Latest version **1.0.2** (published 2017-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install email-chk
pnpm add email-chk
yarn add email-chk
bun add email-chk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-09-23 |
| First published | 2017-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Brandon Smith |
| Maintainers | brandon93s |
| Keywords | email, check email, verify email, email exists, is real email, email is real |

## Links

- npm: https://www.npmjs.com/package/email-chk
- Repository: https://github.com/brandon93s/email-chk
- Homepage: https://github.com/brandon93s/email-chk#readme
- Issues: https://github.com/brandon93s/email-chk/issues
- npm.io page: https://npm.io/package/email-chk

## Dependencies (2)

- [pify](https://npm.io/package/pify.md) ^3.0.0
- [email-regex](https://npm.io/package/email-regex.md) ^1.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2017-09-23
- 1.0.1 — 2017-09-23
- 1.0.0 — 2017-09-17

## README

# email-chk [![Build Status](https://travis-ci.org/brandon93s/email-chk.svg?branch=master)](https://travis-ci.org/brandon93s/email-chk)

> Checks if an email is valid & real by contacting the associated remote mail server  :email:

*See [email-chk-cli](https://github.com/brandon93s/email-chk-cli) for the command-line tool.*
## Install

```
$ npm install --save email-chk

```


## Usage

```js
const emailChk = require('email-chk')

try {
  const exists = await emailChk('test@example.com')
} 
catch (e) {
  // connection refused or server error occurred
}

// or
emailChk('test@example.com')
  .then(console.log)
  .catch(console.error)
```


## API

### emailChk(email [,options])

Returns a `boolean` representing if the email is valid & real

#### email

Type: `string`

The email to verify and check existence for


#### options

##### timeout

Type: `number`<br>
Default: `5000`

The [idle timeout](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) in ms for the socket performing requests 

##### host

Type: `string` <br>
Default: domain of `email`

The domain of the originating SMTP server for the request

##### from

Type: `string` <br>
Default: `email`

The originating email for the request

## Related

- [email-chk-cli](https://github.com/brandon93s/email-chk-cli) - CLI for this module 

## License

MIT © [Brandon Smith](https://github.com/brandon93s)

---
_Source: https://npm.io/package/email-chk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._