Quickstart#

Dependencies#

An API key is required for this library 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.

Requirements#

Intellij IDEA: https://www.jetbrains.com/idea/

Sample Codes#

Validate email#

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

import com.mailboxvalidator._

object Main {
  def main(args: Array[String]): Unit = {
    try {
      val mbv = new SingleValidation("PASTE_YOUR_API_KEY_HERE")

      val rec = mbv.validateEmail("example@example.com")
      if (rec.errorMessage == "") {
        System.out.println("email_address: " + rec.emailAddress)
        System.out.println("domain: " + rec.domain)
        System.out.println("is_free: " + rec.isFree)
        System.out.println("is_syntax: " + rec.isSyntax)
        System.out.println("is_domain: " + rec.isDomain)
        System.out.println("is_smtp: " + rec.isSMTP)
        System.out.println("is_verified: " + rec.isVerified)
        System.out.println("is_server_down: " + rec.isServerDown)
        System.out.println("is_greylisted: " + rec.isGreylisted)
        System.out.println("is_disposable: " + rec.isDisposable)
        System.out.println("is_suppressed: " + rec.isSuppressed)
        System.out.println("is_role: " + rec.isRole)
        System.out.println("is_high_risk: " + rec.isHighRisk)
        System.out.println("is_catchall: " + rec.isCatchall)
        System.out.println("mailboxvalidator_score: " + rec.mailboxValidatorScore)
        System.out.println("time_taken: " + rec.timeTaken)
        System.out.println("status: " + rec.status)
        System.out.println("credits_available: " + rec.creditsAvailable)
      }
      else {
        System.out.println("error_code: " + rec.errorCode)
        System.out.println("error_message: " + rec.errorMessage)
      }
      System.out.println("version: " + rec.version)
    } catch {
      case e: Exception =>
        e.printStackTrace(System.out)
    }
  }
}

class Main {
}

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:

import com.mailboxvalidator._

object Main {
  def main(args: Array[String]): Unit = {
    try {
      val mbv = new SingleValidation("PASTE_YOUR_API_KEY_HERE")

      val rec = mbv.disposableEmail("example@example.com")
      if (rec.errorMessage == "") {
        System.out.println("email_address: " + rec.emailAddress)
        System.out.println("is_disposable: " + rec.isDisposable)
        System.out.println("credits_available: " + rec.creditsAvailable)
      }
      else {
        System.out.println("error_code: " + rec.errorCode)
        System.out.println("error_message: " + rec.errorMessage)
      }
      System.out.println("version: " + rec.version)
    } catch {
      case e: Exception =>
        e.printStackTrace(System.out)
    }
  }
}

class Main {
}

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:

import com.mailboxvalidator._

object Main {
  def main(args: Array[String]): Unit = {
    try {
      val mbv = new SingleValidation("PASTE_YOUR_API_KEY_HERE")

      val rec = mbv.freeEmail("example@example.com")
      if (rec.errorMessage == "") {
        System.out.println("email_address: " + rec.emailAddress)
        System.out.println("is_free: " + rec.isFree)
        System.out.println("credits_available: " + rec.creditsAvailable)
      }
      else {
        System.out.println("error_code: " + rec.errorCode)
        System.out.println("error_message: " + rec.errorMessage)
      }
      System.out.println("version: " + rec.version)
    } catch {
      case e: Exception =>
        e.printStackTrace(System.out)
    }
  }
}

class Main {
}