Check why mail is or isn't arriving

What has reached the address, every message we refused for it (too large, or over an hourly or daily limit) and one sentence on what that means, such as an email provider in sandbox mode. Doesn't wait. A 404 says what an unknown address can mean.

get/v1/addresses/{address}/delivery

Request

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

Response

The address's delivery status

addressstring
created_atstring date-time
expires_atstring date-time
receivingboolean

False once the address has expired: mail to it is refused.

emailsinteger

Emails received so far.

last_email_atstring date-time nullable
hintstring

What the status means, most important first.

helpstring uri

Example response

{
  "help": "https://proxymail.qa/troubleshooting"
}

Changes

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