DOCS
  • Home
  • API Wrappers / SDKs

API WRAPPERS



    • Java

    You can find the Official ZeroBounce Java API v2 Wrapper:

    Official JAVA SDK:

    This is a java wrapper class example for the ZeroBounce API v2.

    The project has 2 dependencies:

    Apache HttpClient
    JSON (org.json)

    Either download the dependencies separately and add them to the relevant path or add the following dependencies to your pom.xml file if you're building via Maven (already added if you're cloning this repo):

    Validate(email) method:

    • Properties
      Possible Values
    • getEmailAddress()
      The email address you are validating.
    • getStatus()
      Valid
      Invalid
      Catch-All
      Unknown
      Spamtrap
      Abuse
      DoNotMail
    • getSubStatus()
      antispam_system
      greylisted
      mail_server_temporary_error
      forcible_disconnect
      mail_server_did_not_respond
      timeout_exceeded
      failed_smtp_connection
      mailbox_quota_exceeded
      exception_occurred
      possible_traps
      role_based
      global_suppression
      mailbox_not_found
      no_dns_entries
      failed_syntax_check
      possible_typo
      unroutable_ip_address
      unroutable_ip_address
      leading_period_removed
      does_not_accept_mail
      alias_address
      role_based_catch_all
    • getAccount()
      The portion of the email address before the "@" symbol.
    • getDomain()
      The portion of the email address after the "@" symbol.
    • getDidYouMean()
      Suggestive Fix for an email typo or [null]
    • getDomainAgeDays()
      Age of the email domain in days or [null].
    • isFreeEmail()
      [true/false] If the email comes from a free provider.
    • isMXFound()
      [true/false] Does the domain have an MX record
    • getMXRecord()
      The preferred MX record of the domain or [null].
    • getSMTPProvider()
      The SMTP Provider of the email or [null] (BETA).
    • getFirstName()
      The first name of the owner of the email when available or [null].
    • getLastName()
      The last name of the owner of the email when available or [null].
    • getGender()
      The gender of the owner of the email when available or [null].
    • getCountry()
      The country the IP address is from.
    • getCity()
      The city the IP address is from.
    • getZipcode()
      The zip code the IP address is from.
    • getRegion()
      The region/state the IP address is from.
    • getProcessedAt()
      The UTC time the email was validated.

    getCredit() method

    • Properties
      Possible Values
    • getCredits()
      The number of credits left in account for email validation
    !

    Status Code Documentation

    Please visit our Status Code Documentation for an explanation of each status.

    !

    Sandbox Mode

    To test out or API without using credits - Please use the emails provided in our sandbox documentation.






    .Net

    You can find the ZeroBounce .NET API Wrapper on our GitHub - .NET API repository.

    You can also easily consume and keep it updated within your Visual Studio Project with Nuget Package Manager: https://www.nuget.org/packages/ZeroBounceAPIWrapper/ to find more details about URL

    This wrapper class takes all the work out of coding against the API and allows you to easily set properties and get results instantly.

    The .NET API Wrapper takes these input parameters.

    .NET API input parameters

    • Properties
      Possible Values
    • apiKey
      The api key located in your account dashboard.
    • emailToValidate
      The email address your validating.
    • ipAddress
      [optional] - The IP Address the email address was captured from
    • requestTimeOut
      Timeout settings in milliseconds, setting this enables you to control how long you are willing to wait for to send the request to the API. When the timeout occurs an "Unknown" result is returned.
    • readTimeOut
      The timeout settings in milliseconds, setting this enables you to control how long you are willing to wait for the API to respond to your request. When the timeout occurs an "Unknown" result is returned.

    The ValidateEmail and GetCredit methods return objects from which you can easily retrieve properties the properties below.

    PROPERTIES AND POSSIBLE VALUES RETURNED BY THE METHODS:

    Validate(email) method:

    • Properties
      Possible Values
    • address
      The email address you are validating.
    • status
      Valid
      Invalid
      Catch-All
      Unknown
      Spamtrap
      Abuse
      DoNotMail
    • sub_status
      antispam_system
      greylisted
      mail_server_temporary_error
      forcible_disconnect
      mail_server_did_not_respond
      timeout_exceeded
      failed_smtp_connection
      mailbox_quota_exceeded
      exception_occurred
      possible_traps
      role_based
      global_suppression
      mailbox_not_found
      no_dns_entries
      failed_syntax_check
      possible_typo
      unroutable_ip_address
      leading_period_removed
      does_not_accept_mail
      alias_address
    • account
      The portion of the email address before the "@" symbol.
    • domain
      The portion of the email address after the "@" symbol.
    • disposable
      [true/false] If the email domain is disposable, which are usually temporary email addresses.
    • firstname
      The first name of the owner of the email when available or [null].
    • lastname
      The last name of the owner of the email when available or [null].
    • gender
      The gender of the owner of the email when available or [null].
    • creationDate
      The creation date or [null].
    • location
      The location of the owner of the email when available or [null].
    • processedAt
      The UTC time the email was validated.

    These additional properties are available when you set the ipAddress property.

    • Properties
      Possible Values
    • country
      The country the IP address is from.
    • region
      The state/region the IP address is from
    • city
      The city the IP address is from
    • zipcode
      The Zip Code the IP address is from

    GetCredit method

    • Properties
      Possible Values
    • credits
      The number of credits left in account for email validation.

    VISUAL BASIC


    C#


    !

    Status Code Documentation

    Please visit our Status Code Documentation for an explanation of each status.

    !

    Sandbox Mode

    To test out or API without using credits - Please use the emails provided in our sandbox documentation.





    .Net Core

    User Contributed .NET Core Wrapper(s)
    https://github.com/bkrauska/zerobounce-dotnetcore-api to find more details about URL