Skip to Content

Every method of the TypeScript SDK, namespace by namespace, in the order the API reference presents them, each with the operation it calls.

All 318 methods, in 46 namespaces: every operation of the API is one, and each has a page of its own.

openemail.accounts

The tenant itself: its lifecycle (delete and restore), its mailbox recovery and retention policies, its limits and how each is enforced, its usage, traffic, API call and allowance meters, its delivery event log, its limit incidents and its audit trail. Its page.

MethodWhat it doesIt calls
accounts.getGet account detailsGET /accounts/{accountId}
accounts.deleteDelete an accountDELETE /accounts/{accountId}
accounts.restoreRestore deleted accountPOST /accounts/{accountId}/restore
accounts.setRecoveryPolicySet the account's mailbox recovery policyPUT /accounts/{accountId}/recovery-policy
accounts.listRetentionPreview retention across an account's mailboxesGET /accounts/{accountId}/retention
accounts.setRetentionSet account default retention windowPUT /accounts/{accountId}/retention
accounts.clearRetentionClear account default retention windowDELETE /accounts/{accountId}/retention
accounts.getLimitsGet an account's limits and enforcement stateGET /accounts/{accountId}/limits
accounts.getUsageGet daily account usage metricsGET /accounts/{accountId}/usage
accounts.getStorageUsageGet account storage pool usageGET /accounts/{accountId}/storage-usage
accounts.getSendUsageGet account send rate limit usageGET /accounts/{accountId}/send-usage
accounts.getReceiveUsageGet account receive allowance usageGET /accounts/{accountId}/receive-usage
accounts.getTrafficGet account traffic statisticsGET /accounts/{accountId}/traffic
accounts.getRequestsGet account API call countsGET /accounts/{accountId}/requests
accounts.listEventsQuery account delivery event logGET /accounts/{accountId}/events
accounts.listLimitIncidentsList an account's limit incidentsGET /accounts/{accountId}/limit-incidents
accounts.listAuditList account audit trailGET /accounts/{accountId}/audit
accounts.listIdentitiesByActivityList an account's identities by recent activityGET /accounts/{accountId}/activity

openemail.verifiedRecipients

An account's verified recipients, the outside addresses it may send to while it is not yet vetted: add one (its owner confirms it from the link mailed to it), list them, remove one, and the owner's public confirmation link. Its page.

openemail.auth

Which credential the client holds, and what it reaches. Its page.

MethodWhat it doesIt calls
auth.whoamiGet current authenticated identityGET /auth/whoami

openemail.apiKeys

Account API keys (oek_): mint one, list them, revoke one. Its page.

MethodWhat it doesIt calls
apiKeys.createCreate API keyPOST /api-keys
apiKeys.listList API keysGET /api-keys
apiKeys.revokeRevoke an API keyDELETE /api-keys/{apiKeyId}

openemail.credentials

An identity's own sign-in credentials: its password and its app passwords (oemp_), each reaching that one mailbox. Its page.

openemail.passwords

An identity's login password: change it, reset it as an administrator, or invite its user to set their own. Its page.

MethodWhat it doesIt calls
passwords.changeChange mailbox login passwordPUT /identities/{identityId}/password
passwords.resetReset a mailbox password as an administratorPOST /identities/{identityId}/password/reset
passwords.inviteInvite a mailbox user to set their own passwordPOST /identities/{identityId}/invitation

openemail.recovery

How an identity gets back in: its recovery address (set, confirm, remove), its recovery codes, and the posture they add up to. Its page.

openemail.securityKeys

An identity's WebAuthn security keys: register one in two steps, list them, remove one. Its page.

openemail.domains

A customer domain and what hangs off it: registration and DNS checks, its branding and logo, its event webhook, and its usage, traffic and delivery events. Its page.

openemail.branding

The public branding a sign-in screen reads before anyone signs in: a domain's brand name and logo, by domain or by hostname. No credential is sent. Its page.

MethodWhat it doesIt calls
branding.getGet public branding for domainGET /branding/{domain}
branding.getLogoGet public logo imageGET /branding/{domain}/logo
branding.getByHostGet public branding by hostnameGET /branding/by-host/{host}

openemail.hostnames

A domain's vanity hostnames (mail, smtp, webmail, dav, mx): list them, set one, remove one, check their DNS. Its page.

openemail.dmarc

What receivers report about a domain's mail: the DMARC summary, the reports ingested and the sources sending as the domain. Its page.

