Mailbox API

Everything the webmail does, for one mailbox. Takes a mailbox token, not an organization API key.

These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.

• GETSenders this mailbox has blocked/api/v1/mailbox/blocked-senders
• GETSubscription links for this mailbox/api/v1/mailbox/calendar-subscriptions
• GETCalendars in this mailbox/api/v1/mailbox/calendars
• GETWhat this deployment's webmail can actually do/api/v1/mailbox/capabilities
• GETAddresses this mailbox has written to/api/v1/mailbox/contacts
• GETList the mailbox's folders/api/v1/mailbox/folders
• GETMail forwarding settings/api/v1/mailbox/forwarding
• GETThe mailbox's own analytics/api/v1/mailbox/insights
• GETList messages in a folder/api/v1/mailbox/messages
• GETThe mailbox's filter rules/api/v1/mailbox/rules
• GETThe mailbox holder's security state/api/v1/mailbox/security
• GETThe mailbox holder's own settings/api/v1/mailbox/settings
• GETThe vacation responder/api/v1/mailbox/vacation
• POSTSign in to the webmail with mailbox credentials/api/v1/mailbox-auth/login
• POSTEnd the current webmail session/api/v1/mailbox-auth/logout
• POSTBlock a sender/api/v1/mailbox/blocked-senders
• POSTCreate a subscription link/api/v1/mailbox/calendar-subscriptions
• POSTCreate a folder/api/v1/mailbox/folders
• PUTUpdate mail forwarding/api/v1/mailbox/forwarding
• PUTReplace the mailbox's filter rules/api/v1/mailbox/rules
• PUTUpdate the mailbox holder's settings/api/v1/mailbox/settings
• PUTUpdate the vacation responder/api/v1/mailbox/vacation
• GETAddress books this mailbox can see/api/v1/mailbox/address-book/books
• GETSaved contacts/api/v1/mailbox/address-book/contacts
• GETThe mailbox holder's AI consent state/api/v1/mailbox/ai/consent
• GETThe current AI assistant terms/api/v1/mailbox/ai/terms
• GETInvitations awaiting an answer/api/v1/mailbox/calendar/invitations
• GETRooms and equipment you can invite/api/v1/mailbox/calendar/rooms
• GETRead one message/api/v1/mailbox/messages/{message_id}
• GETMessages waiting to be sent/api/v1/mailbox/messages/scheduled
• GETWhere this mailbox is signed in/api/v1/mailbox/security/sessions
• POSTSave a contact/api/v1/mailbox/address-book/contacts
• POSTLabel a batch of messages/api/v1/mailbox/ai/classify
• POSTDraft or rewrite a message with AI/api/v1/mailbox/ai/compose
• POSTAccept the AI assistant terms/api/v1/mailbox/ai/consent
• POSTWhen are these people busy/api/v1/mailbox/calendar/free-busy
• POSTSave a draft/api/v1/mailbox/messages/draft
• POSTSend a message/api/v1/mailbox/messages/send
• POSTChange this mailbox's password/api/v1/mailbox/security/password
• PATCHRename a folder/api/v1/mailbox/folders/{folder}
• DELETEWithdraw AI consent entirely/api/v1/mailbox/ai/consent
• DELETEUnblock a sender/api/v1/mailbox/blocked-senders/{address}
• DELETERevoke a subscription link/api/v1/mailbox/calendar-subscriptions/{token}
• DELETEDelete an empty folder/api/v1/mailbox/folders/{folder}
• DELETEPermanently delete a message/api/v1/mailbox/messages/{message_id}
• GETOne contact/api/v1/mailbox/address-book/contacts/{card_id}
• GETThe mailbox holder's consent history/api/v1/mailbox/ai/consent/history
• GETEvents overlapping a time range/api/v1/mailbox/calendars/{calendar}/events
• GETList a message's attachments/api/v1/mailbox/messages/{message_id}/attachments
• GETWho this message is with, and the shape of its conversation/api/v1/mailbox/messages/{message_id}/context
• GETDownload the original message (RFC 822)/api/v1/mailbox/messages/{message_id}/raw
• GETThe conversation a message belongs to/api/v1/mailbox/messages/{message_id}/thread
• POSTSummarise a message/api/v1/mailbox/ai/summarize/{message_id}
• POSTCreate an event/api/v1/mailbox/calendars/{calendar}/events
• POSTMark a message read/api/v1/mailbox/messages/{message_id}/mark-read
• POSTMark a message unread/api/v1/mailbox/messages/{message_id}/mark-unread
• POSTMove a message to another folder/api/v1/mailbox/messages/{message_id}/move
• POSTStar a message/api/v1/mailbox/messages/{message_id}/star
• POSTMove a message to Trash/api/v1/mailbox/messages/{message_id}/trash
• POSTUnstar a message/api/v1/mailbox/messages/{message_id}/unstar
• POSTStart two-factor enrolment/api/v1/mailbox/security/2fa/begin
• POSTConfirm two-factor enrolment with a code/api/v1/mailbox/security/2fa/confirm
• POSTTurn two-factor off/api/v1/mailbox/security/2fa/disable
• PUTReplace a contact/api/v1/mailbox/address-book/contacts/{card_id}
• DELETEDelete a contact/api/v1/mailbox/address-book/contacts/{card_id}
• DELETEWithdraw the training decision only/api/v1/mailbox/ai/consent/training
• DELETEDiscard a draft/api/v1/mailbox/messages/draft/{message_id}
• DELETECancel a scheduled send/api/v1/mailbox/messages/scheduled/{message_id}
• DELETESign out another device/api/v1/mailbox/security/sessions/{session_id}
• GETDownload one consent document/api/v1/mailbox/ai/consent/{consent_id}/document
• GETOne event/api/v1/mailbox/calendars/{calendar}/events/{event_id}
• GETDownload one attachment/api/v1/mailbox/messages/{message_id}/attachments/{index}
• POSTSummarise a whole conversation/api/v1/mailbox/ai/summarize/thread/{message_id}
• POSTAnswer an invitation/api/v1/mailbox/calendar/invitations/{invitation_id}/rsvp
• PUTReplace an event/api/v1/mailbox/calendars/{calendar}/events/{event_id}
• DELETEDelete an event/api/v1/mailbox/calendars/{calendar}/events/{event_id}