Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
emailable
Advanced tools
Readme
This is the official node wrapper for the Emailable API.
See the Node API docs.
Install the package with:
npm install emailable --save
# or
yarn add emailable
The library needs to be configured with your account's API key which is available in your Emailable Dashboard. Require it with your API key:
// require with API key
var emailable = require('emailable')('live_...')
// ES6 import
import Emailable from 'emailable';
const emailable = Emailable('live_...');
// verify an email address
emailable.verify('jarrett@emailable.com')
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
You can also pass any of the additional
options
as a second parameter to verify
.
emailable.verify('jarrett@emailable.com', { timeout: 10 })
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
Some email servers are slow to respond. As a result the timeout may be reached before we are able to complete the verification process. If this happens, the verification will continue in the background on our servers. We recommend sleeping for at least one second and trying your request again. Re-requesting the same verification with the same options will not impact your credit allocation within a 5 minute window.
{
message: 'Your request is taking longer than normal. Please send your request again.'
}
var emails = ['jarrett@emailable.com', 'support@emailable.com', ...]
emailable.batches.verify(emails)
.then(function (response) {
console.log(response.id);
});
You can also pass any of the additional
options
as a second parameter to verify
.
emailable.batches.verify(emails, { url: 'https://emailable.com/' }).
then(function (response) {
console.log(response.id);
});
Calling batches.status
with the batch id will return the batch's status.
This will also return the results once the batch is complete.
var id = '5cfcbfdeede34200693c4319'
emailable.batches.status(id)
.then(function (response) {
console.log(response);
});
Run all tests:
$ yarn install
$ yarn test
If you do not have yarn
installed, you can get it with npm install --global yarn
.
Run a single test suite without a coverage report:
$ yarn test test/verify.spec.js
Bug reports and pull requests are welcome on GitHub at https://github.com/emailable/emailable-node.
FAQs
Email Verification that's astonishingly easy and low-cost. See https://emailable.com for details.
The npm package emailable receives a total of 486 weekly downloads. As such, emailable popularity was classified as not popular.
We found that emailable demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.