MethodWhat it doesIt calls
dmarc.getSummaryGet DMARC report summaryGET /domains/{domain}/dmarc
dmarc.listReportsList ingested DMARC reportsGET /domains/{domain}/dmarc/reports
dmarc.listSourcesList DMARC sending sourcesGET /domains/{domain}/dmarc/sources

openemail.identities

The identities of an account, its mailboxes and calendar-only users: create, list, read, update, delete and restore them, their addresses, the clients they sign in with and their saved preferences. Its page.

openemail.mailboxes

A mailbox's mail settings: its usage, its retention window, its event and message webhooks, what delivers to it, the addresses it may send as and whether it may send. Its page.

MethodWhat it doesIt calls
mailboxes.getGet mailbox details and usage statisticsGET /mailboxes/{mailboxId}
mailboxes.getRetentionGet retention policy and previewGET /mailboxes/{mailboxId}/retention
mailboxes.setRetentionSet retention windowPUT /mailboxes/{mailboxId}/retention
mailboxes.clearRetentionClear retention windowDELETE /mailboxes/{mailboxId}/retention
mailboxes.getEventWebhookRead the mailbox's event webhookGET /mailboxes/{mailboxId}/event-webhook
mailboxes.setEventWebhookCreate or replace the mailbox's event webhookPUT /mailboxes/{mailboxId}/event-webhook
mailboxes.deleteEventWebhookRemove the mailbox's event webhookDELETE /mailboxes/{mailboxId}/event-webhook
mailboxes.testEventWebhookSend a test event to the mailbox's event webhookPOST /mailboxes/{mailboxId}/event-webhook/test
mailboxes.getMessageWebhookRead the mailbox's message webhookGET /mailboxes/{mailboxId}/message-webhook
mailboxes.setMessageWebhookCreate or replace the mailbox's message webhookPUT /mailboxes/{mailboxId}/message-webhook
mailboxes.deleteMessageWebhookRemove the mailbox's message webhookDELETE /mailboxes/{mailboxId}/message-webhook
mailboxes.getRoutingList what delivers to a mailboxGET /mailboxes/{mailboxId}/routing
mailboxes.listSendAsList the addresses a mailbox may send asGET /mailboxes/{mailboxId}/send-as
mailboxes.checkSendAsCheck whether a mailbox may send from an addressPOST /mailboxes/{mailboxId}/send-as/check
mailboxes.getSendUsageGet outbound send rate limit usageGET /mailboxes/{mailboxId}/send-usage
mailboxes.getSendStateGet whether a mailbox may sendGET /mailboxes/{mailboxId}/send-state

openemail.mailboxShares

Sharing a mailbox with other identities: grant and revoke their access, list who has it, and list the mailboxes shared with you. Its page.

MethodWhat it doesIt calls
mailboxShares.grantGive another user access to this mailboxPUT /mailboxes/{mailboxId}/shares/{granteeIdentityId}
mailboxShares.revokeRemove another user's access to this mailboxDELETE /mailboxes/{mailboxId}/shares/{granteeIdentityId}
mailboxShares.listList who has access to this mailboxGET /mailboxes/{mailboxId}/shares
mailboxShares.listSharedWithMeList mailboxes shared with youGET /shared-mailboxes

openemail.routes

What an address does when mail arrives: a route to a mailbox, a webhook, a remote address or a group, and a group's members. Its page.

openemail.patterns

Pattern (wildcard) routes: an address shape on a domain, and where its mail goes. Its page.

MethodWhat it doesIt calls
patterns.createCreate pattern routePOST /patterns
patterns.listList pattern routesGET /patterns
patterns.updateUpdate pattern routePATCH /patterns/{patternId}
patterns.deleteDelete pattern routeDELETE /patterns/{patternId}

openemail.accountAddressLists

An account's address lists: named allow and block lists for inbound or outbound mail, the patterns they hold, and a test of the policy they add up to. Its page.

openemail.mailboxAddressLists

A mailbox's address lists: the same allow and block lists, read and written through one mailbox. Its page.

openemail.filtering

A mailbox's spam filtering settings. Its page.

MethodWhat it doesIt calls
filtering.getGet mailbox filtering settingsGET /mailboxes/{mailboxId}/filtering
filtering.updateUpdate mailbox filtering settingsPUT /mailboxes/{mailboxId}/filtering

openemail.rules

A mailbox's filter rules: one flat, ordered list, compiled to Sieve and run on every arrival. Its page.

