treat-client-php
Versions
treat-client-php uses a modified version of Semantic Versioning for all changes.
Supported PHP Versions
- PHP >= 7.0
Installation
You can install treat-client-php via composer or by downloading the source.
Via Composer:
treat-client-php is available on Packagist as the
treat-email/treat-client-php package:
composer require treat-email/treat-client-php
Send API request
Sign up to get credentials
Send request with HTTPlug or any other PSR-18 (HTTP client) you may send requests like:
$clientKey = 'XXXXX';
$clientSecret = 'XXXXX';
$email = 'admin@treat.email';
$httpClient = new \TreatEmail\HttpClient\NativeHttpClient(new \TreatEmail\HttpClient\HttpClientHeaders());
$api = new TreatEmail\ApiClient\ApiClient($httpClient, $clientKey, $clientSecret);
$apiDecorator = new \TreatEmail\ApiClient\ApiClientDecorator($api);
$validationResult = $apiDecorator->validate($email);
try {
if ($validationResult->isRegistrable() === true) {
// email is registrable
}
if ($validationResult->isRegistrable() === false) {
// email is not registrable
// and you can get violation message
$violation = $validationResult->getMessage();
}
} catch (\TreatEmail\Exception\RequestFailedException $exception) {
// faced issue with internet connection or server error
// in this case use fallback internal validation to check an email
}List of violation messages:
- Invalid format
- Domain does not exist
- Disposable domain
- Invalid top-level domain
