Check that no email arrives

Holds for up to timeout seconds and passes (200) if no matching email reaches the address in that time, for checks such as "an unsubscribed user gets nothing" or "a second reset request is rate-limited". Fails at once (409, error email_arrived) when one arrives, saying when and from whom, never what it says. Pass since as the time the action happened, so an email that came before the call still counts. For longer checks, call again with the same since.

get/v1/addresses/{address}/none

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/{address}/none
  • Auth: HTTP bearer

Path parameters

addressstring email required

The test address, URL-encoded. A variant also works: capitals, or a +tag (k7f2x9ab12cd+o'brien@mailclub.dev). It acts on the plain address; waiting on a +tag variant, or listing its messages, only finds mail sent to that variant.

Query parameters

sincestring date-time

Only email received at or after this time. Default: the time of the request.

timeoutinteger

Seconds to watch. 0 checks once.

servicestring

Only email from this service, by name or domain (e.g. 'spotify').

type'code' | 'link'

Only emails with a code, or with a link. Codes leave out coupons, and links count verify, magic_signin, invite and reset, unless subtype says otherwise.

subtypestring

With type, comma-separated: otp or coupon for codes; verify, magic_signin, invite, reset or other for links; or any.

Headers

Proxy-Mail-QA-Runstring uuid

A run's id (POST /v1/runs): adds what this call saw to the run. If it can't be added (the run finished, or isn't in this project), the call still works and the Proxy-Mail-QA-Run-Warning response header says why.

Proxy-Mail-QA-Teststring

With Proxy-Mail-QA-Run: the test this call belongs to, percent-encoded (encodeURIComponent), up to 200 characters once decoded. The run's report shows it beside what the call saw.

Proxy-Mail-QA-Run-Retry'true'

true when you'll call again if nothing arrives (waits longer than 30 seconds), so only the last call's "nothing arrived" is added to the run.

Response

Nothing arrived

addressstring
sincestring date-time
arrivedfalse
untilstring date-time

Nothing matching arrived between since and this time.

Changes

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