Emails received, newest first, with their codes and links
GET
/v1/addresses/{address}/messages
const url = 'https://api.proxymail.qa/v1/addresses/k7f2x9ab12cd%40mailclub.dev/messages?include=text&limit=20';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.proxymail.qa/v1/addresses/k7f2x9ab12cd%40mailclub.dev/messages?include=text&limit=20' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “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.devQuery Parameters
Section titled “Query Parameters”include
string
Add each email’s plain text (text), its HTML (html), or both (text,html), for tests that check the email itself. The HTML is the copy cleaned when the email arrived: scripts, frames and media dropped, form controls unwrapped, links other than web, mailto: and tel: removed, at most 200 KB. Both are written by the sender: treat them as untrusted.
limit
integer
Responses
Section titled “Responses”Emails
Media typeapplication/json
Array<object>
object
Example generated
[ {}]An error
Media typeapplication/json
object
error
string
message
string
Example generated
{ "error": "example", "message": "example"}