API Documentation
\
Knack
ZeroBounce
API
Exceptions
Models
Providers
Utilities

\Knack\ZeroBounce\APIZeroBounce

Class ZeroBounceService

Summary

Methods
Properties
Constants
__construct()
validate()
getAccountCredits()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_zeroBounceAPI
N/A

Properties

$_zeroBounceAPI

$_zeroBounceAPI :

Type

Methods

__construct()

__construct(string  $apiKey)

ZeroBounce constructor.

Parameters

string $apiKey

API key to init with

validate()

validate(string  $emailAddress, string  $ipAddress = '') : \Knack\ZeroBounce\Models\Response

Validates an email address, optionally passed with an IP Address to verify the email address against.

Parameters

string $emailAddress

email address to validate
string $ipAddress

IP address to co-validate

Throws

\Knack\ZeroBounce\Exceptions\ZeroBounceException

Returns

\Knack\ZeroBounce\Models\Response

getAccountCredits()

getAccountCredits() : integer

Get the account credits available to be used.

Returns

integer