Get a mailbox
GET
/mailboxes/{id}Returns a mailbox’s connection settings: its servers, ports and user names. Never its password.
Needs the permissionmailboxes:read
Settings tell anyone holding the key where the mail lives, so reading them has a permission of its own that only Full access includes.
Path parameters
idstringrequired- The mailbox.
Returns
idstring- The mailbox.
emailstring- The address.
displayNamestring- The name recipients see.
imapHoststring- With
imapPortandimapUsername: the incoming server. smtpHoststring- With
smtpPortandsmtpUsername: the outgoing server. smtpEncryptionstringtls,sslornone.ownerUserIdstring or null- The person it’s private to, or null when it’s shared.
accessobject or null- Who can see it:
{ "everyone": true }, or{ "everyone": false, "teamIds": […], "userIds": […] }for the teams and people ticked on it. Administrators always can. Null for a private mailbox. accessVersionstring or null- Send it back with a change to
accessin Update a mailbox to be told if someone else changed it first. Null for a private mailbox. teamIdstring or null- Kept for integrations written before October 2026: the first team ticked, or null for everyone, people only or private. Read
accessinstead. authMethodstringpassword,googleormicrosoft.groupAutomatedBySubjectboolean- Whether automated alerts with the same subject join one conversation. Off, each starts its own.
iconobject- How DMU Mail draws it:
style(default,icon,emojiorimage),background, and thename,emojiorimageits style uses.
Errors
401invalid_key- The key is wrong, expired or revoked. With no Authorization header at all, the code is
missing_credentials. 403missing_scope- The key doesn’t have
mailboxes:read. TheX-Required-Scopeheader names what’s missing. 404not_found- There’s no such mailbox, or the key’s owner can’t see it.
429rate_limited- More than 120 requests a minute from this key. Wait for
Retry-Afterseconds.