PHP SDK

1. Installation

Install the official package from Packagist with Composer. This adds the SDK and enables PSR-4 autoloading in your project.

composer require nexmailpro/php-sdk

2. Initialize Client

The published README loads Composer autoloading first, then instantiates NexMailPro\PhpSdk\Client with your API key.

<?php

require __DIR__ . '/vendor/autoload.php';

use NexMailPro\PhpSdk\Client;

$client = new Client(apiKey: 'your-api-key');

3. Verify Email

The only public verification method currently published is verifyEmail(string $email, array $payload = []): array. The README example passes an optional payload array alongside the email address.

$response = $client->verifyEmail('[email protected]', [
    'source' => 'signup-form',
]);

var_dump($response);

4. Example Response

Successful SDK calls return the same JSON structure documented for the live API.

{
  "success": true,
  "message": "Verification completed",
  "data": {
    "email": "[email protected]",
    "status": "valid",
    "sub_status": "deliverable",
    "score": 90,
    "is_syntax_valid": true,
    "has_mx": true,
    "domain_exists": true
  },
  "meta": {
    "credits_charged": 1
  }
}

5. Error Handling

The published SDK exposes two exception classes: NexMailPro\PhpSdk\Exception\ApiException and NexMailPro\PhpSdk\Exception\NexMailProException.

use NexMailPro\PhpSdk\Client;
use NexMailPro\PhpSdk\Exception\ApiException;
use NexMailPro\PhpSdk\Exception\NexMailProException;

$client = new Client(apiKey: 'YOUR_API_KEY');

try {
    $result = $client->verifyEmail('[email protected]');
} catch (ApiException $e) {
    error_log(sprintf(
        'NexMailPro API error [%d]: %s',
        $e->statusCode(),
        $e->responseBody()
    ));
} catch (NexMailProException $e) {
    error_log($e->getMessage());
}

6. Features

7. Requirements

8. Links

9. FAQ