Download the PHP package nullform/zerobounce-client without Composer
On this page you can find all versions of the php package nullform/zerobounce-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nullform/zerobounce-client
More information about nullform/zerobounce-client
Files in nullform/zerobounce-client
Package zerobounce-client
Short Description ZeroBounce API client
License MIT
Homepage https://github.com/nullform/zerobounce-client
Informations about the package zerobounce-client
ZeroBounce API client
Non official PHP client for ZeroBounce API.
Installation
Usage
Basic
Caching
You can cache API responses if you use PSR-6 or PSR-16 caching in your project.
Just pass to Client::caching()
your cache repository instance, TTL and prefix.
If the cache instance is passed, each successful response will be stored to the cache for the $ttl
seconds.
With repeated requests with the same parameters, the response will be taken from the cache.
Logging
You can log your API calls by passing your own function to Client::logFunction()
. Passed function will be called on every API call.
The function takes an instance of \Nullform\ZeroBounce\Client
as a parameter.
For example:
Or you can just override the Client::log()
method that is called on every API call.
Methods
Client::timeout()
Client::timeout( [ int $timeout = null ] ) : int
Timeout (maximum time the request is allowed to take). Get or set value.
Client::caching()
Client::caching( $cache, int $ttl [, string $prefix = '' ] ) : bool
Caching of API responses.
You can pass null
to disable caching (default).
Client::logFunction()
Client::logFunction( ?callable $func ) : bool
The function for logging that will be called after every ZeroBounce API call.
The function takes a client instance as a parameter.
Client::lastRequest()
Client::lastRequest( void ) : Http\Request
Get last request.
Client::lastResponse()
Client::lastResponse( void ) : Http\Response
Get last response.
Client::getCredits()
Client::getCredits( void ) : int
Get credit balance. If a -1 is returned, that means your API Key is invalid.
Validation API: Credit Balance
Client::validate()
Client::validate( string $email [, ?string $ip_address = null ] ) : Models\Email
Validate email.
Validation API: Validate Emails
Client::getUsage()
Client::getUsage( mixed $start_date [, mixed $end_date = 'now' ] ) : Models\Usage
Get API usage.
$start_date
and $end_date
- timestamp or string that the strtotime(), DateTime and date_create() parser understands.
Client::bulkSendFile()
Client::bulkSendFile( string $filename, string $type, Params\BulkSendFileParams $params ) : Models\BulkFile
Send a csv or txt file for bulk email validation/scoring.
Validation API: Send File | AI Scoring API: Send File
Client::bulkFileStatus()
Client::bulkFileStatus( string $file_id, string $type ) : Models\BulkFile
Uploaded file status.
Validation API: File Status | AI Scoring API: File Status
Client::bulkGetFile()
Client::bulkGetFile( string $file_id, string $type [, ?string $output_filename = null ] ) : string
Get the validation/scoring results csv (or zip) file for the file been submitted using sendfile API.
Validation API: Get File | AI Scoring API: Get File
Client::bulkDeleteFile()
Client::bulkDeleteFile( string $file_id, string $type ) : bool
Delete the file that was submitted using sendfile API. File can be deleted only when its status is Complete.
Validation API: Delete File | AI Scoring API: Delete File
Facade
You can use facade for quick email validation and balance check.
All versions of zerobounce-client with dependencies
ext-curl Version *
ext-json Version *
ext-fileinfo Version *
psr/cache Version ^1.0.1
psr/simple-cache Version ^1.0.1