Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
duhow authored Oct 24, 2024
1 parent 4defbd5 commit 43a8c8e
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Mail Checker
# 📨 Mail Checker

A small Flask application to check the email provided, return score and determine if it's valid or not.

This app can detect:

* common pattern typos and make domain suggestions (eg. `gemail.com`)
* some **Disposable Email Addresses** (DEA) - aka temporal emails
* domains used on public email services
* domains that do not exist (checks DNS records) or cannot receive emails

### Usage

Call endpoint `GET /[email protected]` or `POST /check` with JSON `{"email": "[email protected]"}`.

Alternatively, execute `app.py [email protected]` to check one single address.

```sh
curl -H "Content-Type: application/json" --data '{"email": "[email protected]"}' localhost:5000/check
curl -H "Content-Type: application/json" localhost:5000/check --data '{"email": "[email protected]"}'
```

```json
Expand All @@ -20,4 +29,4 @@ curl -H "Content-Type: application/json" --data '{"email": "[email protected]"
"score": 0,
"valid": false
}
```
```

0 comments on commit 43a8c8e

Please sign in to comment.