Skip to content
Docs

Overview

Proxy Mail QA API 1.0.0

Section titled “Proxy Mail QA API 1.0.0”

Create disposable test inboxes and get the verification code or link from the email that arrives, in one call that waits for it. Every request uses an API key, created in Project settings → API keys; a key works within one project. Codes and links come back on their own: the email’s text and HTML are only returned by /messages when asked for, since they are written by the sender.

Guide

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/project
POST
/v1/project/dev-hosts
GET
/v1/addresses
POST
/v1/addresses
GET
/v1/addresses/{address}
DELETE
/v1/addresses/{address}
PATCH
/v1/addresses/{address}
GET
/v1/addresses/{address}/code
GET
/v1/addresses/{address}/link
GET
/v1/addresses/{address}/count
GET
/v1/addresses/{address}/none
GET
/v1/addresses/{address}/messages
GET
/v1/addresses/{address}/variants
GET
/v1/addresses/{address}/checks
GET
/v1/addresses/{address}/delivery
GET
/v1/addresses/{address}/password
PUT
/v1/addresses/{address}/password
POST
/v1/form-values
POST
/v1/addresses/checkout
POST
/v1/addresses/sign-in
POST
/v1/addresses/{address}/extend
POST
/v1/addresses/{address}/return
GET
/v1/runs
POST
/v1/runs
GET
/v1/runs/{run}
POST
/v1/runs/{run}/notes
POST
/v1/runs/{run}/tests
POST
/v1/runs/{run}/finish

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

An API key: qa_…

Security scheme type: http