Inboxes

List messages, or wait for new ones

Without after: newest first, cursor-paginated. With after (an emailId from this inbox, or an ISO 8601 time): only newer messages, oldest first, and nextCursor is always null — loop by passing the last emailId you received as the next after. Add wait to hold the request open until a message arrives (up to 55 s); an empty data means none came. This is the way to wait for a verification email or a reply without running a webhook endpoint. Bodies are omitted; text is included.

get/v1/inboxes/{inboxId}/messages

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/inboxes/{inboxId}/messages
  • Auth: HTTP bearer

Path parameters

inboxIdstring required

Inbox id.

Query parameters

cursorstring

Pagination cursor — an OPAQUE token. Take the nextCursor from the previous page and send it back unchanged. Do not parse it, do not coerce it to a number, and do not construct one: the format is <unixMs>.<objectId> today and may change. A cursor that cannot be parsed is rejected with 422 validation_error rather than silently restarting at page one.

limitinteger

Page size (1–100, default 50).

direction'inbound' | 'outbound'
afterstring

An emailId or ISO 8601 time.

waitinteger

Seconds to wait for a message when after is set.

labelstring
includeHeld'true' | 'false'

Include messages held by the security scan.

Response

Messages.

nextCursorstring nullable required

Opaque token. Pass back as cursor verbatim to fetch the next page; null when there are no more rows.

Changes

No recorded changes to this operation across all 1 revision of this API.