Unusual versions of the address, for testing sign-up forms

GET

/v1/addresses/{address}/variants

curl --request GET \
  --url https://api.proxymail.qa/v1/addresses/k7f2x9ab12cd%40mailclub.dev/variants \
  --header 'Authorization: Bearer <token>'

Variants of the address for checking that an app accepts valid but unusual email addresses and rejects invalid ones: delivered (capitals, plus tags with apostrophes and other special characters, the longest name allowed; mail to these arrives in this address’s inbox), undeliverable (valid by the standard but refused before they arrive) and invalid. See https://proxymail.qa/docs/unusual-addresses.

Authorizations

• apiKey

Parameters

Path Parameters

address

required

string format: email

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.

Example

k7f2x9ab12cd@mailclub.dev

Responses

200

The variants

Media typeapplication/json

object

address

The plain address.

string

delivered

Array<object>

object

tests

What the variant checks, e.g. “An apostrophe”.

string

address

string

undeliverable

Array<object>

object

tests

What the variant checks, e.g. “An apostrophe”.

string

address

string

invalid

Array<object>

object

tests

What the variant checks, e.g. “An apostrophe”.

string

address

string

Example ^generated

{
  "address": "example",
  "delivered": [
    {
      "tests": "example",
      "address": "example"
    }
  ],
  "undeliverable": [
    {
      "tests": "example",
      "address": "example"
    }
  ],
  "invalid": [
    {
      "tests": "example",
      "address": "example"
    }
  ]
}

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}