{"_id":"kickbox","_rev":"30-0ed8d706ce4f5ef134ae05e825d2042b","name":"kickbox","time":{"modified":"2022-06-19T08:40:57.911Z","created":"2014-06-06T16:15:43.541Z","1.0.0":"2014-06-06T16:15:43.541Z","1.0.1":"2014-06-06T17:14:43.684Z","1.0.2":"2014-06-06T21:53:47.116Z","1.0.3":"2014-06-09T19:57:47.460Z","1.0.4":"2014-06-11T17:19:37.375Z","1.0.5":"2015-03-16T17:27:46.586Z","2.0.0":"2015-03-16T19:49:58.882Z","2.0.1":"2016-08-19T15:18:34.214Z","2.0.2":"2018-03-21T03:30:50.262Z","2.0.3":"2018-03-21T03:39:36.104Z","2.0.4":"2018-03-21T03:48:32.931Z"},"maintainers":[{"name":"danhstevens","email":"danhstevens@gmail.com"},{"name":"schaitanya","email":"chaitanyakrishnas@gmail.com"}],"dist-tags":{"latest":"2.0.4"},"description":"Official kickbox API library client for node.js","readme":"

\n \"Kickbox\n
\n

\n\n# Email Verification Library for Node.js\n\nKickbox determines if an email address is not only valid, but associated with a actual user. Uses include:\n\n* Preventing users from creating accounts on your applications using fake, misspelled, or throw-away email addresses.\n* Reducing bounces by removing old, invalid, and low quality email addresses from your mailing lists.\n* Saving money and projecting your reputation by only sending to real email users.\n\n## Getting Started\n\nTo begin, hop over to [kickbox.com](https://kickbox.com) and create a free account. Once you've signed up and logged in, click on **API Settings** and then click **Add API Key**. Take note of the generated API Key - you'll need it to setup the client as explained below.\n\n## Installation\n\nMake sure you have [npm](https://npmjs.org) installed.\n\n```bash\n$ npm install kickbox\n```\n\n#### Versions\n\nWorks with Node 0.8+\n\n## Usage\n\n```js\nvar kickbox = require('kickbox').client('Your_API_Key_Here').kickbox();\n\nkickbox.verify(\"test@example.com\", function (err, response) {\n // Let's see some results\n console.log(response.body);\n});\n```\n\n#### Options\n\n**timeout** `integer` (optional) - Maximum time, in milliseconds, for the API to complete a verification request. Default: 6000.\n\n```js\n// Example with options\nkickbox.verify(\"test@example.com\", {timeout: 6000}, function (err, response) {/*...*/});\n```\n\n### Response information\n\nA successful API call responds with the following values:\n\n* **result** `string` - The verification result: `deliverable`, `undeliverable`, `risky`, `unknown`\n* **reason** `string` - The reason for the result. Possible reasons are:\n * `invalid_email` - Specified email is not a valid email address syntax\n * `invalid_domain` - Domain for email does not exist\n * `rejected_email` - Email address was rejected by the SMTP server, email address does not exist\n * `accepted_email` - Email address was accepted by the SMTP server\n * `low_quality ` - Email address has quality issues that may make it a risky or low-value address\n * `low_deliverability ` - Email address appears to be deliverable, but deliverability cannot be guaranteed\n * `no_connect` - Could not connect to SMTP server\n * `timeout` - SMTP session timed out\n * `invalid_smtp` - SMTP server returned an unexpected/invalid response\n * `unavailable_smtp` - SMTP server was unavailable to process our request\n * `unexpected_error` - An unexpected error has occurred\n* **role** `true | false` - *true* if the email address is a role address (`postmaster@example.com`, `support@example.com`, etc)\n* **free** `true | false` - *true* if the email address uses a free email service like gmail.com or yahoo.com.\n* **disposable** `true | false` - *true* if the email address uses a *disposable* domain like trashmail.com or mailinator.com.\n* **accept_all** `true | false` - *true* if the email was accepted, but the domain appears to accept all emails addressed to that domain.\n* **did_you_mean** `null | string` - Returns a suggested email if a possible spelling error was detected. (`bill.lumbergh@gamil.com` -> `bill.lumbergh@gmail.com`)\n* **sendex** `float` - A quality score of the provided email address ranging between 0 (no quality) and 1 (perfect quality). More information on the Sendex Score can be found [here](https://docs.kickbox.com/v2.0/docs/the-sendex).\n* **email** `string` - Returns a normalized version of the provided email address. (`BoB@example.com` -> `bob@example.com`)\n* **user** `string` - The user (a.k.a local part) of the provided email address. (`bob@example.com` -> `bob`)\n* **domain** `string` - The domain of the provided email address. (`bob@example.com` -> `example.com`)\n* **success** `true | false` - *true* if the API request was successful (i.e., no authentication or unexpected errors occurred)\n\n### Response headers\n\nAlong with each response, the following HTTP headers are included:\n\n* `X-Kickbox-Balance` - Your remaining verification credit balance (Daily + On Demand).\n* `X-Kickbox-Response-Time` - The elapsed time (in milliseconds) it took Kickbox to process the request.\n\n## License\nMIT\n\n## Bug Reports\nReport [here](https://github.com/kickboxio/kickbox-node/issues).\n\n## Need Help?\nhelp@kickbox.com\n","versions":{"1.0.1":{"name":"kickbox","version":"1.0.1","description":"Official kickbox API library client for node.js","author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.io","url":"https://github.com/kickboxio"},"homepage":"https://kickbox.io","keywords":["email","validation","kickbox"],"repository":{"type":"git","url":"https://github.com/kickboxio/kickbox-node"},"main":"./lib/index.js","dependencies":{"request":"2.x.x"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","engines":{"node":">= 0.8.0"},"_id":"kickbox@1.0.1","dist":{"shasum":"6a96776d0526af17191ad7d4a1b5b44655c376ab","tarball":"https://registry.npmjs.org/kickbox/-/kickbox-1.0.1.tgz","integrity":"sha512-/9Lh9hIHcTuxcFw6XURGLDXM3zOMkvow+NdXVtSUMdi3kXRbLBjI6bYxnRknHrapgzm9BLApO6fOIWik4Yb8xw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCeUkCOaD5aZLz6Con0KZa8Fd2X+j7Tznv1l1OW+HLi0AIhAOV1ug8U1y7YsvkWanQfD4Vv7V+kClQDB3XTmLekg+9v"}]},"_from":".","_npmVersion":"1.3.25","_npmUser":{"name":"schaitanya","email":"chaitanya@sal.tt"},"maintainers":[{"name":"schaitanya","email":"chaitanya@sal.tt"}],"directories":{}},"1.0.5":{"name":"kickbox","version":"1.0.5","description":"Official kickbox API library client for node.js","author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.io","url":"https://github.com/kickboxio"},"homepage":"http://kickbox.io","keywords":["free","email","validation","kickbox","service","verification","sendex"],"repository":{"type":"git","url":"https://github.com/kickboxio/kickbox-node"},"main":"./lib/index.js","dependencies":{"request":"2.x.x"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","engines":{"node":">= 0.8.0"},"gitHead":"07b8392d09dbe1fd4904f0f8de0eb67ed20ab779","_id":"kickbox@1.0.5","scripts":{},"_shasum":"5633a47559c2b8fb56eca011d362ad78571b7737","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"schaitanya","email":"chaitanyakrishnas@gmail.com"},"maintainers":[{"name":"schaitanya","email":"chaitanya@sal.tt"}],"dist":{"shasum":"5633a47559c2b8fb56eca011d362ad78571b7737","tarball":"https://registry.npmjs.org/kickbox/-/kickbox-1.0.5.tgz","integrity":"sha512-UuH3twmmUYD+L/wFPN88Xd8z6uV90D9cgzVi3fG1aImR9Ch+xKemAWK31aw2GxHBbYDuLcrVB20ImZGJaP8gog==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICag8SJU8dUYAtfmTSHvtKxaBzUV64FXOLyQN2r2erfDAiBODR8quHutVkvfzMyjrv32XIFQqxMdpiSPds99VHdGTA=="}]},"directories":{}},"2.0.0":{"name":"kickbox","version":"2.0.0","description":"Official kickbox API library client for node.js","author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.io","url":"https://github.com/kickboxio"},"homepage":"http://kickbox.io","keywords":["free","email","validation","kickbox","service","verification","sendex"],"repository":{"type":"git","url":"https://github.com/kickboxio/kickbox-node"},"main":"./lib/index.js","dependencies":{"request":"2.x.x"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","engines":{"node":">= 0.8.0"},"gitHead":"abfd39b633fadf78f12accfe1e3c54a31cde4d61","_id":"kickbox@2.0.0","scripts":{},"_shasum":"e88a00a86407493c8a1ab3382ab3f8c4c3831e5c","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"schaitanya","email":"chaitanyakrishnas@gmail.com"},"maintainers":[{"name":"schaitanya","email":"chaitanya@sal.tt"}],"dist":{"shasum":"e88a00a86407493c8a1ab3382ab3f8c4c3831e5c","tarball":"https://registry.npmjs.org/kickbox/-/kickbox-2.0.0.tgz","integrity":"sha512-EKzH39nfvkYYeOQPK0liezIuFh426XwjJnap2Z69vuP/m96OFodyK1YzFnropyzlyVeDNAJAUK15NGFsjVhFXw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDrOJEKFk4KihVnCVDxeSM1k24Ztdgis4XyJlyyHj6ehQIhAJZNx0KrzBqpUx7r7PMv2XKNf2IqRoy0f9ahDsXVQzT5"}]},"directories":{}},"2.0.1":{"name":"kickbox","version":"2.0.1","description":"Official kickbox API library client for node.js","author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.io","url":"https://github.com/kickboxio"},"homepage":"http://kickbox.io","keywords":["free","email","validation","kickbox","service","verification","sendex"],"repository":{"type":"git","url":"git+https://github.com/kickboxio/kickbox-node.git"},"main":"./lib/index.js","dependencies":{"request":"2.x.x"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","engines":{"node":">= 0.8.0"},"gitHead":"a4ded6ddd9d55be14469af1e94506fc2b0365798","_id":"kickbox@2.0.1","scripts":{},"_shasum":"a6a2f925f565b5f57f83dc9c658c1afd652b04d0","_from":".","_npmVersion":"2.15.4","_nodeVersion":"4.4.6","_npmUser":{"name":"schaitanya","email":"chaitanyakrishnas@gmail.com"},"dist":{"shasum":"a6a2f925f565b5f57f83dc9c658c1afd652b04d0","tarball":"https://registry.npmjs.org/kickbox/-/kickbox-2.0.1.tgz","integrity":"sha512-grtsZTk86iunBCxlNjzVF0Qbpo34qYKTAGp/eal4tdeah64Lzm0T6OrE+vYiqlibEM797QJ3MYE21vEM18czeQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDe95LG4HVyU9H90YwHpMgIG6zCiUULhObpnRyL4frVkAIgFptCfk7h0XI/zbSRnff4qYklduPiKq7yAHFFlxRSI3o="}]},"maintainers":[{"name":"schaitanya","email":"chaitanya@sal.tt"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/kickbox-2.0.1.tgz_1471619912986_0.4586370119359344"},"directories":{}},"2.0.4":{"name":"kickbox","version":"2.0.4","description":"Official kickbox API library client for node.js","author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.com","url":"https://github.com/kickboxio"},"homepage":"http://kickbox.com","keywords":["free","email","validation","kickbox","service","verification","sendex"],"repository":{"type":"git","url":"git+https://github.com/kickboxio/kickbox-node.git"},"main":"./lib/index.js","dependencies":{"request":"2.x.x"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","engines":{"node":">= 0.8.0"},"gitHead":"38dd4bd998774ab5c795ad4a87b71a04cef1c7e1","_id":"kickbox@2.0.4","_npmVersion":"5.7.1","_nodeVersion":"8.9.3","_npmUser":{"name":"danhstevens","email":"danhstevens@gmail.com"},"dist":{"integrity":"sha512-qprEfo8LAHLb+iWoEQ2tA7uPFnfq0rf3A0mHK6ndcejGtEwWgPnzT8BqSoTEUEEs/+TW6eQQLzLTB5CpFJ9UtQ==","shasum":"8aee3c70ead835b80eb7374a4338c1bce3ec4961","tarball":"https://registry.npmjs.org/kickbox/-/kickbox-2.0.4.tgz","fileCount":13,"unpackedSize":14755,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC1NYJfFyx/HITwsgkxp7W21a8yLGIHR1ZgdXfTjXOCxAIhAJrc/Jz2hOskrv/V1thHiN6kKE7rw52eY3h80ejyZDM0"}]},"maintainers":[{"name":"danhstevens","email":"danhstevens@gmail.com"},{"name":"schaitanya","email":"chaitanyakrishnas@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kickbox_2.0.4_1521604112868_0.51741043020523"},"_hasShrinkwrap":false}},"homepage":"http://kickbox.com","keywords":["free","email","validation","kickbox","service","verification","sendex"],"repository":{"type":"git","url":"git+https://github.com/kickboxio/kickbox-node.git"},"author":{"name":"Chaitanya Surapaneni","email":"chaitanya.surapaneni@kickbox.com","url":"https://github.com/kickboxio"},"bugs":{"url":"https://github.com/kickboxio/kickbox-node/issues"},"license":"MIT","readmeFilename":"README.md","users":{"schaitanya":true,"otothea":true}}