MethodWhat it doesIt calls
rules.getGet mailbox filter rulesGET /mailboxes/{mailboxId}/rules
rules.setSave and activate filter rulesPUT /mailboxes/{mailboxId}/rules
rules.deleteDelete mailbox filter rulesDELETE /mailboxes/{mailboxId}/rules

openemail.sieve

A mailbox's Sieve scripts: what the engine supports, checking a script, storing, renaming and deleting scripts, and which one is active. Its page.

openemail.vacation

A mailbox's out-of-office auto-reply. Its page.

MethodWhat it doesIt calls
vacation.getGet out-of-office auto-reply settingsGET /mailboxes/{mailboxId}/vacation
vacation.setUpdate out-of-office auto-reply settingsPUT /mailboxes/{mailboxId}/vacation

openemail.forwarding

A mailbox's forwarding: forward everything to one destination, pause it, stop it, add and confirm destinations, and the recipient's public disable link. Its page.

openemail.labels

Folders and labels: create, rename and delete them, update every message in one, and the IMAP-shaped UID and vanished feeds a mail client syncs from. Its page.

openemail.pickups

POP3 pickup sources: mail fetched from an external POP3 account into a mailbox. Its page.

openemail.messages

The message store: list and read messages (metadata, parsed content, raw MIME, parts), update and delete them one by one or in batches, append, compose and copy them, restore them, train the spam filter, follow the changes feed, and send. Its page.

MethodWhat it doesIt calls
messages.listList mailbox messagesGET /mailboxes/{mailboxId}/messages
messages.getGet message metadataGET /mailboxes/{mailboxId}/messages/{messageId}
messages.getManyBatch get message metadataPOST /mailboxes/{mailboxId}/messages/batch
messages.getContentGet parsed message content and attachmentsGET /mailboxes/{mailboxId}/messages/{messageId}/content
messages.getRawGet raw MIME message bodyGET /mailboxes/{mailboxId}/messages/{messageId}/raw
messages.getPartGet specific message MIME partGET /mailboxes/{mailboxId}/messages/{messageId}/parts/{section}
messages.getRawHeadersBatch get raw header blocksPOST /mailboxes/{mailboxId}/messages/heads
messages.getMimeStructuresBatch get cached MIME structuresPOST /mailboxes/{mailboxId}/messages/mime
messages.updateUpdate message flags and labelsPATCH /mailboxes/{mailboxId}/messages/{messageId}
messages.updateManyUpdate flags and labels for multiple messages or whole conversationsPATCH /mailboxes/{mailboxId}/messages
messages.deleteDelete a messageDELETE /mailboxes/{mailboxId}/messages/{messageId}
messages.deleteManyEmpty trash, or delete a batch of messages or whole conversationsDELETE /mailboxes/{mailboxId}/messages
messages.appendAppend raw MIME message to mailboxPOST /mailboxes/{mailboxId}/messages
messages.composeSave structured message to mailboxPOST /mailboxes/{mailboxId}/messages/compose
messages.copyCopy or move messages and conversations into another mailboxPOST /mailboxes/{mailboxId}/messages/copy
messages.restoreRestore an expunged message from trashPOST /mailboxes/{mailboxId}/messages/{messageId}/restore
messages.restoreManyRestore multiple messages from trashPOST /mailboxes/{mailboxId}/messages/restore
messages.untrashTake messages out of Trash, back to where they were filedPOST /mailboxes/{mailboxId}/messages/untrash
messages.unjunkTake messages out of Junk, back to where they were filedPOST /mailboxes/{mailboxId}/messages/unjunk
messages.learnTrain spam filter from a messagePOST /mailboxes/{mailboxId}/messages/{messageId}/learn
messages.learnManyTrain spam filter from multiple messagesPOST /mailboxes/{mailboxId}/messages/learn
messages.listKeywordsList the keywords in use, with countsGET /mailboxes/{mailboxId}/keywords
messages.getChangesGet message sync changesGET /mailboxes/{mailboxId}/messages/changes
messages.sendSend an email messagePOST /mailboxes/{mailboxId}/send
messages.sendDraftSend a stored draftPOST /mailboxes/{mailboxId}/messages/{messageId}/submit
messages.getDeliveryGet delivery status of a sent messageGET /mailboxes/{mailboxId}/messages/{messageId}/delivery
messages.getInvitationGet invitation from email messageGET /mailboxes/{mailboxId}/messages/{messageId}/invitation

