Delivery Test

Check test status

Check delivery test status

get/v1/delivery-test/check/{deliveryTest}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/delivery-test/check/{deliveryTest}
  • Auth: HTTP bearer

Path parameters

deliveryTeststring required

Test ID

Example:6420a6ad-7f82-4e4f-8112-82a9dad1f34d

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the test result once it has completed, including SPF, DKIM and DMARC outcomes.

successboolean

Was the test completed

statusstring

Test status. Only present while the test message has not yet been received (success=false)

dkimDkimResults

DKIM results

spfSpfResults

SPF results

dmarcDmarcResults

DMARC results

bimiBimiResults

BIMI results

arcArcResults

ARC results

mainSigMainSignature

Primary DKIM signature. status.aligned should be set, otherwise DKIM check should not be considered as passed.

Example response

{
  "success": true,
  "status": "pending"
}

Changes

No recorded changes to this operation across all 1 revision of this API.