List messages in a folder

GET/api/v1/mailbox/messages
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Newest first, server-side searched and paged. q is resolved by IMAP SEARCH against Dovecot's own indexes -- including message bodies -- so a word buried deep in an email is findable, which a client-side search over preview text can never be.

Parameters

NameInTypeDescription
folderquerystring
searchquerystring
qquerystring
unreadqueryboolean
starredqueryboolean
limitqueryinteger
offsetqueryinteger

Request

GET/api/v1/mailbox/messages
curl -X GET 'https://app.mailyte.com/api/v1/mailbox/messages' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Successful Response

Returned inside the standard envelope.

Errors

StatusWhen
422Validation Error

Every status, with what causes it and what to do, is on the error reference.