openemail.search

Finding messages: full-text search, structured queries and the updates they select, highlighted snippets, meaning-based (semantic) search and similar messages. Its page.

MethodWhat it doesIt calls
search.fullTextFull-text search a mailboxGET /mailboxes/{mailboxId}/search
search.queryStructured filter and query messagesPOST /mailboxes/{mailboxId}/search/query
search.updateMatchesUpdate flags, labels and keywords for every message a search selectsPATCH /mailboxes/{mailboxId}/search/query
search.snippetsHighlighted excerpts for search resultsPOST /mailboxes/{mailboxId}/search/snippets
search.semanticSemantic (meaning-based) search of a mailboxGET /mailboxes/{mailboxId}/search/semantic
search.similarMessages similar to one messageGET /mailboxes/{mailboxId}/messages/{messageId}/similar

openemail.threads

Conversations: list a mailbox's threads, read one, and reply to it. Its page.

openemail.uploads

Attachment bytes staged once, then named by their blobId when sending or composing. Its page.

MethodWhat it doesIt calls
uploads.createStage a binary attachment uploadPOST /mailboxes/{mailboxId}/uploads

openemail.scheduled

Scheduled sends: list them, read one, change its release time, cancel one or all of them. Its page.

openemail.deliveries

What became of sent mail, recipient by recipient, and the signed links a webhook payload carries for bodies too large to inline. Its page.

MethodWhat it doesIt calls
deliveries.listList delivery statuses for a thread or a set of messagesGET /mailboxes/{mailboxId}/deliveries
deliveries.downloadFetch webhook attachment or raw messageGET /deliveries/fetch/{token}

openemail.mta

The raw-MIME doors the mail transfer agents use: a recipient check, outbound submission and inbound delivery. Its page.

MethodWhat it doesIt calls
mta.checkRecipientCheck recipient deliverabilityGET /deliver/check
mta.submitOutboundSubmit outbound email messagePOST /deliver/outbound
mta.deliverInboundDeliver inbound email messagePOST /deliver/inbound

openemail.suppressions

The deployment-wide do-not-send list: list your account's complaint entries, read an address's entry, and lift your own hard-bounce entries. Its page.

MethodWhat it doesIt calls
suppressions.listList email suppressionsGET /suppressions
suppressions.getGet suppression status for an addressGET /suppressions/{address}
suppressions.removeRemove email address from suppression listDELETE /suppressions/{address}

openemail.pushSubscriptions

Web Push (RFC 8030) device registrations: register an endpoint, verify or extend it, list them, delete one. Its page.

MethodWhat it doesIt calls
pushSubscriptions.createRegister a push subscriptionPOST /push-subscriptions
pushSubscriptions.listList push subscriptionsGET /push-subscriptions
pushSubscriptions.updateVerify or extend a push subscriptionPATCH /push-subscriptions/{id}
pushSubscriptions.deleteDelete a push subscriptionDELETE /push-subscriptions/{id}

openemail.freeBusy

Free and busy time: one identity's, or several addresses' at once. Its page.

MethodWhat it doesIt calls
freeBusy.getFree/busy for an identityGET /identities/{identityId}/free-busy
freeBusy.getManyFree/busy for several addressesPOST /identities/{identityId}/pim/free-busy

openemail.schedulingInbox

The calendar scheduling messages (iTIP) waiting for an identity: list them, read one, consume one. Its page.

openemail.calendars

Calendars: create, read, update and delete them, their trash, their changes feed, import and export, sharing, feed tokens, and the invitations that arrive by email. Its page.

