All methods
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.
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.
| Method | What it does | It calls |
|---|---|---|
verifiedRecipients.add | Add a verified recipient | POST /accounts/{accountId}/verified-recipients |
verifiedRecipients.list | List an account's verified recipients | GET /accounts/{accountId}/verified-recipients |
verifiedRecipients.remove | Remove a verified recipient | DELETE /accounts/{accountId}/verified-recipients/{recipientId} |
verifiedRecipients.getConfirmPage | Verified recipient confirmation link (the page) | GET /recipients/confirm/{token} |
verifiedRecipients.confirmByToken | Verified recipient confirmation link (confirm) | POST /recipients/confirm/{token} |
openemail.auth
Which credential the client holds, and what it reaches. Its page.
| Method | What it does | It calls |
|---|---|---|
auth.whoami | Get current authenticated identity | GET /auth/whoami |
openemail.apiKeys
Account API keys (oek_): mint one, list them, revoke one. Its page.
| Method | What it does | It calls |
|---|---|---|
apiKeys.create | Create API key | POST /api-keys |
apiKeys.list | List API keys | GET /api-keys |
apiKeys.revoke | Revoke an API key | DELETE /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.
| Method | What it does | It calls |
|---|---|---|
credentials.create | Create mailbox credential | POST /identities/{identityId}/credentials |
credentials.list | List mailbox credentials | GET /identities/{identityId}/credentials |
credentials.revoke | Revoke a mailbox credential | DELETE /identities/{identityId}/credentials/{credentialId} |
openemail.passwords
An identity's login password: change it, reset it as an administrator, or invite its user to set their own. Its page.
| Method | What it does | It calls |
|---|---|---|
passwords.change | Change mailbox login password | PUT /identities/{identityId}/password |
passwords.reset | Reset a mailbox password as an administrator | POST /identities/{identityId}/password/reset |
passwords.invite | Invite a mailbox user to set their own password | POST /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.
| Method | What it does | It calls |
|---|---|---|
recovery.getStatus | Read mailbox recovery posture | GET /identities/{identityId}/recovery |
recovery.setAddress | Set the mailbox's recovery address | PUT /identities/{identityId}/recovery |
recovery.confirmAddress | Confirm the mailbox's pending recovery address | POST /identities/{identityId}/recovery/confirm |
recovery.removeAddress | Remove the mailbox's recovery address | DELETE /identities/{identityId}/recovery |
recovery.createCodes | Issue mailbox recovery codes | POST /identities/{identityId}/recovery/codes |
openemail.securityKeys
An identity's WebAuthn security keys: register one in two steps, list them, remove one. Its page.
| Method | What it does | It calls |
|---|---|---|
securityKeys.beginRegistration | Begin WebAuthn security key registration | POST /identities/{identityId}/webauthn/registrations |
securityKeys.finishRegistration | Finish WebAuthn security key registration | POST /identities/{identityId}/webauthn/credentials |
securityKeys.list | List enrolled WebAuthn security keys | GET /identities/{identityId}/webauthn/credentials |
securityKeys.remove | Remove an enrolled WebAuthn security key | DELETE /identities/{identityId}/webauthn/credentials/{webauthnId} |
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.
| Method | What it does | It calls |
|---|---|---|
branding.get | Get public branding for domain | GET /branding/{domain} |
branding.getLogo | Get public logo image | GET /branding/{domain}/logo |
branding.getByHost | Get public branding by hostname | GET /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.
| Method | What it does | It calls |
|---|---|---|
hostnames.list | Get vanity hostnames for domain | GET /domains/{domain}/hostnames |
hostnames.set | Configure vanity hostname | PUT /domains/{domain}/hostnames/{service} |
hostnames.delete | Delete vanity hostname | DELETE /domains/{domain}/hostnames/{service} |
hostnames.check | Check vanity hostnames status | POST /domains/{domain}/hostnames/check |
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.
| Method | What it does | It calls |
|---|---|---|
dmarc.getSummary | Get DMARC report summary | GET /domains/{domain}/dmarc |
dmarc.listReports | List ingested DMARC reports | GET /domains/{domain}/dmarc/reports |
dmarc.listSources | List DMARC sending sources | GET /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.
| Method | What it does | It calls |
|---|---|---|
identities.create | Create an identity | POST /identities |
identities.list | List mailboxes | GET /identities |
identities.get | Get identity and bound store usage | GET /identities/{identityId} |
identities.update | Update mailbox settings | PATCH /identities/{identityId} |
identities.delete | Delete a mailbox | DELETE /identities/{identityId} |
identities.restore | Restore a deleted mailbox | POST /identities/{identityId}/restore |
identities.listAddresses | List an identity's addresses | GET /identities/{identityId}/addresses |
identities.listClients | List an identity's clients | GET /identities/{identityId}/clients |
identities.getPreferences | Get identity preferences | GET /identities/{identityId}/prefs |
identities.setPreferences | Save identity preferences | PUT /identities/{identityId}/prefs |
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.
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.
| Method | What it does | It calls |
|---|---|---|
mailboxShares.grant | Give another user access to this mailbox | PUT /mailboxes/{mailboxId}/shares/{granteeIdentityId} |
mailboxShares.revoke | Remove another user's access to this mailbox | DELETE /mailboxes/{mailboxId}/shares/{granteeIdentityId} |
mailboxShares.list | List who has access to this mailbox | GET /mailboxes/{mailboxId}/shares |
mailboxShares.listSharedWithMe | List mailboxes shared with you | GET /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.
| Method | What it does | It calls |
|---|---|---|
routes.create | Create a routing rule | POST /routes |
routes.list | List routing rules | GET /routes |
routes.get | Get email route details | GET /routes/{address} |
routes.update | Update email route | PATCH /routes/{address} |
routes.delete | Delete email route | DELETE /routes/{address} |
routes.addMember | Add group member | POST /routes/{address}/members |
routes.addMembers | Batch add group members | POST /routes/{address}/members/batch |
routes.listMembers | List group members | GET /routes/{address}/members |
routes.replaceMembers | Replace all group members | PUT /routes/{address}/members |
routes.removeMember | Remove group member | DELETE /routes/{address}/members/{memberAddress} |
openemail.patterns
Pattern (wildcard) routes: an address shape on a domain, and where its mail goes. Its page.
| Method | What it does | It calls |
|---|---|---|
patterns.create | Create pattern route | POST /patterns |
patterns.list | List pattern routes | GET /patterns |
patterns.update | Update pattern route | PATCH /patterns/{patternId} |
patterns.delete | Delete pattern route | DELETE /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.
| Method | What it does | It calls |
|---|---|---|
filtering.get | Get mailbox filtering settings | GET /mailboxes/{mailboxId}/filtering |
filtering.update | Update mailbox filtering settings | PUT /mailboxes/{mailboxId}/filtering |
openemail.rules
A mailbox's filter rules: one flat, ordered list, compiled to Sieve and run on every arrival. Its page.
| Method | What it does | It calls |
|---|---|---|
rules.get | Get mailbox filter rules | GET /mailboxes/{mailboxId}/rules |
rules.set | Save and activate filter rules | PUT /mailboxes/{mailboxId}/rules |
rules.delete | Delete mailbox filter rules | DELETE /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.
| Method | What it does | It calls |
|---|---|---|
sieve.getCapabilities | Get Sieve engine capabilities and limits | GET /mailboxes/{mailboxId}/sieve/capabilities |
sieve.check | Validate a Sieve filter script without saving | POST /mailboxes/{mailboxId}/sieve/check |
sieve.listScripts | List Sieve filter scripts | GET /mailboxes/{mailboxId}/sieve/scripts |
sieve.getScript | Get Sieve filter script source | GET /mailboxes/{mailboxId}/sieve/scripts/{scriptName} |
sieve.putScript | Upload or replace a Sieve filter script | PUT /mailboxes/{mailboxId}/sieve/scripts/{scriptName} |
sieve.renameScript | Rename a Sieve filter script | POST /mailboxes/{mailboxId}/sieve/scripts/{scriptName}/rename |
sieve.deleteScript | Delete a Sieve filter script | DELETE /mailboxes/{mailboxId}/sieve/scripts/{scriptName} |
sieve.getActive | Get active Sieve filter script name | GET /mailboxes/{mailboxId}/sieve/active |
sieve.activate | Activate a Sieve filter script | PUT /mailboxes/{mailboxId}/sieve/active |
sieve.deactivate | Deactivate the active Sieve filter script | DELETE /mailboxes/{mailboxId}/sieve/active |
openemail.vacation
A mailbox's out-of-office auto-reply. Its page.
| Method | What it does | It calls |
|---|---|---|
vacation.get | Get out-of-office auto-reply settings | GET /mailboxes/{mailboxId}/vacation |
vacation.set | Update out-of-office auto-reply settings | PUT /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.
| Method | What it does | It calls |
|---|---|---|
forwarding.get | Get forwarding destinations and settings | GET /mailboxes/{mailboxId}/forwarding |
forwarding.setForwardAll | Forward all mail to a destination | PUT /mailboxes/{mailboxId}/forwarding/all |
forwarding.setPaused | Pause or resume forwarding | PATCH /mailboxes/{mailboxId}/forwarding/all |
forwarding.clearForwardAll | Stop forwarding all mail | DELETE /mailboxes/{mailboxId}/forwarding/all |
forwarding.addDestination | Add a forwarding destination | POST /mailboxes/{mailboxId}/forwarding/destinations |
forwarding.confirmDestination | Confirm a forwarding destination | POST /mailboxes/{mailboxId}/forwarding/destinations/{destId}/verify |
forwarding.removeDestination | Remove a forwarding destination | DELETE /mailboxes/{mailboxId}/forwarding/destinations/{destId} |
forwarding.getDisablePage | Forwarding disable link (confirmation page) | GET /forwarding/disable/{token} |
forwarding.disableByToken | Forwarding disable link (revoke) | POST /forwarding/disable/{token} |
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.
| Method | What it does | It calls |
|---|---|---|
pickups.create | Create POP3 pickup source | POST /mailboxes/{mailboxId}/pickups |
pickups.list | List POP3 pickup sources | GET /mailboxes/{mailboxId}/pickups |
pickups.get | Get a POP3 pickup source | GET /mailboxes/{mailboxId}/pickups/{pickupId} |
pickups.update | Update a POP3 pickup source | PATCH /mailboxes/{mailboxId}/pickups/{pickupId} |
pickups.delete | Delete a POP3 pickup source | DELETE /mailboxes/{mailboxId}/pickups/{pickupId} |
pickups.run | Trigger immediate POP3 pickup | POST /mailboxes/{mailboxId}/pickups/{pickupId}/run |
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.
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.
| Method | What it does | It calls |
|---|---|---|
search.fullText | Full-text search a mailbox | GET /mailboxes/{mailboxId}/search |
search.query | Structured filter and query messages | POST /mailboxes/{mailboxId}/search/query |
search.updateMatches | Update flags, labels and keywords for every message a search selects | PATCH /mailboxes/{mailboxId}/search/query |
search.snippets | Highlighted excerpts for search results | POST /mailboxes/{mailboxId}/search/snippets |
search.semantic | Semantic (meaning-based) search of a mailbox | GET /mailboxes/{mailboxId}/search/semantic |
search.similar | Messages similar to one message | GET /mailboxes/{mailboxId}/messages/{messageId}/similar |
openemail.threads
Conversations: list a mailbox's threads, read one, and reply to it. Its page.
| Method | What it does | It calls |
|---|---|---|
threads.list | List conversation threads | GET /mailboxes/{mailboxId}/threads |
threads.get | Get a conversation thread | GET /mailboxes/{mailboxId}/threads/{threadId} |
threads.reply | Reply to a conversation thread | POST /mailboxes/{mailboxId}/threads/{threadId}/reply |
openemail.uploads
Attachment bytes staged once, then named by their blobId when sending or composing. Its page.
| Method | What it does | It calls |
|---|---|---|
uploads.create | Stage a binary attachment upload | POST /mailboxes/{mailboxId}/uploads |
openemail.scheduled
Scheduled sends: list them, read one, change its release time, cancel one or all of them. Its page.
| Method | What it does | It calls |
|---|---|---|
scheduled.list | List scheduled sends | GET /mailboxes/{mailboxId}/scheduled |
scheduled.get | Get a scheduled send | GET /mailboxes/{mailboxId}/scheduled/{scheduleId} |
scheduled.reschedule | Change a scheduled send's release time | PATCH /mailboxes/{mailboxId}/scheduled/{scheduleId} |
scheduled.cancel | Cancel a scheduled send | POST /mailboxes/{mailboxId}/scheduled/{scheduleId}/cancel |
scheduled.cancelAll | Cancel all scheduled sends for a mailbox | POST /mailboxes/{mailboxId}/scheduled/cancel |
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.
| Method | What it does | It calls |
|---|---|---|
deliveries.list | List delivery statuses for a thread or a set of messages | GET /mailboxes/{mailboxId}/deliveries |
deliveries.download | Fetch webhook attachment or raw message | GET /deliveries/fetch/{token} |
openemail.mta
The raw-MIME doors the mail transfer agents use: a recipient check, outbound submission and inbound delivery. Its page.
| Method | What it does | It calls |
|---|---|---|
mta.checkRecipient | Check recipient deliverability | GET /deliver/check |
mta.submitOutbound | Submit outbound email message | POST /deliver/outbound |
mta.deliverInbound | Deliver inbound email message | POST /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.
| Method | What it does | It calls |
|---|---|---|
suppressions.list | List email suppressions | GET /suppressions |
suppressions.get | Get suppression status for an address | GET /suppressions/{address} |
suppressions.remove | Remove email address from suppression list | DELETE /suppressions/{address} |
openemail.pushSubscriptions
Web Push (RFC 8030) device registrations: register an endpoint, verify or extend it, list them, delete one. Its page.
| Method | What it does | It calls |
|---|---|---|
pushSubscriptions.create | Register a push subscription | POST /push-subscriptions |
pushSubscriptions.list | List push subscriptions | GET /push-subscriptions |
pushSubscriptions.update | Verify or extend a push subscription | PATCH /push-subscriptions/{id} |
pushSubscriptions.delete | Delete a push subscription | DELETE /push-subscriptions/{id} |
openemail.freeBusy
Free and busy time: one identity's, or several addresses' at once. Its page.
| Method | What it does | It calls |
|---|---|---|
freeBusy.get | Free/busy for an identity | GET /identities/{identityId}/free-busy |
freeBusy.getMany | Free/busy for several addresses | POST /identities/{identityId}/pim/free-busy |
openemail.schedulingInbox
The calendar scheduling messages (iTIP) waiting for an identity: list them, read one, consume one. Its page.
| Method | What it does | It calls |
|---|---|---|
schedulingInbox.list | List arriving scheduling messages | GET /identities/{identityId}/scheduling-inbox |
schedulingInbox.get | Read one scheduling Inbox entry | GET /identities/{identityId}/scheduling-inbox/{entryId} |
schedulingInbox.consume | Consume a scheduling Inbox entry | DELETE /identities/{identityId}/scheduling-inbox/{entryId} |
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.
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.
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.
| Method | What it does | It calls |
|---|---|---|
contacts.suggest | Suggest contacts | GET /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.
| Method | What it does | It calls |
|---|---|---|
pim.listSharedWithMe | List collections shared with mailbox | GET /identities/{identityId}/pim/shared-with-me |
pim.listPublicDirectory | Browse account public directory | GET /identities/{identityId}/pim/public-directory |
pim.subscribe | Subscribe to public collection | POST /identities/{identityId}/pim/subscriptions/{publicId} |
pim.unsubscribe | Unsubscribe from public collection | DELETE /identities/{identityId}/pim/subscriptions/{publicId} |
pim.listSubscriptions | List public collection subscriptions | GET /identities/{identityId}/pim/subscriptions |
pim.getFeed | Export collection via feed token | GET /pim/feeds/{token} |
openemail.realtime
The live event sockets: a mailbox's change events, and an identity's calendar and contacts changes, over WebSocket. Its page.
| Method | What it does | It calls |
|---|---|---|
realtime.mailbox | Subscribe to live mailbox change events over WebSocket | GET /mailboxes/{mailboxId}/events |
realtime.pim | Subscribe to live calendar and contacts change events over WebSocket | GET /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.
| Method | What it does | It calls |
|---|---|---|
templates.list | List this account's mail templates | GET /accounts/{accountId}/templates |
templates.create | Create a mail template | POST /accounts/{accountId}/templates |
templates.get | Get one mail template | GET /accounts/{accountId}/templates/{slug} |
templates.update | Update a template's metadata | PATCH /accounts/{accountId}/templates/{slug} |
templates.delete | Delete a mail template | DELETE /accounts/{accountId}/templates/{slug} |
templates.setVariant | Write one language's copy | PUT /accounts/{accountId}/templates/{slug}/variants/{lang} |
templates.deleteVariant | Remove one language's copy | DELETE /accounts/{accountId}/templates/{slug}/variants/{lang} |
templates.render | Render a template without sending it | POST /accounts/{accountId}/templates/{slug}/render |
templates.send | Send a template to one or more recipients | POST /accounts/{accountId}/templates/{slug}/send |
openemail.system
The platform's public liveness check. Its page.
| Method | What it does | It calls |
|---|---|---|
system.health | Liveness check | GET /health |