{"id":18728733,"url":"https://github.com/rubyonworld/kickbox-ruby","last_synced_at":"2026-04-17T01:02:50.671Z","repository":{"id":174007970,"uuid":"542157768","full_name":"RubyOnWorld/kickbox-ruby","owner":"RubyOnWorld","description":"To begin, hop over to 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.","archived":false,"fork":false,"pushed_at":"2022-09-27T17:39:17.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-06T14:04:45.691Z","etag":null,"topics":["box","email","kick","kickbox","library","ruby","verification"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RubyOnWorld.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2022-09-27T15:28:33.000Z","updated_at":"2022-09-27T17:47:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"592b62d2-130e-44a1-b59f-c593be3d1b94","html_url":"https://github.com/RubyOnWorld/kickbox-ruby","commit_stats":null,"previous_names":["rubyonworld/kickbox-ruby"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RubyOnWorld/kickbox-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubyOnWorld%2Fkickbox-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubyOnWorld%2Fkickbox-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubyOnWorld%2Fkickbox-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubyOnWorld%2Fkickbox-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RubyOnWorld","download_url":"https://codeload.github.com/RubyOnWorld/kickbox-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubyOnWorld%2Fkickbox-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31910584,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"ssl_error","status_checked_at":"2026-04-16T18:21:47.142Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["box","email","kick","kickbox","library","ruby","verification"],"created_at":"2024-11-07T14:23:56.800Z","updated_at":"2026-04-17T01:02:50.623Z","avatar_url":"https://github.com/RubyOnWorld.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://static.kickbox.io/kickbox_github.png\" alt=\"Kickbox Email Verification Service\"\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n# Email Verification Library for Ruby\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 [rubygems](https://rubygems.org) installed\n\n```bash\n$ gem install kickbox\n```\n\n#### Versions\n\nWorks with [ 1.9.* / 2.* ]\n\n## Usage\n\n```ruby\nrequire \"kickbox\"\n\nclient   = Kickbox::Client.new('Your_API_Key_Here')\nkickbox  = client.kickbox()\nresponse = kickbox.verify(\"test@example.com\")\n```\n`verify` returns a Kickbox::HttpClient::Response which has a `body` attribute which contains the deserialized JSON.\n\nYou can use it like this:\n\n```ruby\nresponse.body['result'] #=\u003e \"deliverable\"\nresponse.body['reason'] #=\u003e  \"accepted_email\"\n\n```\n\nFull response information is provided below\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```ruby\n# Example with options\nresponse = kickbox.verify(\"test@example.com\", { \"timeout\" =\u003e 60000 })\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` -\u003e `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` -\u003e `bob@example.com`)\n* **user** `string` - The user (a.k.a local part) of the provided email address. (`bob@example.com` -\u003e `bob`)\n* **domain** `string` - The domain of the provided email address. (`bob@example.com` -\u003e `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-ruby/issues).\n\n## Need Help?\nhelp@kickbox.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyonworld%2Fkickbox-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyonworld%2Fkickbox-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyonworld%2Fkickbox-ruby/lists"}