Skip to content
MailDock Docs

/mail/account

GET
/mail/account
curl --request GET \
  --url https://example.com/api/v1/mail/account \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
mailboxId
required
string
address
required
string
displayName
required
Any of:
string
quotaBytes
required
integer
>= -9007199254740991 <= 9007199254740991
usedBytes
required
integer
>= -9007199254740991 <= 9007199254740991
settings
required
object
signature
required
string
"" <= 10000 characters
signatureHtml
required
boolean
signatureAuto
required
boolean
default: true
signatureOnReplies
required
boolean
default: true
replyQuote
required
boolean
default: true
composePlain
required
boolean
messagesPerPage
required
integer
default: 50 >= 10 <= 200
threaded
required
boolean
default: true
readingPane
required
string
default: right
Allowed values: right bottom off
listWidth
required
integer
default: 380 >= 240 <= 1200
listHeight
required
integer
default: 320 >= 160 <= 1200
pinnedAtTop
required
boolean
default: true
density
required
string
default: comfortable
Allowed values: comfortable compact
theme
required
string
default: system
Allowed values: system light dark
locale
required
string
default: auto <= 35 characters /^(auto|[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*)$/
undoSendSeconds
required
integer
default: 5 <= 30
categories
required
object
enabled
required
boolean
promotions
required
boolean
default: true
social
required
boolean
default: true
updates
required
boolean
default: true
forums
required
boolean
default: true
senders
required
Array<object>
default: <= 500 items
object
address
required
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
tab
required
string
Allowed values: primary promotions social updates forums
avatarColour
required
string
default: blue
Allowed values: grey red amber green teal blue violet pink
labels
required
Array<object>
default: <= 20 items
object
keyword
required
string
/^[A-Za-z0-9_.-][A-Za-z0-9_.+-]{0,63}$/
name
required
string
>= 1 characters <= 40 characters
colour
required
string
Allowed values: grey red amber green teal blue violet pink
adminUrl
required
string format: uri
licenseNotice
required
Any of:
string
Allowed values: degraded restricted send_suspended
categoriesAllowed
required
boolean
Example
{
  "settings": {
    "signature": "",
    "signatureHtml": false,
    "signatureAuto": true,
    "signatureOnReplies": true,
    "replyQuote": true,
    "composePlain": false,
    "messagesPerPage": 50,
    "threaded": true,
    "readingPane": "right",
    "listWidth": 380,
    "listHeight": 320,
    "pinnedAtTop": true,
    "density": "comfortable",
    "theme": "system",
    "locale": "auto",
    "undoSendSeconds": 5,
    "categories": {
      "enabled": false,
      "promotions": true,
      "social": true,
      "updates": true,
      "forums": true,
      "senders": []
    },
    "avatarColour": "grey",
    "labels": []
  },
  "licenseNotice": "degraded"
}