PHP

You can find the ZeroBounce PHP API on our GitHub - PHP API v2.

This is a PHP wrapper class example for the ZeroBounce API.

  • TLS V1.2 is required - This is available from PHP 5.5.19 and up.

Example usage:

The validation methods return objects on which you call get methods which return the relevant information. Please see the sample code on the right:

The validate and getCredits methods return objects from which you can easily retrieve properties the properties below.

Properties and possible values returned by the methods:

validate method

  • Property
    Possible Values
  • address
    The email address you are validating.
  • status
    valid
    invalid
    catch-all
    unknown
    spamtrap
    abuse
    do_not_mail
  • 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
    toxic
    disposable
    role_based_catch_all
  • account
    The portion of the email address before the "@" symbol.
  • domain
    The portion of the email address after the "@" symbol.
  • did_you_mean
    Suggestive fix for an email typo or [null]
  • domain_age_days
    Age of the email domain in days or [null]
  • free_email
    [true/false] If the email comes from a free provider
  • mx_found
    [true/false] Does the domain have an MX record
  • mx_record
    The preferred MX record of the domain or [null]
  • smtp_provider
    The SMTP Provider of the email or [null] (BETA)
  • 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]
  • 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
  • processed_at
    The UTC time the email was validated

GetCredit method

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

  <?php
  require_once("zerobounce.php");
  
  $zba = new ZeroBounceAPI('YOUR_API_KEY');
  
  //print the credit balance
  print_r($zba->get_credits());
  
  //instantiate a validation object following a call to 
  //validate and print individual elements
  $validation = $zba->validate('email@address.com', 'IP can be blank');
  echo $validation['address'];
  echo $validation['status'];
  print_r($zba->validate('email@address.com', 'IP'));
  ?>