API reference

API 0.16.0OpenAPIllms-full.txt

Authorization and account

POSTLogin in browser/v1/auth/loginPOSTGet a user token/v1/auth/tokenGETSaved sessions/v1/auth/sessionsPOSTSign out/v1/auth/logoutGETUser profile/v1/mePOSTCreate a sign-in link/v1/auth/login-linkPOSTExchange a link for a session/v1/auth/login-link/consume

Domains and mailboxes

GETDomain logo/v1/avatars/{domain}GETList of domains/v1/domainsGETDNS-domain records/v1/domains/{domain_id}/dnsGETMailboxes and usage/v1/mailboxesPATCHMailbox settings/v1/mailboxes/{mailbox_id}

Messages and conversations

GETFolders and counters/v1/mailboxes/{mailbox_id}/foldersPOSTCreating a folder/v1/mailboxes/{mailbox_id}/foldersGETList of messages/v1/mailboxes/{mailbox_id}/messagesGETEmail content/v1/mailboxes/{mailbox_id}/messages/{uid}POSTActions with messages/v1/mailboxes/{mailbox_id}/messages/actionsGETDownload the message at EML/v1/mailboxes/{mailbox_id}/messages/{uid}/emlGETDownload attachment/v1/mailboxes/{mailbox_id}/messages/{uid}/attachments/{index}GETList conversations/v1/mailboxes/{mailbox_id}/threadsGETConversation messages/v1/mailboxes/{mailbox_id}/threads/{thread_id}

Sending and operations

POSTSend a message/v1/mailboxes/{mailbox_id}/sendGETList of operations/v1/operationsGETOperation Status/v1/operations/{operation_id}POSTCancel sending/v1/operations/{operation_id}/cancelPOSTRetry an operation/v1/operations/{operation_id}/retry

Drafts

PUTSave draft/v1/mailboxes/{mailbox_id}/drafts/{draft_id}DELETEDelete draft/v1/mailboxes/{mailbox_id}/drafts/{draft_id}GETList of drafts/v1/mailboxes/{mailbox_id}/drafts

Sender Rules

PUTSender Rule/v1/mailboxes/{mailbox_id}/sender-rulesGETList of sender rules/v1/mailboxes/{mailbox_id}/sender-rulesDELETEDelete a sender rule/v1/mailboxes/{mailbox_id}/sender-rules/{rule_id}

Mailbox settings

GETEmail templates/v1/mailboxes/{mailbox_id}/templatesPOSTEmail templates/v1/mailboxes/{mailbox_id}/templatesPUTEmail templates/v1/mailboxes/{mailbox_id}/templates/{template_id}DELETEEmail templates/v1/mailboxes/{mailbox_id}/templates/{template_id}GETAutoresponder/v1/mailboxes/{mailbox_id}/autoresponderPUTAutoresponder/v1/mailboxes/{mailbox_id}/autoresponderGETFilters/v1/mailboxes/{mailbox_id}/filtersPOSTFilters/v1/mailboxes/{mailbox_id}/filtersPUTFilters/v1/mailboxes/{mailbox_id}/filters/{filter_id}DELETEFilters/v1/mailboxes/{mailbox_id}/filters/{filter_id}POSTApply to existing messages/v1/mailboxes/{mailbox_id}/filters/{filter_id}/apply

Contacts

GETContact list/v1/mailboxes/{mailbox_id}/contactsPOSTSave contact/v1/mailboxes/{mailbox_id}/contactsDELETEDelete contact/v1/mailboxes/{mailbox_id}/contacts/{contact_id}

Files

GETList of files/v1/mailboxes/{mailbox_id}/filesPOSTUpload file/v1/mailboxes/{mailbox_id}/filesGETDownload file/v1/mailboxes/{mailbox_id}/files/{file_id}/downloadGETFile Contents/v1/mailboxes/{mailbox_id}/files/{file_id}/contentDELETEDelete file/v1/mailboxes/{mailbox_id}/files/{file_id}