Download the PHP package zero-bounce/sdk without Composer

ZeroBounce PHP SDK

This SDK contains methods for interacting easily with ZeroBounce API. More information about ZeroBounce can be find in the official documentation.

Installation

To install the SDK you will need to use composer in your project. If you're not using composer, you can install it like so:

To install the SDK with composer, run:

Laravel

This package is Laravel compatible as is:

However, this package is framework agnostic, so if you need it implemented in a service provider class, you'll need to implement it.

Usage

• include the SDK in your file (you should always use Composer's autoloader in your application to automatically load your dependencies)

• initialize the SDK with your API key

• _Optional: customize the base URL. Accepted values are API_DEFAULT_URL(default), API_USA_URL and API_EU_URL. Invalid values will fall back to the default one._

Method documentation

• Verify an email address:

• Verify a batch of email addresses:

• Check how many credits you have left on your account

• Check your API usage for a given period of time

• Check the activity of a subscriber given their email account

• Send a file for bulk email validation

Bulk validation uses https://bulkapi.zerobounce.net/v2. See v2 send file, v2 file status, and v2 get file.

• Check the status of a file uploaded via "sendFile" method

• Get the validation results file for the file been submitted using sendfile API

Optional v2 get file query parameters use ZBGetFileOptions and ZBDownloadType (PHASE_1, PHASE_2, COMBINED). Set activityData on the options object for validation getFile only; it is not sent for scoringGetFile.

If the API returns a non-success HTTP status or a JSON error body (including some HTTP 200 responses with success: false), the SDK throws ZBException. To inspect raw bodies yourself, use ZeroBounce::getFileJsonIndicatesError($jsonString).

• Deletes the file that was submitted using scoring sendfile API. File can be deleted only when its status is Complete

AI Scoring API

• The scoring sendfile API allows a user to send a file for bulk email scoring

• Check the status of a file uploaded via "scoringSendFile" method

• Get the validation results file for the file been submitted using scoringSendfile API

• Deletes the file that was submitted using scoringSendfile API. File can be deleted only when its status is Complete

Email Finder API

Guess an email address. The required arguments are firstName and either domain or companyName. If both are provided, only domain is used. If necessary, domain can be null.

Guess the format of email addresses for a domain or company. Must provide either domain or companyName. If both are provided, only domain is used. If necessary, domain can be null.

Development

Run tests with Docker

From the parent repository root (the folder that contains all SDKs and docker-compose.yml):

Run tests (local)

Install required PHP modules

Install development dependencies

Run tests

Publish

Releases are driven by git tags. Packagist picks up new versions automatically when you push a tag. No manual publish step. For the release workflow (version/tag from the SDKs repo), see the sdk-docs guide (Packagist and RELEASE-WORKFLOW).