What this mailbox can do
GET
/api/v1/mailbox/capabilitiesWhich features this mail server offers this mailbox, and the shared mailboxes it may use. Call it once after signing in and hide what is off.
Errors
| Status | When |
|---|---|
401 |
No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login. |
403 |
The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required. |
Request
GET
/api/v1/mailbox/capabilitiescurl -X GET 'https://courier.mailyte.com/api/v1/mailbox/capabilities' \
-H 'Authorization: Bearer MAILBOX_TOKEN'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/capabilities', {
method: 'GET',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://courier.mailyte.com/api/v1/mailbox/capabilities",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->get('https://courier.mailyte.com/api/v1/mailbox/capabilities');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/capabilities")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataobjectemail_addressstringcapabilitiesobjectmailbooleansendbooleansettingsbooleantwo_factorbooleanrulesbooleanforwardingbooleanvacationbooleanaibooleancalendarbooleancontactsbooleanscheduled_sendbooleanbulk_actionsboolean
shared_mailboxesarray<object>addressstringnamestringpermissionstringread, send or full.
can_sendboolean
200
application/json{
"type": "success",
"msg": "Capabilities",
"data": {
"email_address": "ada@yourdomain.com",
"capabilities": {
"mail": true,
"send": true,
"settings": true,
"two_factor": true,
"rules": true,
"forwarding": true,
"vacation": true,
"ai": false,
"calendar": true,
"contacts": true,
"scheduled_send": true,
"bulk_actions": true
},
"shared_mailboxes": [
{
"address": "finance@yourdomain.com",
"name": "Finance",
"permission": "send",
"can_send": true
}
]
}
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |
403 | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |
Every status, with what causes it and what to do, is on the error reference.