Quickstart#

Dependencies#

An API key is required for this module to function.

Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you’ll be given an API key.

Installation#

To install this module type the following:

gem install mailboxvalidator_ruby

Sample Codes#

Validate email#

You can validate whether an email address is invalid or not as below:

require "mailboxvalidator_ruby"

apikey = "MY_API_KEY"
email = "example@example.com"

mbv = MailboxValidator::MBV.new()
mbv.apikey = apikey

mbv.query_single(email)

if mbv.error != nil && mbv.result != nil
	puts "error_code: #{mbv.result.error.error_code}"
	puts "error_message: #{mbv.result.error.error_message}"
elsif mbv.error != nil
	puts "Error: #{mbv.error}"
elsif mbv.result != nil
	puts "email_address: #{mbv.result.email_address}"
	puts "base_email_address: #{mbv.result.base_email_address}"
	puts "domain: #{mbv.result.domain}"
	puts "is_free: #{mbv.result.is_free}"
	puts "is_syntax: #{mbv.result.is_syntax}"
	puts "is_domain: #{mbv.result.is_domain}"
	puts "is_smtp: #{mbv.result.is_smtp}"
	puts "is_verified: #{mbv.result.is_verified}"
	puts "is_server_down: #{mbv.result.is_server_down}"
	puts "is_greylisted: #{mbv.result.is_greylisted}"
	puts "is_disposable: #{mbv.result.is_disposable}"
	puts "is_suppressed: #{mbv.result.is_suppressed}"
	puts "is_role: #{mbv.result.is_role}"
	puts "is_high_risk: #{mbv.result.is_high_risk}"
	puts "is_catchall: #{mbv.result.is_catchall}"
	puts "is_dmarc_enforced: #{mbv.result.is_dmarc_enforced}"
	puts "is_strict_spf: #{mbv.result.is_strict_spf}"
	puts "website_exist: #{mbv.result.website_exist}"
	puts "mailboxvalidator_score: #{mbv.result.mailboxvalidator_score}"
	puts "time_taken: #{mbv.result.time_taken}"
	puts "status: #{mbv.result.status}"
	puts "credits_available: #{mbv.result.credits_available}"
end

Check if an email is from a disposable email provider#

You can validate whether an email address is disposable email address or not as below:

require "mailboxvalidator_ruby"

apikey = "MY_API_KEY"
email = "example@example.com"

mbv = MailboxValidator::MBV.new()
mbv.apikey = apikey

mbv.disposable_email(email)

if mbv.error != nil && mbv.result != nil
	puts "error_code: #{mbv.result.error.error_code}"
	puts "error_message: #{mbv.result.error.error_message}"
elsif mbv.error != nil
	puts "Error: #{mbv.error}"
elsif mbv.result != nil
	puts "email_address: #{mbv.result.email_address}"
	puts "is_disposable: #{mbv.result.is_disposable}"
	puts "credits_available: #{mbv.result.credits_available}"
end

Check if an email is from a free email provider#

You can validate whether an email address is free email address or not as below:

require "mailboxvalidator_ruby"

apikey = "MY_API_KEY"
email = "example@example.com"

mbv = MailboxValidator::MBV.new()
mbv.apikey = apikey

mbv.free_email(email)

if mbv.error != nil && mbv.result != nil
	puts "error_code: #{mbv.result.error.error_code}"
	puts "error_message: #{mbv.result.error.error_message}"
elsif mbv.error != nil
	puts "Error: #{mbv.error}"
elsif mbv.result != nil
	puts "email_address: #{mbv.result.email_address}"
	puts "is_free: #{mbv.result.is_free}"
	puts "credits_available: #{mbv.result.credits_available}"
end

Quickstart

Contents