EmailHunter | hunter.io

A unofficial Hunter.io nodejs client

Hierarchy

HunterClient
- EmailHunter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EmailHunter(key: string, opts?: AxiosRequestConfig): EmailHunter

Overrides HunterClient.constructor
- Defined in index.ts:33
Parameters
- key: string
- Optional opts: AxiosRequestConfig
Returns EmailHunter

Properties

Protected apiKey

apiKey: string

endpoint

endpoint: string = "https://api.hunter.io/v2"

Protected instance

instance: AxiosInstance

leads

leads: Leads

Child class used to manage account leads

leadsList

leadsList: LeadsList

Child class used to manage account leads lists

Methods

account

account(): Promise<AccountResponse>
account(callback: Callback<AccountResponse>): void

- Defined in index.ts:168
This API endpoint enables you to get information regarding your Hunter account at any time.

Returns Promise<AccountResponse>
- Defined in index.ts:170
This API endpoint enables you to get information regarding your Hunter account at any time.

Parameters
- callback: Callback<AccountResponse>
Returns void

domainSearch

domainSearch(options: DomainSearchOptions): Promise<DomainSearchResponse>
domainSearch(options: DomainSearchOptions, callback: Callback<DomainSearchResponse>): void

- Defined in index.ts:141
One key feature of Hunter is to search all the email addresses corresponding to one website. You give one domain name and it returns all the email addresses using this domain name found on the internet.

Parameters
- options: DomainSearchOptions
Returns Promise<DomainSearchResponse>
- Defined in index.ts:143
One key feature of Hunter is to search all the email addresses corresponding to one website. You give one domain name and it returns all the email addresses using this domain name found on the internet.

Parameters
- options: DomainSearchOptions
- callback: Callback<DomainSearchResponse>
Returns void

emailCount

emailCount(domain: string | EmailCountOptions): Promise<EmailCountResponse>
emailCount(domain: string | EmailCountOptions, callback: Callback<EmailCountResponse>): void

- Defined in index.ts:107
This API endpoint allows you to know how many email addresses we have for one domain. It's free and doesn't require authentication.

Parameters
- domain: string | EmailCountOptions
Returns Promise<EmailCountResponse>
- Defined in index.ts:109
This API endpoint allows you to know how many email addresses we have for one domain. It's free and doesn't require authentication.

Parameters
- domain: string | EmailCountOptions
- callback: Callback<EmailCountResponse>
Returns void

emailFinder

emailFinder(options: EmailFinderOptions): Promise<EmailFinderResponse>
emailFinder(options: EmailFinderOptions, callback: Callback<EmailFinderResponse>): void

- Defined in index.ts:56
This API endpoint generates the most likely email address from a domain name, a first name and a last name.

Parameters
- options: EmailFinderOptions
Returns Promise<EmailFinderResponse>
- Defined in index.ts:58
This API endpoint generates the most likely email address from a domain name, a first name and a last name.

Parameters
- options: EmailFinderOptions
- callback: Callback<EmailFinderResponse>
Returns void

emailVerifier

emailVerifier(email: string): Promise<EmailVerifierResponse>
emailVerifier(email: string, callback: Callback<EmailVerifierResponse>): void

- Defined in index.ts:85
This API endpoint allows you to verify the deliverability of an email address.

Parameters
- email: string
Returns Promise<EmailVerifierResponse>
- Defined in index.ts:87
This API endpoint allows you to verify the deliverability of an email address.

Parameters
- email: string
- callback: Callback<EmailVerifierResponse>
Returns void

Protected run

run(__namedParameters: object): Promise<any>

Inherited from HunterClient.run
- Defined in client.ts:44
Call the Hunter.io api internally with specified options. This method is not supposed to use directly.

Parameters
- __namedParameters: object
  - action: string
  - callback: any
  - id: undefined | string | number
  - options: any
  - type: string
Returns Promise<any>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

key: string

Optional opts: AxiosRequestConfig

Returns EmailHunter

Properties

Protected apiKey

endpoint

Protected instance

leads

leadsList

Methods

account

Returns Promise<AccountResponse>

Parameters

callback: Callback<AccountResponse>

Returns void

domainSearch

Parameters

options: DomainSearchOptions

Returns Promise<DomainSearchResponse>

Parameters

options: DomainSearchOptions

callback: Callback<DomainSearchResponse>

Returns void

emailCount

Parameters

domain: string | EmailCountOptions

Returns Promise<EmailCountResponse>

Parameters

domain: string | EmailCountOptions

callback: Callback<EmailCountResponse>

Returns void

emailFinder

Parameters

options: EmailFinderOptions

Returns Promise<EmailFinderResponse>

Parameters

options: EmailFinderOptions

callback: Callback<EmailFinderResponse>

Returns void

emailVerifier

Parameters

email: string

Returns Promise<EmailVerifierResponse>

Parameters

email: string

callback: Callback<EmailVerifierResponse>

Returns void

Protected run

Parameters

__namedParameters: object

action: string

callback: any

id: undefined | string | number

options: any

type: string

Returns Promise<any>