Reveal a saved test password

GET

/v1/addresses/{address}/password

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

Only for keys created with “Can read saved passwords”. Every reveal is logged.

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

Query Parameters

label

string

default: password

Responses

200

The secret

Media typeapplication/json

object

address

string

label

string

secret

string

Example ^generated

{
  "address": "example",
  "label": "example",
  "secret": "example"
}

403

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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