Download the PHP package nightstomp/kickbox-fork without Composer
On this page you can find all versions of the php package nightstomp/kickbox-fork. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nightstomp/kickbox-fork
More information about nightstomp/kickbox-fork
Files in nightstomp/kickbox-fork
Package kickbox-fork
Short Description Official kickbox API library client for PHP
License MIT
Homepage http://kickbox.io
Informations about the package kickbox-fork
Email Verification Library for PHP
Kickbox determines if an email address is not only valid, but associated with a actual user. Uses include:
- Preventing users from creating accounts on your applications using fake, misspelled, or throw-away email addresses.
- Reducing bounces by removing old, invalid, and low quality email addresses from your mailing lists.
- Saving money and projecting your reputation by only sending to real email users.
Getting Started
To begin, hop over to kickbox.io and create a free account. Once you've signed up and logged in, click on API Settings and then click Add API Key. Take note of the generated API Key - you'll need it to setup the client as explained below.
Installation
Make sure you have composer installed.
Add the following to your composer.json
Update your dependencies
This package follows the
PSR-0
convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.
Versions
Works with [ 5.4 / 5.5 ]
Usage
Options
timeout integer
(optional) - Maximum time, in milliseconds, for the API to complete a verification request. Default: 6000.
Response information
A successful API call responds with the following values:
- result
string
- The verification result:deliverable
,undeliverable
,risky
,unknown
- reason
string
- The reason for the result. Possible reasons are:invalid_email
- Specified email is not a valid email address syntaxinvalid_domain
- Domain for email does not existrejected_email
- Email address was rejected by the SMTP server, email address does not existaccepted_email
- Email address was accepted by the SMTP serverlow_quality
- Email address has quality issues that may make it a risky or low-value addresslow_deliverability
- Email address appears to be deliverable, but deliverability cannot be guaranteedno_connect
- Could not connect to SMTP servertimeout
- SMTP session timed outinvalid_smtp
- SMTP server returned an unexpected/invalid responseunavailable_smtp
- SMTP server was unavailable to process our requestunexpected_error
- An unexpected error has occurred
- role
true | false
- true if the email address is a role address ([email protected]
,[email protected]
, etc) - free
true | false
- true if the email address uses a free email service like gmail.com or yahoo.com. - disposable
true | false
- true if the email address uses a disposable domain like trashmail.com or mailinator.com. - accept_all
true | false
- true if the email was accepted, but the domain appears to accept all emails addressed to that domain. - did_you_mean
null | string
- Returns a suggested email if a possible spelling error was detected. ([email protected]
->[email protected]
) - sendex
float
- A quality score of the provided email address ranging between 0 (no quality) and 1 (perfect quality). More information on the Sendex Score can be found here. - email
string
- Returns a normalized version of the provided email address. ([email protected]
->[email protected]
) - user
string
- The user (a.k.a local part) of the provided email address. ([email protected]
->bob
) - domain
string
- The domain of the provided email address. ([email protected]
->example.com
) - success
true | false
- true if the API request was successful (i.e., no authentication or unexpected errors occurred)
An example response would look like:
Response headers
Along with each response, the following HTTP headers are included:
X-Kickbox-Balance
- Your remaining verification credit balance (Daily + On Demand).X-Kickbox-Response-Time
- The elapsed time (in milliseconds) it took Kickbox to process the request.
License
MIT
Bug Reports
Report here.