{"id":13624068,"url":"https://github.com/reacherhq/reacher-js","last_synced_at":"2025-04-15T20:33:10.160Z","repository":{"id":36990555,"uuid":"272188195","full_name":"reacherhq/reacher-js","owner":"reacherhq","description":"TypeScript wrapper library over Reacher API","archived":false,"fork":false,"pushed_at":"2025-03-09T21:55:53.000Z","size":765,"stargazers_count":25,"open_issues_count":5,"forks_count":18,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-10T14:19:59.760Z","etag":null,"topics":["email","email-validation","email-verification"],"latest_commit_sha":null,"homepage":"https://reacher.email","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reacherhq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"amaurym","custom":"https://www.paypal.me/amaurym10/20"}},"created_at":"2020-06-14T11:27:33.000Z","updated_at":"2025-03-09T21:55:58.000Z","dependencies_parsed_at":"2023-12-08T17:26:30.246Z","dependency_job_id":"ade1b76d-5ca5-4cc2-9e70-cd9a7a592873","html_url":"https://github.com/reacherhq/reacher-js","commit_stats":{"total_commits":202,"total_committers":4,"mean_commits":50.5,"dds":0.4554455445544554,"last_synced_commit":"fd2a083dafb5aa557910075e481363a16aa852bd"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reacherhq%2Freacher-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reacherhq%2Freacher-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reacherhq%2Freacher-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reacherhq%2Freacher-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reacherhq","download_url":"https://codeload.github.com/reacherhq/reacher-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249148293,"owners_count":21220510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email","email-validation","email-verification"],"created_at":"2024-08-01T21:01:38.498Z","updated_at":"2025-04-15T20:33:09.777Z","avatar_url":"https://github.com/reacherhq.png","language":"TypeScript","funding_links":["https://github.com/sponsors/amaurym","https://www.paypal.me/amaurym10/20","https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026link=https://github.com/sponsors/amaurym"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cbr /\u003e\u003cbr /\u003e\n\n\u003ch1 align=\"center\"\u003e@reacherhq/api\u003c/h1\u003e\n\u003ch4 align=\"center\"\u003eCheck if an email address exists without sending any email.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@reacherhq/api\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/@reacherhq/api.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/reacherhq/reacher-js/actions\"\u003e\n    \u003cimg alt=\"Github Actions\" src=\"https://github.com/reacherhq/reacher-js/workflows/pr/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\n    \u003cimg alt=\"Apache-2.0\" src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/sponsors/amaurym\"\u003e\n  \t\u003cimg alt=\"Github Sponsor\" src=\"https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026link=https://github.com/sponsors/amaurym\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\u003cbr /\u003e\n\n## What is it?\n\nCheck if an email address exists without sending any email.\n\n`@reacherhq/api` is a thin TypeScript wrapper around the [Reacher Email Verification API](https://reacher.email). Reacher is a 100% open-source SaaS, written in Rust. It's also free for personal use, and the API token in `@reacherhq/api` is optional, but without it the requests will be rate-limited to 50 per month.\n\n## Usage\n\nInstall the package:\n\n```bash\nyarn add @reacherhq/api # Or npm install @reacherhq/api\n```\n\nThere are two ways to use the library: by sending single API requests, or by using batch verification (parallel queue).\n\n### 1. Single Email Verification\n\n```typescript\nimport { checkSingle } from '@reacherhq/api';\n\ncheckSingle(\n\t{ to_email: 'someone@gmail.com' },\n\t{\n\t\t// Required.\n\t\tapiToken: '\u003cYOUR_TOKEN\u003e',\n\t}\n).then(console.log); // Output will be the JSON described in the \"JSON Output\" section below.\n```\n\n### 2. Batch Email Verification\n\n```typescript\nimport { batchQueue } from '@reacherhq/api';\n\n// Create a queue for email verifications.\nconst q = batchQueue({\n\t// Required.\n\tapiToken: '\u003cYOUR_TOKEN\u003e',\n\t// Optional, callback to call on each successful verification.\n\tonSuccessSingle: (result) =\u003e {\n\t\tconsole.log(\n\t\t\t`Verified email ${result.input}: the result is ${result.is_reachable}.`\n\t\t);\n\t},\n});\n\n// Push some data into the queue. The email verification will start as soon as\n// it's in the queue. The queue has a default concurrency of 100.\nq.push({ to_email: 'someone1@gmail.com' });\nq.push({ to_email: 'someone2@gmail.com' }, { to_email: 'someone3@gmail.com' });\n\n// Perform some action when the queue is drained.\nq.drain(() =\u003e {\n\tconsole.log('Finished processing all items.');\n});\n```\n\n## JSON Output\n\nThe output will be a JSON with the below format, the fields should be self-explanatory. For `someone@gmail.com` (note that it is disabled by Gmail), here's the exact output:\n\n```json\n{\n\t\"input\": \"someone@gmail.com\",\n\t\"is_reachable\": \"invalid\",\n\t\"misc\": {\n\t\t\"is_disposable\": false,\n\t\t\"is_role_account\": false\n\t},\n\t\"mx\": {\n\t\t\"accepts_mail\": true,\n\t\t\"records\": [\n\t\t\t\"alt3.gmail-smtp-in.l.google.com.\",\n\t\t\t\"gmail-smtp-in.l.google.com.\",\n\t\t\t\"alt1.gmail-smtp-in.l.google.com.\",\n\t\t\t\"alt4.gmail-smtp-in.l.google.com.\",\n\t\t\t\"alt2.gmail-smtp-in.l.google.com.\"\n\t\t]\n\t},\n\t\"smtp\": {\n\t\t\"can_connect_smtp\": true,\n\t\t\"has_full_inbox\": false,\n\t\t\"is_catch_all\": false,\n\t\t\"is_deliverable\": false,\n\t\t\"is_disabled\": true\n\t},\n\t\"syntax\": {\n\t\t\"domain\": \"gmail.com\",\n\t\t\"is_valid_syntax\": true,\n\t\t\"username\": \"someone\"\n\t}\n}\n```\n\nYou can also take a look at the [OpenAPI v3 specification](https://help.reacher.email/rest-api-documentation) of this JSON object.\n\n## License\n\nThe source code is available under the Apache-2.0 license. See the [LICENSE](./LICENSE) file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freacherhq%2Freacher-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freacherhq%2Freacher-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freacherhq%2Freacher-js/lists"}