List of messages

API 0.16.0OpenAPIllms-full.txt

GET/v1/mailboxes/{mailbox_id}/messages

Returns up to 40 messages, from new UID to old. For the next page, pass next_before as before. For next_before=null there are no more pages. Read does not set the read flag.

Authentication and access · Errors and retries

Request

curl -X GET 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/messages' \
  -H 'Authorization: Bearer <access_token>'

Parameters

mailbox_idpathNecessarily

integer

folderquery

string

Default: "INBOX"

qquery

string

Default: ""

maxLength: 200

beforequery

Option 1

integer

exclusiveMinimum: 0

Option 2

null

X-Customer-IDheader

Option 1

string

Option 2

null

Responses

200 Successful response

application/json

object

items

array

Array elements

object

uid

integer

uidvalidity

integer

folder

string

message_id

string

thread_id

string

sender

string

recipients

array

Array elements

object

name

string

email

string

subject

string

preview

string

flags

array

Array elements

string

size_bytes

integer

received_at

string

Date and time in UTC. If there is no offset, the value also represents UTC.

next_before

Option 1

integer

Option 2

null

uidvalidity

integer

401 Login required

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

403 No access

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

404 Resource not found

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

409 State conflict

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

422 Validation error

application/json

object

detail

array

Array elements

object

locNecessarily

array

Array elements

Option 1

string

Option 2

integer

msgNecessarily

string

typeNecessarily

string

503 Temporarily unavailable

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object