MethodWhat it doesIt calls
calendars.createCreate calendarPOST /identities/{identityId}/calendars
calendars.listList calendarsGET /identities/{identityId}/calendars
calendars.getGet calendar by IDGET /identities/{identityId}/calendars/{calendarId}
calendars.getByNameGet calendar by nameGET /identities/{identityId}/calendars/by-name/{name}
calendars.updateUpdate calendarPATCH /identities/{identityId}/calendars/{calendarId}
calendars.deleteDelete calendarDELETE /identities/{identityId}/calendars/{calendarId}
calendars.listTrashList deleted calendarsGET /identities/{identityId}/calendars/trash
calendars.restoreRestore deleted calendarPOST /identities/{identityId}/calendars/trash/{trashedCalendarId}/restore
calendars.purgePurge deleted calendarDELETE /identities/{identityId}/calendars/trash/{trashedCalendarId}
calendars.getChangesSync changes for calendarGET /identities/{identityId}/calendars/{calendarId}/changes
calendars.importImport calendar dataPOST /identities/{identityId}/calendars/{calendarId}/import
calendars.exportExport whole calendarGET /identities/{identityId}/calendars/{calendarId}/export
calendars.grantAccessGrant calendar accessPUT /identities/{identityId}/calendars/{calendarId}/shares/{shareeIdentityId}
calendars.revokeAccessRevoke calendar accessDELETE /identities/{identityId}/calendars/{calendarId}/shares/{shareeIdentityId}
calendars.listAccessList calendar access grantsGET /identities/{identityId}/calendars/{calendarId}/shares
calendars.createFeedTokenCreate calendar feed tokenPOST /identities/{identityId}/calendars/{calendarId}/tokens
calendars.listFeedTokensList calendar feed tokensGET /identities/{identityId}/calendars/{calendarId}/tokens
calendars.revokeFeedTokenRevoke calendar feed tokenDELETE /identities/{identityId}/calendars/{calendarId}/tokens/{tokenId}
calendars.getInvitationStatusCheck invitation status by UIDGET /identities/{identityId}/calendars/invitations
calendars.respondToInvitationAccept or decline emailed invitationPOST /identities/{identityId}/calendars/invitations/respond

openemail.calendarObjects

The objects in a calendar (iCalendar events, tasks and journal entries): list, read, write, move and delete them, answer an invitation, read what was sent for one, and their trash. Its page.

openemail.addressbooks

Addressbooks: create, read, update and delete them, their trash, their changes feed, import and export, sharing and feed tokens. Its page.

MethodWhat it doesIt calls
addressbooks.createCreate addressbookPOST /identities/{identityId}/addressbooks
addressbooks.listList addressbooksGET /identities/{identityId}/addressbooks
addressbooks.getGet addressbook by IDGET /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.getByNameGet addressbook by nameGET /identities/{identityId}/addressbooks/by-name/{name}
addressbooks.updateUpdate addressbookPATCH /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.deleteDelete addressbookDELETE /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.listTrashList deleted addressbooksGET /identities/{identityId}/addressbooks/trash
addressbooks.restoreRestore deleted addressbookPOST /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}/restore
addressbooks.purgePurge deleted addressbookDELETE /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}
addressbooks.getChangesSync changes for addressbookGET /identities/{identityId}/addressbooks/{addressbookId}/changes
addressbooks.importImport addressbook dataPOST /identities/{identityId}/addressbooks/{addressbookId}/import
addressbooks.exportExport whole addressbookGET /identities/{identityId}/addressbooks/{addressbookId}/export
addressbooks.grantAccessGrant addressbook accessPUT /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}
addressbooks.revokeAccessRevoke addressbook accessDELETE /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}
addressbooks.listAccessList addressbook access grantsGET /identities/{identityId}/addressbooks/{addressbookId}/shares
addressbooks.createFeedTokenCreate addressbook feed tokenPOST /identities/{identityId}/addressbooks/{addressbookId}/tokens
addressbooks.listFeedTokensList addressbook feed tokensGET /identities/{identityId}/addressbooks/{addressbookId}/tokens
addressbooks.revokeFeedTokenRevoke addressbook feed tokenDELETE /identities/{identityId}/addressbooks/{addressbookId}/tokens/{tokenId}

openemail.addressbookObjects

The objects in an addressbook (vCard contacts and groups): list, read, write, move and delete them, and their trash. Its page.

openemail.contacts

Contact suggestions for an address being typed. Its page.

MethodWhat it doesIt calls
contacts.suggestSuggest contactsGET /identities/{identityId}/contacts/suggest

openemail.pim

Calendars and addressbooks across identities: what is shared with an identity, the account's public directory and the subscriptions to it, and the public feed a token opens. Its page.

openemail.realtime

The live event sockets: a mailbox's change events, and an identity's calendar and contacts changes, over WebSocket. Its page.

MethodWhat it doesIt calls
realtime.mailboxSubscribe to live mailbox change events over WebSocketGET /mailboxes/{mailboxId}/events
realtime.pimSubscribe to live calendar and contacts change events over WebSocketGET /identities/{identityId}/pim/events

openemail.templates

Stored mail templates an account sends by name: create them, write each language's copy, preview and send them. Its page.

openemail.system

The platform's public liveness check. Its page.

MethodWhat it doesIt calls
system.healthLiveness checkGET /health