Skip to main content
POST
Wait for the oldest matching captured email at a full address

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Headers

Idempotency-Key
string

Replays the stored response for 24h when the same key is sent again (1–255 visible ASCII)

X-DevHelm-Client
string

Calling surface and version, e.g. cli/1.4.0 or sdk-js/2.0.0

Body

application/json

Wait for the oldest matching captured email message

timeoutMs
integer<int32> | null

How long to block in milliseconds (default: 30000, max: 120000)

receivedAfter
string<date-time> | null

Oldest eligible receivedAt; default now minus 60 seconds

to
string | null

Full address on POST /email/wait

subjectContains
string | null

Subject must contain this substring

domain
string | null

Domain FQDN; required on POST /email/{localpart}/wait

Response

OK

Successful email message wait

message
object
required

Captured inbound email (preview, not RFC822 bytes)