Mail received on your domains
GET/v1/emails/inbound
Every message delivered to an address on one of your verified domains, newest first, bodies included. A domain receives once its MX record points at Woyra (the record is in the domain's records); nothing else is set up, and every address on the domain is an inbox.
Each message also arrives as an email.received webhook when it is stored, carrying the text (up to 10,000 characters), the attachment list and, for a reply to something you sent, the id of that email. Requires emails:read.
Parameters
| Name | In | Description |
|---|---|---|
| limit | query | |
| cursor | query | The next_cursor from the previous page. |
| Woyra-Version | header | The dated API version to serve. Omit to pin to the oldest supported version. |
Example
curl https://api.woyra.io/v1/emails/inbound \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 A page of received emails.
| Field | Type | Description |
|---|---|---|
| object | "list" | |
| data | array of InboundEmail | |
| has_more | boolean | |
| next_cursor | string |
Errors
| Status | Codes |
|---|---|
| 401 | authentication_required, invalid_api_key |
| 403 | insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required |
Also in Emails
- GET /v1/emails — List emails
- POST /v1/emails — Send an email
- GET /v1/emails/{id} — Retrieve an email
- POST /v1/emails/{id}/cancel — Cancel a scheduled email
- POST /v1/emails/batch — Send a batch of emails
- GET /v1/templates — List templates
- POST /v1/templates — Save an email template
- GET /v1/templates/{id} — Retrieve a template
- PATCH /v1/templates/{id} — Change a template
- DELETE /v1/templates/{id} — Delete a template
- GET /t/o/{token} — Open tracking image
- GET /t/c/{token} — Click tracking redirect
- GET /v1/emails/inbound/{id} — Retrieve a received email
- GET /v1/emails/inbound/{id}/attachments/{attachment_id} — Download an attachment
- GET /v1/emails/threads/{id} — A conversation