PHPackages elvesora/soryxa-laravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. elvesora/soryxa-laravel ActiveLibrary[Mail & Notifications](/categories/mail) elvesora/soryxa-laravel ======================= Laravel SDK for the Soryxa email validation API v1.0.1(1mo ago)02↓95%MITPHPPHP ^8.1 Since Apr 3Pushed 1mo agoCompare [ Source](https://github.com/Elvesora/soryxa-laravel)[ Packagist](https://packagist.org/packages/elvesora/soryxa-laravel)[ RSS](/packages/elvesora-soryxa-laravel/feed)WikiDiscussions main Synced 1w ago READMEChangelog (2)Dependencies (4)Versions (4)Used By (0) Elvesora Soryxa Laravel SDK =========================== [](#elvesora-soryxa-laravel-sdk) Official Laravel SDK for the [Soryxa](https://www.elvesora.com/soryxa) email validation API. It validates email addresses through `/api/v1/validate` and returns the current Soryxa decision contract, including policy, rollout, score-adjustment, usage, and response-header metadata. Requirements ------------ [](#requirements) - PHP 8.1+ - Laravel 10, 11, 12, or 13 Installation ------------ [](#installation) ``` composer require elvesora/soryxa-laravel ``` The service provider and facade are auto-discovered. ### Publish The Config [](#publish-the-config) ``` php artisan vendor:publish --tag=soryxa-config ``` Configuration ------------- [](#configuration) Add your API token to `.env`: ``` SORYXA_API_TOKEN=your-api-token ``` VariableDefaultDescription`SORYXA_API_TOKEN`requiredBearer token from your Soryxa dashboard`SORYXA_TIMEOUT``30`Request timeout in seconds`SORYXA_RETRIES``0`Number of retries on 5xx errors`SORYXA_RETRY_DELAY``100`Delay between retries in milliseconds`SORYXA_SILENT_ON_LIMIT``false`Return a local `review` result instead of throwing on usage-limit errorsQuick Start ----------- [](#quick-start) ``` use Elvesora\Soryxa\Facades\Soryxa; $result = Soryxa::validate('user@example.com'); if ($result->isAllowed()) { // Email is valid; proceed. } if ($result->isBlocked()) { // Email failed validation or matched a block rule. } if ($result->needsReview()) { // Email needs manual review or safe fallback handling. } ``` Policy, Headers, And Correlation -------------------------------- [](#policy-headers-and-correlation) `validate()` remains backward-compatible with `validate($email)`. Current optional arguments are: ``` $result = Soryxa::validate( 'user@example.com', 'signup', [ 'X-Soryxa-Correlation-Id' => 'checkout-2026-06-21-001', ], ); ``` Method signature: ``` validate( string $email, ?string $policyKey = null, array $headers = [], ): ValidationResult ``` `policy_key` is optional and defaults server-side to `default`. The validation API accepts only `email`, optional `policy_key`, and optional headers. Validation Result ----------------- [](#validation-result) The `ValidationResult` object exposes the full current response contract. ``` $result->decision; // allow, block, or review $result->reasonCode; // e.g. CLASSIFICATION_VALID $result->decisionMessage; // Internal/operator explanation $result->customerMessage; // Optional customer-safe message $result->decisionReasons; // Human-readable contributing reasons $result->policyKey; // Applied policy key, e.g. signup $result->score; // Final score, 0-100 $result->baseScore; // Base score before adjustments, 0-100 or null $result->scoreAdjustments; // Policy score adjustments $result->autoResolution; // Auto-resolution metadata or null $result->rollout; // Rollout telemetry $result->rawData; // Raw upstream validation data or null $result->upstream; // Upstream health/degradation metadata or null $result->data; // Full response data, including future additive fields $result->headers; // Captured response headers $result->usage; // Usage summary ``` Helper methods mirror the properties: ``` $result->decision(); $result->reasonCode(); $result->decisionMessage(); $result->customerMessage(); $result->decisionReasons(); $result->policyKey(); $result->score(); $result->baseScore(); $result->scoreAdjustments(); $result->autoResolution(); $result->rollout(); $result->upstream(); $result->data(); $result->headers(); ``` Response-header helpers: ``` $result->reasonCodeHeader(); // X-Soryxa-Reason-Code $result->correlationId(); // X-Soryxa-Correlation-Id $result->header('X-Soryxa-Correlation-Id'); ``` Decision helpers: ``` $result->isAllowed(); $result->isBlocked(); $result->needsReview(); $result->isLimitExceeded(); ``` Email And Checks ---------------- [](#email-and-checks) ``` $result->email(); $result->username(); $result->domain(); $result->firstName(); $result->lastName(); $result->classification(); $result->isSyntaxValid(); $result->hasMxRecords(); $result->isSmtpValid(); $result->isDisposable(); $result->isFreeProvider(); $result->isRoleAccount(); $result->isBogus(); $result->isCatchAll(); $result->isDomainRegistered(); $result->isNewlyRegisteredDomain(); ``` Each check is a `Check` object: ``` foreach ($result->checks as $check) { $check->name; $check->status; // passed, failed, warning, or error $check->message; $check->passed(); $check->failed(); $check->isWarning(); $check->isError(); } $result->getCheck('Domain MX'); $result->passedChecks(); $result->failedChecks(); $result->warningChecks(); ``` Usage Tracking -------------- [](#usage-tracking) Every successful API response includes current usage: ``` $result->usage->remaining; $result->usage->limit; $result->usage->usagePercent(); ``` Serialization ------------- [](#serialization) ``` $array = $result->toArray(); ``` `toArray()` includes all known fields, `usage`, `headers`, and any unknown future fields returned under `data`. Silent Mode ----------- [](#silent-mode) By default, exceeding your API usage limit throws `UsageLimitException`. If `SORYXA_SILENT_ON_LIMIT=true`, `validate()` returns a local fallback result instead: - `decision` is `review` - `reasonCode` is `LIMIT_EXCEEDED` - `decisionMessage` explains the quota state - `score` and `baseScore` are `0` - `isLimitExceeded()` returns `true` - `isAllowed()` returns `false` This keeps application code running without silently approving traffic when quota is exhausted. ``` $result = Soryxa::validate('user@example.com'); if ($result->isLimitExceeded()) { // Log, alert, queue for review, or ask the customer to retry later. } ``` Dependency Injection -------------------- [](#dependency-injection) ``` use Elvesora\Soryxa\SoryxaClient; use Illuminate\Http\Request; class EmailController { public function verify(Request $request, SoryxaClient $soryxa) { $result = $soryxa->validate( $request->email, 'signup', ['X-Soryxa-Correlation-Id' => (string) $request->headers->get('X-Request-Id')], ); return response()->json($result->toArray()); } } ``` Error Handling -------------- [](#error-handling) ``` use Elvesora\Soryxa\Facades\Soryxa; use Elvesora\Soryxa\Exceptions\AuthenticationException; use Elvesora\Soryxa\Exceptions\SubscriptionException; use Elvesora\Soryxa\Exceptions\InsufficientScopeException; use Elvesora\Soryxa\Exceptions\ValidationException; use Elvesora\Soryxa\Exceptions\UsageLimitException; use Elvesora\Soryxa\Exceptions\ServerException; use Elvesora\Soryxa\Exceptions\ConnectionException; use Elvesora\Soryxa\Exceptions\SoryxaException; try { $result = Soryxa::validate($email); } catch (AuthenticationException $e) { // 401: invalid, expired, or missing token. } catch (SubscriptionException $e) { // 402: no active subscription. } catch (InsufficientScopeException $e) { // 403: token lacks required scope. } catch (ValidationException $e) { // 422: invalid input. } catch (UsageLimitException $e) { // 429: usage limit exceeded. } catch (ServerException $e) { // 5xx: server-side error. } catch (ConnectionException $e) { // Network failure, timeout, or invalid response. } catch (SoryxaException $e) { // Other API error. } ``` Every exception exposes: ``` $e->getMessage(); $e->getErrorCode(); $e->getStatusCode(); $e->getResponseBody(); ``` Decision Reference ------------------ [](#decision-reference) The `decision` field is always one of: DecisionMeaning`allow`Email passed validation`block`Email failed validation or matched a block rule`review`Email is risky, degraded, quota-limited, or requires manual reviewCommon reason codes include: DecisionReason CodeDescription`allow``ALLOW_LIST_MATCH`Email matched your allow list`allow``CLASSIFICATION_VALID`Email classified as valid`allow``DEFAULT_ALLOW`No blocking rules triggered`block``BLOCK_LIST_MATCH`Email matched your block list`block``BLOCK_DISPOSABLE`Disposable email address blocked`block``BLOCK_FREE_PROVIDER`Free provider blocked by rules`block``BLOCK_ROLE_ACCOUNT`Role-based address blocked`block``BLOCK_BOGUS_DOMAIN`Domain is bogus or non-existent`block``SCORE_BELOW_BLOCK_THRESHOLD`Score below configured block threshold`block``CLASSIFICATION_INVALID`Email classified as invalid`review``SCORE_BELOW_THRESHOLD`Score below review threshold`review``CLASSIFICATION_RISKY`Email classified as risky`review``DISPOSABLE_REVIEW`Disposable address flagged for review`review``SERVICE_UNAVAILABLE`Upstream check unavailable`review``LIMIT_EXCEEDED`Local silent-mode fallback onlyDevelopment ----------- [](#development) Run the package contract checks: ``` composer test ``` License ------- [](#license) MIT ### Health Score 38 — LowBetter than 83% of packages Maintenance93 Actively maintained with recent releases Popularity2 Limited adoption so far Community6 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~100 days Total 2 Last Release 38d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/541009b7a92054d76583bac137139b098c30f23a4b6c9cce01a6c0f600c16ddc?d=identicon)[WebRegulus](/maintainers/WebRegulus) --- Top Contributors [![WebRegulus](https://avatars.githubusercontent.com/u/46540140?v=4)](https://github.com/WebRegulus "WebRegulus (3 commits)") --- Tags laravelvalidationemailsoryxa ### Embed Badge ![Health badge](/badges/elvesora-soryxa-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/elvesora-soryxa-laravel/health.svg)](https://phpackages.com/packages/elvesora-soryxa-laravel) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3345.4M354](/packages/psalm-plugin-laravel)[laravel/mcp Rapidly build MCP servers for your Laravel applications. 79227.1M231](/packages/laravel-mcp)[defstudio/telegraph A laravel facade to interact with Telegram Bots 818355.4k3](/packages/defstudio-telegraph)[api-platform/laravel API Platform support for Laravel 58190.1k21](/packages/api-platform-laravel)[erag/laravel-disposable-email A Laravel package to detect and block disposable email addresses. 265192.2k1](/packages/erag-laravel-disposable-email)[forjedio/inertia-table Backend-driven dynamic tables for Laravel + Inertia.js 272.0k](/packages/forjedio-inertia-table) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)