Skip to content
This repository has been archived by the owner on Jun 23, 2023. It is now read-only.

Latest commit

 

History

History
59 lines (41 loc) · 1.86 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.86 KB

BriteVerify

BriteVerify is a paying e-mail verification service. You pass it an e-mail address and it tells you if the e-mail address is real or not. They offer a typical REST-like API. This gem wraps the API in a more Ruby friendly syntax.

This gem is in no way endorsed or certified by BriteVerify. I extracted the code from a project where we are using the BriteVerify e-mail verification service.

Shortcomings

This gem does not cover all of BriteVerify’s services. It only does e-mail verification and does not help you with any of BriteVerify’s other services as I did not need any of those so far. Feel free to contribute if you can help, it can only help the Ruby community.

Installation

The BriteVerify gem is Ruby 2.x compatible.

Add this line to your application’s Gemfile:

gem 'brite_verify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install brite_verify

Usage

Minimum viable example:

email = BriteVerify::Email.new("john@example.com", "1298c367-ca34-6e11-3ab5-56027f1d1ec7")
email.verified?
 => true
email.status
 => :invalid
email.account
 => "john"
email.domain
 => "example.com"
email.connected
 => nil
email.disposable
 => false 
email.role_address
 => false 
email.duration
 => 0.039381279
email.error_code
 => "email_domain_invalid"
email.error
 => "Email domain invalid"

You can skip the API key parameter and specify the BRITEVERIFY_API_KEY environment variable for convenience. The connection timeouts can be configured via the BRITEVERIFY_CONTINUE_TIMEOUT, BRITEVERIFY_CONTINUE_TIMEOUT and BRITEVERIFY_READ_TIMEOUT environment variables.

Contributing

Something missing? Found a bug? Horrified by the code? Open a github issue, write a failing test or add some code using pull requests. Your help is greatly appreciated!