Skip to main content
GET
List folder messages

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required
folder
string
required

Query Parameters

limit
string

1-100, default 25

offset
string

Default 0

sinceModseq
string

Only messages added or changed after this modseq (a previous response's highestModseq). Also returns UIDs removed since then in expunged. Results are ordered by UID ascending.

sinceUid
string

Only messages with a greater UID. Results are ordered by UID ascending.

unread
string

'true' for messages without \Seen

flagged
string

'true' for messages with \Flagged

Match subject, sender or recipients (received mail) or the raw header block (appended mail; bodies are not searched)

Response

Response for status 200

folder
string
required
uidValidity
number
required
uidNext
number
required
highestModseq
number
required
expunged
number[]
required

UIDs removed after sinceModseq (empty without sinceModseq)

data
object[]
required
pagination
object
required