getinbox

---

getinbox is maintained by Getinbox - simple, fast and free online email finder tools.

---

✅ Email finder & verifier for Node.js

• Find anyone's professional email address with 99% accuracy
• Verify email deliverability without sending test emails
• Detect disposable email addresses
• Double-verifies catch-all mailboxes
• Full TypeScript support with detailed type definitions

Installation

npm install getinbox

Quick Start

import { Getinbox } from 'getinbox';

// Initialize the client
const getinbox = new Getinbox({
  apiKey: 'your_api_key', // or set GETINBOX_API_KEY env variable
});

// Find an email address
const { email } = await getinbox.emails.find({
  name: 'Elon Musk',
  company: 'spacex.com', // Using domain instead of company name provides better accuracy
});

// Verify an email address
const { isValid } = await getinbox.emails.verify({
  email: '[e-mail]',
});

Requirements

• Node.js 14 or later
• TypeScript 4.7 or later (optional)

API Reference

Authentication

Sign up for a free API key at 👉 getinbox.co/dashboard/api-key.

You can provide your API key in two ways:

1. Pass it when initializing the client:

const getinbox = new Getinbox({ apiKey: 'your_api_key' });

2. Set it as an environment variable:

export GETINBOX_API_KEY=your_api_key
const getinbox = new Getinbox(); // Will use GETINBOX_API_KEY env variable

Finding Email Addresses

Find someone's email address using their name and company information:

const response = await getinbox.emails.find({
  name: 'John Doe', // Full name of the person
  company: 'acme.com', // Company domain (preferred) or name
});

console.log(response.email); // => '[e-mail]'

Verifying Email Addresses

Verify if an email address exists and is deliverable:

const response = await getinbox.emails.verify({
  email: '[e-mail]',
});

console.log(response.isValid); // => true/false

Features in Detail

Email Finder

• Discovers professional email addresses with 99% accuracy
• Uses advanced pattern matching and verification
• Cleans and formats input data automatically
• Real-time verification of found emails

Email Verifier

• Validates email existence without sending test emails
• Checks syntax, domain validity, and mailbox existence
• Detects disposable email addresses
• Identifies catch-all domains
• Helps maintain sender reputation by preventing bounces

Error Handling

The SDK throws descriptive errors for invalid API keys, failed requests, and API errors:

try {
  const response = await getinbox.emails.find({
    name: 'John Doe',
    company: 'acme.com',
  });
} catch (error) {
  console.error('Error finding email:', error.message);
}

TypeScript Support

The SDK is written in TypeScript and provides comprehensive type definitions:

import {
  GetinboxOptions,
  FindEmailOptions,
  VerifyEmailOptions,
} from 'getinbox';

// All options are fully typed
const options: FindEmailOptions = {
  name: 'John Doe',
  company: 'acme.com',
};

Types

GetinboxOptions

Property	Type	Description	Required
apiKey	string	Your Getinbox API key	false (if set via env var)

FindEmailOptions

Property	Type	Description	Required
name	string	Full name of the person	true
company	string	Company domain or name	true

VerifyEmailOptions

Property	Type	Description	Required
email	string	Email address to verify	true

License

Distributed under the MIT License. See LICENSE for more information.

Links

If you need support please contact us at 👉 [e-mail]

• Getinbox Website
• API Key Signup
• OpenAPI Schema