Check an email

Runs checks on one email the address received: the one named by email_id, or the newest matching the filters. Doesn't wait: wait for the email first (/code, /link or /count). Each check passes, fails, warns or is skipped, with a one-line reason: SPF, DKIM and DMARC (the receiving server's verdicts), links to localhost or a private address (also after a redirect), plain http links, the site its sign-in, verify, reset or invite link goes to (expect_host), whether it says when its code or link expires, a plain-text version, the HTML's size against Gmail's 102 KB limit, image-only emails, whether it fits a phone, and, when asked, given phrases (expect_text) and the language (expect_language). Verdicts only: never the email's text or its links (reasons name at most a domain or a link's host).

get/v1/addresses/{address}/checks

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/{address}/checks
  • 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

email_idstring uuid

The email to check, as /count gives it. Default: the newest that matches.

sincestring date-time

Only email received at or after this time.

expect_hoststring

The site its sign-in, verify, reset or invite link should go to, after any redirect (subdomains count). Without it, that check is skipped.

expect_textstring[]

A phrase the subject or body should contain; repeat for more (up to 10). Case, curly quotes and spacing don't matter, and the answer names only the missing ones.

expect_languagestring

The language it should be in, such as de or pt-BR. Without it, that check is skipped.

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.

Response

The checks

addressstring
passedboolean

No check failed. Warnings don't count.

failedstring[]
warningsstring[]

Example response

{
  "checks": [
    {
      "detail": "The sending server is allowed to send for acme.example."
    }
  ]
}

Changes

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