# @withe/is-free-email

> A utility to check if an email is registered from a free provider

Latest version **0.1.2** (published 2023-08-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install @withe/is-free-email
pnpm add @withe/is-free-email
yarn add @withe/is-free-email
bun add @withe/is-free-email
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2023-08-25 |
| First published | 2022-04-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 101.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Withe, Inc. |
| Maintainers | liamross |

## Links

- npm: https://www.npmjs.com/package/@withe/is-free-email
- npm.io page: https://npm.io/package/@withe/is-free-email

## Recent versions

- 0.1.2 (latest) — 2023-08-25
- 0.1.1 — 2023-08-25
- 0.1.0 — 2022-04-07

## README

# Is Free Email

A utility function to check if an email address matches a free email provider.

## Usage

### JavaScript

```js
import isFreeEmail from '@withe/is-free-email';

const expectTrue = isFreeEmail('someone@gmail.com'); // Returns true
const expectFalse = isFreeEmail('someone@acme.com'); // Returns false
```

### Go

This package also provides a Go implementation.

```go
package main

import "github.com/withevideo/email"

var expectTrue, _ = email.IsFree("someone@gmail.com"); // Returns true
var expectFalse, _ = email.IsFree("someone@acme.com"); // Returns false

var _, err = email.IsFree("this_seems_bad"); // err === "invalid email address"
```

## Contributing

### Generating `freemail.json`

```console
$ npm run generate
```

### Testing

```console
$ npm run test
```

### Building

```console
$ npm run build
```

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