Skip to content

Commit

Permalink
Add usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
nemuelw committed Mar 16, 2024
1 parent bc1140b commit 7b16ae2
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,54 @@ Node.js library for the EmailRep API
## Installation

```bash
npm i emtraq
npm install emailrep
```

## Usage

Example:

```javascript
const emailrep = require('emailrep')

getEmailRep('[email protected]')
.then(result => {
if (result.success) {
console.log(result.details)
} else {
console.log(result.error))
}
})
.catch(error => console.error('Error:', error))
```

Output:

```bash
{
blacklisted: false,
malicious_activity: false,
malicious_activity_recent: false,
credentials_leaked: true,
credentials_leaked_recent: false,
data_breach: true,
first_seen: '07/01/2008',
last_seen: '01/16/2024',
domain_exists: true,
domain_reputation: 'high',
new_domain: false,
days_since_domain_creation: 12006,
suspicious_tld: false,
spam: false,
free_provider: false,
disposable: false,
deliverable: true,
accept_all: false,
valid_mx: true,
primary_mx: 'microsoft-com.mail.protection.outlook.com',
spoofable: false,
spf_strict: true,
dmarc_enforced: true,
profiles: [ 'linkedin', 'twitter' ]
}
```

0 comments on commit 7b16ae2

Please sign in to comment.