Mailwurf

Messages

GET
/v1/inboxes/{id}/messages

Newest first. subject is a case-insensitive substring. after is a message id.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Query Parameters

subject?string

Case-insensitive substring of Subject.

after?string

Message id. Only later messages are returned.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inboxes/string/messages"
{  "messages": [    {      "id": "string",      "inbox_id": "string",      "from": "string",      "to": "string",      "subject": "string",      "text": "string",      "html": "string",      "links": [        "http://example.com"      ],      "otp": "string",      "received_at": "2019-08-24T14:15:22Z"    }  ]}
POST
/v1/inboxes/{id}/messages

from is the inbox address and cannot be set. Local recipients on the Mailwurf domain are delivered into that inbox so wait works. Internet recipients go out over SMTP from the mail worker.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inboxes/string/messages" \  -H "Content-Type: application/json" \  -d '{    "to": "string",    "subject": "string"  }'
{  "id": "string",  "status": "string"}
GET
/v1/inboxes/{id}/messages/wait

Keep one request open. Do not poll. Matching is oldest-first. If a match is already stored, it returns immediately. At most four waits may run at once per API key.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Query Parameters

subject?string

Case-insensitive substring of Subject.

after?string

Message id. Only later messages are returned.

timeout?integer

Milliseconds to wait. Default 15000. Max 120000. 0 is a single lookup.

Range0 <= value <= 120000
Default15000

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inboxes/string/messages/wait"
{  "id": "string",  "inbox_id": "string",  "from": "string",  "to": "string",  "subject": "string",  "text": "string",  "html": "string",  "links": [    "http://example.com"  ],  "otp": "string",  "received_at": "2019-08-24T14:15:22Z"}
GET
/v1/messages/{id}

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/messages/string"
{  "id": "string",  "inbox_id": "string",  "from": "string",  "to": "string",  "subject": "string",  "text": "string",  "html": "string",  "links": [    "http://example.com"  ],  "otp": "string",  "received_at": "2019-08-24T14:15:22Z"}