Live Telemetry
Stream outbound-delivery diagnostics as Server-Sent Events
Changed onOpens a text/event-stream connection that streams each stage of an outbound delivery attempt to target (a domain or email address): MX lookup, MTA-STS fetch, TLSA/DANE validation, SMTP conversation, and so on. Each SSE frame carries a JSON-encoded DeliveryStage wrapped in a single-element array (data: [{...}]). The stream ends with a final completed event. Requires LiveDeliveryTest permission; may also be authenticated via the ?token= query parameter obtained from /api/token/delivery.
get/api/live/delivery/{target}
Request
- Base URLhttps://mail.example.com
- Auth
- HTTP bearer
- or HTTP basic
- or API key in query parameter token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
targetstring required
Target domain or email address to diagnose
Query parameters
timeoutinteger
Maximum stream lifetime in seconds (minimum 1, default 30)
Response
Server-Sent Events stream of delivery-diagnose stages
Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking