mailsafepro/mailsafepro-php

PHP SDK for MailSafePro Email Validation API. Robust and secure email validation and verification with batch processing, breach detection, and JWT authentication. GDPR compliant.

1.0.0 2026-01-03 13:26 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

unlicense

• MailSafePro

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

API robusta y segura para validación y verificación de correos electrónicos. Soporta verificación individual y en lote, detección de brechas, y autenticación JWT. Cumple con GDPR y dispone de planes de pago flexibles.

🔗 Enlaces importantes:

• Estado del sistema
• Documentación completa

📧 Contacto: [e-mail]

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/mailsafepro/mailsafepro-php.git"
    }
  ],
  "require": {
    "mailsafepro/mailsafepro-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/mailsafepro/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: Bearer
$config = MailSafePro\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new MailSafePro\Api\APIKeysApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$api_key_create_request = new \MailSafePro\Model\APIKeyCreateRequest(); // \MailSafePro\Model\APIKeyCreateRequest

try {
    $result = $apiInstance->createApiKeyApiKeysPost($api_key_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APIKeysApi->createApiKeyApiKeysPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
APIKeysApi	createApiKeyApiKeysPost	POST /api-keys	Create Api Key
APIKeysApi	createApiKeyApiKeysPost_0	POST /api-keys	Create Api Key
APIKeysApi	forceSyncApiKeysForceSyncPost	POST /api-keys/force-sync	Force Sync
APIKeysApi	forceSyncApiKeysForceSyncPost_0	POST /api-keys/force-sync	Force Sync
APIKeysApi	getApiKeyValueApiKeysKeyHashValueGet	GET /api-keys/{key_hash}/value	Get Api Key Value
APIKeysApi	getApiKeyValueApiKeysKeyHashValueGet_0	GET /api-keys/{key_hash}/value	Get Api Key Value
APIKeysApi	getUsageApiKeysUsageGet	GET /api-keys/usage	Get Usage
APIKeysApi	getUsageApiKeysUsageGet_0	GET /api-keys/usage	Get Usage
APIKeysApi	listApiKeysApiKeysGet	GET /api-keys	List Api Keys
APIKeysApi	listApiKeysApiKeysGet_0	GET /api-keys	List Api Keys
APIKeysApi	repairUserDataEndpointApiKeysRepairDataPost	POST /api-keys/repair-data	Repair User Data Endpoint
APIKeysApi	repairUserDataEndpointApiKeysRepairDataPost_0	POST /api-keys/repair-data	Repair User Data Endpoint
APIKeysApi	revokeApiKeyApiKeysKeyHashRevokeDelete	DELETE /api-keys/{key_hash}/revoke	Revoke Api Key
APIKeysApi	revokeApiKeyApiKeysKeyHashRevokeDelete_0	DELETE /api-keys/{key_hash}/revoke	Revoke Api Key
APIKeysApi	rotateApiKeyApiKeysKeyHashRotatePost	POST /api-keys/{key_hash}/rotate	Rotate Api Key
APIKeysApi	rotateApiKeyApiKeysKeyHashRotatePost_0	POST /api-keys/{key_hash}/rotate	Rotate Api Key
APIKeysApi	syncPlanKeysApiKeysSyncPlanKeysPost	POST /api-keys/sync-plan-keys	Sync Plan Keys
APIKeysApi	syncPlanKeysApiKeysSyncPlanKeysPost_0	POST /api-keys/sync-plan-keys	Sync Plan Keys
AuthenticationApi	authHealthCheckAuthHealthAuthGet	GET /auth/health/auth	Auth Health Check
AuthenticationApi	authHealthCheckAuthHealthAuthGet_0	GET /auth/health/auth	Auth Health Check
AuthenticationApi	authHealthCheckAuthHealthAuthHead	HEAD /auth/health/auth	Auth Health Check
AuthenticationApi	authHealthCheckAuthHealthAuthHead_0	HEAD /auth/health/auth	Auth Health Check
AuthenticationApi	deleteAccountAuthDeleteDelete	DELETE /auth/delete	Delete Account
AuthenticationApi	deleteAccountAuthDeleteDelete_0	DELETE /auth/delete	Delete Account
AuthenticationApi	getCurrentUserAuthMeGet	GET /auth/me	Get Current User
AuthenticationApi	getCurrentUserAuthMeGet_0	GET /auth/me	Get Current User
AuthenticationApi	loginWebUserAuthLoginPost	POST /auth/login	Login Web User
AuthenticationApi	loginWebUserAuthLoginPost_0	POST /auth/login	Login Web User
AuthenticationApi	logoutAuthLogoutPost	POST /auth/logout	Logout
AuthenticationApi	logoutAuthLogoutPost_0	POST /auth/logout	Logout
AuthenticationApi	refreshTokenAuthRefreshPost	POST /auth/refresh	Refresh Token
AuthenticationApi	refreshTokenAuthRefreshPost_0	POST /auth/refresh	Refresh Token
AuthenticationApi	registerWebUserAuthRegisterPost	POST /auth/register	Register Web User
AuthenticationApi	registerWebUserAuthRegisterPost_0	POST /auth/register	Register Web User
AuthenticationApi	rotateApiKeyAuthRotateKeyPost	POST /auth/rotate-key	Rotate Api Key
AuthenticationApi	rotateApiKeyAuthRotateKeyPost_0	POST /auth/rotate-key	Rotate Api Key
BillingApi	changePlanBillingBillingChangePlanPost	POST /billing/billing/change-plan	Change Plan
BillingApi	changePlanBillingBillingChangePlanPost_0	POST /billing/billing/change-plan	Change Plan
BillingApi	createCheckoutSessionBillingBillingCreateCheckoutSessionPost	POST /billing/billing/create-checkout-session	Create Checkout Session
BillingApi	createCheckoutSessionBillingBillingCreateCheckoutSessionPost_0	POST /billing/billing/create-checkout-session	Create Checkout Session
BillingApi	getSubscriptionBillingBillingSubscriptionGet	GET /billing/billing/subscription	Get Subscription
BillingApi	getSubscriptionBillingBillingSubscriptionGet_0	GET /billing/billing/subscription	Get Subscription
BillingApi	stripeWebhookBillingBillingWebhookPost	POST /billing/billing/webhook	Stripe Webhook
BillingApi	stripeWebhookBillingBillingWebhookPost_0	POST /billing/billing/webhook	Stripe Webhook
BillingApi	testNotificationBillingBillingTestNotificationPost	POST /billing/billing/test-notification	Test Notification
BillingApi	testNotificationBillingBillingTestNotificationPost_0	POST /billing/billing/test-notification	Test Notification
DefaultApi	askGeminiGeminiGet	GET /gemini	Ask Gemini
DefaultApi	runAuditAdminAuditProjectPost	POST /admin/audit_project	Run Audit
DeveloperToolsApi	clearRequestLogsLogsLogsRequestsDelete	DELETE /logs/logs/requests	Clear Request Logs
DeveloperToolsApi	getRequestLogsLogsLogsRequestsGet	GET /logs/logs/requests	Get Request Logs
EmailValidationApi	batchValidateEmailsValidateBatchPost	POST /validate/batch	Batch Email Validation
EmailValidationApi	batchValidateUploadValidateBatchUploadPost	POST /validate/batch/upload	Batch Email Validation via File Upload
EmailValidationApi	getCacheStatsValidateStatsCacheGet	GET /validate/stats/cache	Get Cache Stats
EmailValidationApi	getUsageStatsValidateStatsUsageGet	GET /validate/stats/usage	Get Usage Stats
EmailValidationApi	healthCheckValidateHealthGet	GET /validate/health	Health Check
EmailValidationApi	healthCheckValidateHealthHead	HEAD /validate/health	Health Check
EmailValidationApi	validateEmailEndpointValidateEmailPost	POST /validate/email	Validate Email Endpoint
HealthApi	basicHealthHealthGet	GET /health	Basic health check
HealthApi	basicHealthHealthGet_0	GET /health	Basic health check
HealthApi	circuitBreakerStatusAdminCircuitBreakerStatusGet	GET /admin/circuit-breaker-status	Circuit Breaker Status
HealthApi	detailedHealthHealthDetailedGet	GET /health/detailed	Detailed health check
HealthApi	detailedHealthHealthDetailedGet_0	GET /health/detailed	Detailed health check
HealthApi	healthcheckHealthcheckGet	GET /healthcheck	Healthcheck
HealthApi	healthcheckHealthcheckHead	HEAD /healthcheck	Healthcheck
HealthApi	livenessCheckHealthLivenessGet	GET /health/liveness	Liveness Check
HealthApi	livenessHealthLiveGet	GET /health/live	Liveness probe (Kubernetes)
HealthApi	livenessHealthLiveGet_0	GET /health/live	Liveness probe (Kubernetes)
HealthApi	readinessCheckHealthReadinessGet	GET /health/readiness	Readiness Check
HealthApi	readinessHealthReadyGet	GET /health/ready	Readiness probe (Kubernetes)
HealthApi	readinessHealthReadyGet_0	GET /health/ready	Readiness probe (Kubernetes)
HealthApi	serviceStatusStatusGet	GET /status	Service Status
HealthApi	startupCheckHealthStartupGet	GET /health/startup	Startup Check
JobsApi	createJobJobsV1JobsPost	POST /jobs/v1/jobs	Create validation job
JobsApi	createJobJobsV1JobsPost_0	POST /jobs/v1/jobs	Create validation job
JobsApi	getJobResultsJobsV1JobsJobIdResultsGet	GET /jobs/v1/jobs/{job_id}/results	Get job results (paged)
JobsApi	getJobResultsJobsV1JobsJobIdResultsGet_0	GET /jobs/v1/jobs/{job_id}/results	Get job results (paged)
JobsApi	getJobStatusJobsV1JobsJobIdGet	GET /jobs/v1/jobs/{job_id}	Get job status
JobsApi	getJobStatusJobsV1JobsJobIdGet_0	GET /jobs/v1/jobs/{job_id}	Get job status
LogsApi	clearRequestLogsLogsLogsRequestsDelete	DELETE /logs/logs/requests	Clear Request Logs
LogsApi	getRequestLogsLogsLogsRequestsGet	GET /logs/logs/requests	Get Request Logs
ValidationApi	batchValidateEmailsValidateBatchPost	POST /validate/batch	Batch Email Validation
ValidationApi	batchValidateUploadValidateBatchUploadPost	POST /validate/batch/upload	Batch Email Validation via File Upload
ValidationApi	getCacheStatsValidateStatsCacheGet	GET /validate/stats/cache	Get Cache Stats
ValidationApi	getUsageStatsValidateStatsUsageGet	GET /validate/stats/usage	Get Usage Stats
ValidationApi	healthCheckValidateHealthGet	GET /validate/health	Health Check
ValidationApi	healthCheckValidateHealthHead	HEAD /validate/health	Health Check
ValidationApi	validateEmailEndpointValidateEmailPost	POST /validate/email	Validate Email Endpoint
WebhooksApi	createWebhookWebhooksManagementWebhooksPost	POST /webhooks-management/webhooks/	Create Webhook
WebhooksApi	deleteWebhookWebhooksManagementWebhooksWebhookIdDelete	DELETE /webhooks-management/webhooks/{webhook_id}	Delete Webhook
WebhooksApi	getDeliveriesWebhooksManagementWebhooksWebhookIdDeliveriesGet	GET /webhooks-management/webhooks/{webhook_id}/deliveries	Get Deliveries
WebhooksApi	getWebhookWebhooksManagementWebhooksWebhookIdGet	GET /webhooks-management/webhooks/{webhook_id}	Get Webhook
WebhooksApi	listWebhooksWebhooksManagementWebhooksGet	GET /webhooks-management/webhooks/	List Webhooks
WebhooksApi	registerEndpointWebhooksV1WebhooksEndpointsRegisterPost	POST /webhooks/v1/webhooks/endpoints/register	Register Endpoint
WebhooksApi	registerEndpointWebhooksV1WebhooksEndpointsRegisterPost_0	POST /webhooks/v1/webhooks/endpoints/register	Register Endpoint
WebhooksApi	rotateSecretWebhooksV1WebhooksEndpointsRotatePost	POST /webhooks/v1/webhooks/endpoints/rotate	Rotate Secret
WebhooksApi	rotateSecretWebhooksV1WebhooksEndpointsRotatePost_0	POST /webhooks/v1/webhooks/endpoints/rotate	Rotate Secret
WebhooksApi	testWebhookWebhooksManagementWebhooksWebhookIdTestPost	POST /webhooks-management/webhooks/{webhook_id}/test	Test Webhook
WebhooksApi	updateWebhookWebhooksManagementWebhooksWebhookIdPatch	PATCH /webhooks-management/webhooks/{webhook_id}	Update Webhook
WebhooksManagementApi	createWebhookWebhooksManagementWebhooksPost	POST /webhooks-management/webhooks/	Create Webhook
WebhooksManagementApi	deleteWebhookWebhooksManagementWebhooksWebhookIdDelete	DELETE /webhooks-management/webhooks/{webhook_id}	Delete Webhook
WebhooksManagementApi	getDeliveriesWebhooksManagementWebhooksWebhookIdDeliveriesGet	GET /webhooks-management/webhooks/{webhook_id}/deliveries	Get Deliveries
WebhooksManagementApi	getWebhookWebhooksManagementWebhooksWebhookIdGet	GET /webhooks-management/webhooks/{webhook_id}	Get Webhook
WebhooksManagementApi	listWebhooksWebhooksManagementWebhooksGet	GET /webhooks-management/webhooks/	List Webhooks
WebhooksManagementApi	testWebhookWebhooksManagementWebhooksWebhookIdTestPost	POST /webhooks-management/webhooks/{webhook_id}/test	Test Webhook
WebhooksManagementApi	updateWebhookWebhooksManagementWebhooksWebhookIdPatch	PATCH /webhooks-management/webhooks/{webhook_id}	Update Webhook

Models

• APIKeyCreateRequest
• APIKeyListResponse
• APIKeyMeta
• BatchEmailResponse
• BatchValidationRequest
• BodyChangePlanBillingBillingChangePlanPost
• CheckoutRequest
• CheckoutSessionResponse
• DNSInfo
• DNSRecordDKIM
• DNSRecordDMARC
• DNSRecordSPF
• EmailResponse
• EmailValidationRequest
• HTTPValidationError
• JobCreateRequest
• JobCreateResponse
• JobResultEntry
• JobResultsPage
• JobStatusResponse
• KeyRotationRequest
• PlanEnum
• PriorityEnum
• RegisterEndpoint
• ResponseTestNotificationBillingBillingTestNotificationPostValue
• RiskLevelEnum
• RotateSecret
• SMTPInfo
• SubscriptionResponse
• UserLogin
• UserRegister
• ValidationError
• ValidationErrorLocInner
• WebhookCreate
• WebhookResponse
• WebhookUpdate

Authorization

Authentication schemes defined for the API:

Bearer

• Type: Bearer authentication (JWT)

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2.5.0
  • Package version: 1.0.0
  • Generator version: 7.18.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen