Skip to content
MailDock Docs

/mail/messages

GET
/mail/messages
curl --request GET \
  --url 'https://example.com/api/v1/mail/messages?folder=INBOX&limit=50&unseen=true&flagged=true&attachments=true&pinned=true&category=primary' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
folder
string
default: INBOX
before
integer
> 0 <= 9007199254740991
limit
integer
default: 50 >= 1 <= 200
q
string
<= 200 characters
unseen
string
Allowed values: true false
flagged
string
Allowed values: true false
attachments
string
Allowed values: true false
since
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
until
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
keyword
string
/^[A-Za-z0-9_.-][A-Za-z0-9_.+-]{0,63}$/
pinned
string
Allowed values: true false
category
string
Allowed values: primary promotions social updates forums

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
folder
required
string
items
required
Array<object>
object
uid
required
integer
>= -9007199254740991 <= 9007199254740991
folder
required
string
messageId
required
Any of:
string
inReplyTo
required
Any of:
string
references
required
Array<string>
default:
subject
required
string
from
required
Array<object>
object
name
required
Any of:
string
address
required
string
to
required
Array<object>
object
name
required
Any of:
string
address
required
string
date
required
Any of:
string
size
required
integer
>= -9007199254740991 <= 9007199254740991
flags
required
Array<string>
seen
required
boolean
flagged
required
boolean
answered
required
boolean
hasAttachments
required
boolean
preview
Any of:
string
total
required
integer
>= -9007199254740991 <= 9007199254740991
next
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "items": [
    {
      "references": []
    }
  ]
}