Read settings
GET
/api/v1/mailbox/settingsThe mailbox holder's own settings, and storage used.
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/settingscurl -X GET 'https://courier.mailyte.com/api/v1/mailbox/settings' \
-H 'Authorization: Bearer MAILBOX_TOKEN'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/settings', {
method: 'GET',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://courier.mailyte.com/api/v1/mailbox/settings",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->get('https://courier.mailyte.com/api/v1/mailbox/settings');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/settings")
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_addressstringnamestring or nullThe display name recipients see.
signature_htmlstringsignature_on_replybooleandisplay_densitystringcomfortable | compactundo_send_enabledbooleanundo_send_secondsinteger5 | 10 | 20 | 30storageobjectused_mbnumberquota_mbnumberpercentagenumber or null
200
application/json{
"type": "success",
"msg": "Settings retrieved successfully",
"data": {
"email_address": "ada@yourdomain.com",
"name": "Ada Obi",
"signature_html": "<p>Ada Obi<br>Head of Finance</p>",
"signature_on_reply": true,
"display_density": "comfortable",
"undo_send_enabled": true,
"undo_send_seconds": 10,
"storage": {
"used_mb": 812.4,
"quota_mb": 5120,
"percentage": 15.9
}
}
}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.