# 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](/docs/sdks/typescript/accounts).

| Method | What it does | It calls |
| --- | --- | --- |
| [`accounts.get`](/docs/sdks/typescript/accounts/get) | Get account details | [`GET /accounts/{accountId}`](/docs/api/accounts/get_AccountGet) |
| [`accounts.delete`](/docs/sdks/typescript/accounts/delete) | Delete an account | [`DELETE /accounts/{accountId}`](/docs/api/accounts/delete_AccountDelete) |
| [`accounts.restore`](/docs/sdks/typescript/accounts/restore) | Restore deleted account | [`POST /accounts/{accountId}/restore`](/docs/api/accounts/post_AccountRestore) |
| [`accounts.setRecoveryPolicy`](/docs/sdks/typescript/accounts/set-recovery-policy) | Set the account's mailbox recovery policy | [`PUT /accounts/{accountId}/recovery-policy`](/docs/api/accounts/put_RecoveryPolicySet) |
| [`accounts.listRetention`](/docs/sdks/typescript/accounts/list-retention) | Preview retention across an account's mailboxes | [`GET /accounts/{accountId}/retention`](/docs/api/accounts/get_AccountRetentionGet) |
| [`accounts.setRetention`](/docs/sdks/typescript/accounts/set-retention) | Set account default retention window | [`PUT /accounts/{accountId}/retention`](/docs/api/accounts/put_AccountRetentionPut) |
| [`accounts.clearRetention`](/docs/sdks/typescript/accounts/clear-retention) | Clear account default retention window | [`DELETE /accounts/{accountId}/retention`](/docs/api/accounts/delete_AccountRetentionDelete) |
| [`accounts.getLimits`](/docs/sdks/typescript/accounts/get-limits) | Get an account's limits and enforcement state | [`GET /accounts/{accountId}/limits`](/docs/api/accounts/get_AccountLimitsGet) |
| [`accounts.getUsage`](/docs/sdks/typescript/accounts/get-usage) | Get daily account usage metrics | [`GET /accounts/{accountId}/usage`](/docs/api/accounts/get_AccountUsageGet) |
| [`accounts.getStorageUsage`](/docs/sdks/typescript/accounts/get-storage-usage) | Get account storage pool usage | [`GET /accounts/{accountId}/storage-usage`](/docs/api/accounts/get_AccountStorageUsageGet) |
| [`accounts.getSendUsage`](/docs/sdks/typescript/accounts/get-send-usage) | Get account send rate limit usage | [`GET /accounts/{accountId}/send-usage`](/docs/api/accounts/get_AccountSendUsageGet) |
| [`accounts.getReceiveUsage`](/docs/sdks/typescript/accounts/get-receive-usage) | Get account receive allowance usage | [`GET /accounts/{accountId}/receive-usage`](/docs/api/accounts/get_AccountReceiveUsageGet) |
| [`accounts.getTraffic`](/docs/sdks/typescript/accounts/get-traffic) | Get account traffic statistics | [`GET /accounts/{accountId}/traffic`](/docs/api/accounts/get_AccountTraffic) |
| [`accounts.getRequests`](/docs/sdks/typescript/accounts/get-requests) | Get account API call counts | [`GET /accounts/{accountId}/requests`](/docs/api/accounts/get_AccountRequestsGet) |
| [`accounts.listEvents`](/docs/sdks/typescript/accounts/list-events) | Query account delivery event log | [`GET /accounts/{accountId}/events`](/docs/api/accounts/get_AccountEvents) |
| [`accounts.listLimitIncidents`](/docs/sdks/typescript/accounts/list-limit-incidents) | List an account's limit incidents | [`GET /accounts/{accountId}/limit-incidents`](/docs/api/accounts/get_AccountLimitIncidentsGet) |
| [`accounts.listAudit`](/docs/sdks/typescript/accounts/list-audit) | List account audit trail | [`GET /accounts/{accountId}/audit`](/docs/api/accounts/get_AccountAuditList) |
| [`accounts.listIdentitiesByActivity`](/docs/sdks/typescript/accounts/list-identities-by-activity) | List an account's identities by recent activity | [`GET /accounts/{accountId}/activity`](/docs/api/accounts/get_AccountActivityList) |

## 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](/docs/sdks/typescript/verified-recipients).

| Method | What it does | It calls |
| --- | --- | --- |
| [`verifiedRecipients.add`](/docs/sdks/typescript/verified-recipients/add) | Add a verified recipient | [`POST /accounts/{accountId}/verified-recipients`](/docs/api/accounts/post_VerifiedRecipientAdd) |
| [`verifiedRecipients.list`](/docs/sdks/typescript/verified-recipients/list) | List an account's verified recipients | [`GET /accounts/{accountId}/verified-recipients`](/docs/api/accounts/get_VerifiedRecipientList) |
| [`verifiedRecipients.remove`](/docs/sdks/typescript/verified-recipients/remove) | Remove a verified recipient | [`DELETE /accounts/{accountId}/verified-recipients/{recipientId}`](/docs/api/accounts/delete_VerifiedRecipientDelete) |
| [`verifiedRecipients.getConfirmPage`](/docs/sdks/typescript/verified-recipients/get-confirm-page) | Verified recipient confirmation link (the page) | [`GET /recipients/confirm/{token}`](/docs/api/accounts/get_RecipientConfirmPage) |
| [`verifiedRecipients.confirmByToken`](/docs/sdks/typescript/verified-recipients/confirm-by-token) | Verified recipient confirmation link (confirm) | [`POST /recipients/confirm/{token}`](/docs/api/accounts/post_RecipientConfirm) |

## openemail.auth

Which credential the client holds, and what it reaches. [Its page](/docs/sdks/typescript/auth).

| Method | What it does | It calls |
| --- | --- | --- |
| [`auth.whoami`](/docs/sdks/typescript/auth/whoami) | Get current authenticated identity | [`GET /auth/whoami`](/docs/api/credentials/get_AuthWhoami) |

## openemail.apiKeys

Account API keys (oek_): mint one, list them, revoke one. [Its page](/docs/sdks/typescript/api-keys).

| Method | What it does | It calls |
| --- | --- | --- |
| [`apiKeys.create`](/docs/sdks/typescript/api-keys/create) | Create API key | [`POST /api-keys`](/docs/api/credentials/post_ApiKeyCreate) |
| [`apiKeys.list`](/docs/sdks/typescript/api-keys/list) | List API keys | [`GET /api-keys`](/docs/api/credentials/get_ApiKeyList) |
| [`apiKeys.revoke`](/docs/sdks/typescript/api-keys/revoke) | Revoke an API key | [`DELETE /api-keys/{apiKeyId}`](/docs/api/credentials/delete_ApiKeyDelete) |

## openemail.credentials

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

| Method | What it does | It calls |
| --- | --- | --- |
| [`credentials.create`](/docs/sdks/typescript/credentials/create) | Create mailbox credential | [`POST /identities/{identityId}/credentials`](/docs/api/credentials/post_CredentialCreate) |
| [`credentials.list`](/docs/sdks/typescript/credentials/list) | List mailbox credentials | [`GET /identities/{identityId}/credentials`](/docs/api/credentials/get_CredentialList) |
| [`credentials.revoke`](/docs/sdks/typescript/credentials/revoke) | Revoke a mailbox credential | [`DELETE /identities/{identityId}/credentials/{credentialId}`](/docs/api/credentials/delete_CredentialDelete) |

## openemail.passwords

An identity's login password: change it, reset it as an administrator, or invite its user to set their own. [Its page](/docs/sdks/typescript/passwords).

| Method | What it does | It calls |
| --- | --- | --- |
| [`passwords.change`](/docs/sdks/typescript/passwords/change) | Change mailbox login password | [`PUT /identities/{identityId}/password`](/docs/api/credentials/put_PasswordChange) |
| [`passwords.reset`](/docs/sdks/typescript/passwords/reset) | Reset a mailbox password as an administrator | [`POST /identities/{identityId}/password/reset`](/docs/api/credentials/post_MailboxPasswordReset) |
| [`passwords.invite`](/docs/sdks/typescript/passwords/invite) | Invite a mailbox user to set their own password | [`POST /identities/{identityId}/invitation`](/docs/api/credentials/post_MailboxInvitationCreate) |

## 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](/docs/sdks/typescript/recovery).

| Method | What it does | It calls |
| --- | --- | --- |
| [`recovery.getStatus`](/docs/sdks/typescript/recovery/get-status) | Read mailbox recovery posture | [`GET /identities/{identityId}/recovery`](/docs/api/credentials/get_RecoveryStatusRead) |
| [`recovery.setAddress`](/docs/sdks/typescript/recovery/set-address) | Set the mailbox's recovery address | [`PUT /identities/{identityId}/recovery`](/docs/api/credentials/put_RecoveryAddressSet) |
| [`recovery.confirmAddress`](/docs/sdks/typescript/recovery/confirm-address) | Confirm the mailbox's pending recovery address | [`POST /identities/{identityId}/recovery/confirm`](/docs/api/credentials/post_RecoveryAddressConfirm) |
| [`recovery.removeAddress`](/docs/sdks/typescript/recovery/remove-address) | Remove the mailbox's recovery address | [`DELETE /identities/{identityId}/recovery`](/docs/api/credentials/delete_RecoveryAddressDelete) |
| [`recovery.createCodes`](/docs/sdks/typescript/recovery/create-codes) | Issue mailbox recovery codes | [`POST /identities/{identityId}/recovery/codes`](/docs/api/credentials/post_RecoveryCodesCreate) |

## openemail.securityKeys

An identity's WebAuthn security keys: register one in two steps, list them, remove one. [Its page](/docs/sdks/typescript/security-keys).

| Method | What it does | It calls |
| --- | --- | --- |
| [`securityKeys.beginRegistration`](/docs/sdks/typescript/security-keys/begin-registration) | Begin WebAuthn security key registration | [`POST /identities/{identityId}/webauthn/registrations`](/docs/api/credentials/post_WebauthnRegisterBegin) |
| [`securityKeys.finishRegistration`](/docs/sdks/typescript/security-keys/finish-registration) | Finish WebAuthn security key registration | [`POST /identities/{identityId}/webauthn/credentials`](/docs/api/credentials/post_WebauthnRegisterFinish) |
| [`securityKeys.list`](/docs/sdks/typescript/security-keys/list) | List enrolled WebAuthn security keys | [`GET /identities/{identityId}/webauthn/credentials`](/docs/api/credentials/get_WebauthnCredentialList) |
| [`securityKeys.remove`](/docs/sdks/typescript/security-keys/remove) | Remove an enrolled WebAuthn security key | [`DELETE /identities/{identityId}/webauthn/credentials/{webauthnId}`](/docs/api/credentials/delete_WebauthnCredentialDelete) |

## 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](/docs/sdks/typescript/domains).

| Method | What it does | It calls |
| --- | --- | --- |
| [`domains.create`](/docs/sdks/typescript/domains/create) | Register or verify a domain | [`POST /domains`](/docs/api/domains/post_DomainCreate) |
| [`domains.list`](/docs/sdks/typescript/domains/list) | List domains | [`GET /domains`](/docs/api/domains/get_DomainList) |
| [`domains.get`](/docs/sdks/typescript/domains/get) | Get domain details | [`GET /domains/{domain}`](/docs/api/domains/get_DomainGet) |
| [`domains.update`](/docs/sdks/typescript/domains/update) | Update domain settings | [`PATCH /domains/{domain}`](/docs/api/domains/patch_DomainUpdate) |
| [`domains.delete`](/docs/sdks/typescript/domains/delete) | Delete a domain | [`DELETE /domains/{domain}`](/docs/api/domains/delete_DomainDelete) |
| [`domains.checkDns`](/docs/sdks/typescript/domains/check-dns) | Check domain DNS records | [`POST /domains/{domain}/dns/check`](/docs/api/domains/post_DomainDnsCheck) |
| [`domains.getBranding`](/docs/sdks/typescript/domains/get-branding) | Get domain branding | [`GET /domains/{domain}/branding`](/docs/api/domains/get_DomainBrandingGet) |
| [`domains.setBranding`](/docs/sdks/typescript/domains/set-branding) | Update domain brand name | [`PUT /domains/{domain}/branding`](/docs/api/domains/put_DomainBrandingUpdate) |
| [`domains.setLogo`](/docs/sdks/typescript/domains/set-logo) | Upload domain logo | [`PUT /domains/{domain}/logo`](/docs/api/domains/put_DomainLogoUpdate) |
| [`domains.deleteLogo`](/docs/sdks/typescript/domains/delete-logo) | Delete domain logo | [`DELETE /domains/{domain}/logo`](/docs/api/domains/delete_DomainLogoDelete) |
| [`domains.getEventWebhook`](/docs/sdks/typescript/domains/get-event-webhook) | Read the domain's event webhook | [`GET /domains/{domain}/event-webhook`](/docs/api/domains/get_DomainEventWebhookGet) |
| [`domains.setEventWebhook`](/docs/sdks/typescript/domains/set-event-webhook) | Create or replace the domain's event webhook | [`PUT /domains/{domain}/event-webhook`](/docs/api/domains/put_DomainEventWebhookSet) |
| [`domains.deleteEventWebhook`](/docs/sdks/typescript/domains/delete-event-webhook) | Remove the domain's event webhook | [`DELETE /domains/{domain}/event-webhook`](/docs/api/domains/delete_DomainEventWebhookDelete) |
| [`domains.testEventWebhook`](/docs/sdks/typescript/domains/test-event-webhook) | Send a test event to the domain's event webhook | [`POST /domains/{domain}/event-webhook/test`](/docs/api/domains/post_DomainEventWebhookTest) |
| [`domains.getUsage`](/docs/sdks/typescript/domains/get-usage) | Get daily domain storage metrics | [`GET /domains/{domain}/usage`](/docs/api/domains/get_DomainUsageGet) |
| [`domains.getTraffic`](/docs/sdks/typescript/domains/get-traffic) | Get domain traffic statistics | [`GET /domains/{domain}/traffic`](/docs/api/domains/get_DomainTraffic) |
| [`domains.getForwardUsage`](/docs/sdks/typescript/domains/get-forward-usage) | Get domain forwarding rate limit usage | [`GET /domains/{domain}/forward-usage`](/docs/api/domains/get_DomainForwardUsageGet) |
| [`domains.listEvents`](/docs/sdks/typescript/domains/list-events) | Query domain delivery event log | [`GET /domains/{domain}/events`](/docs/api/domains/get_DomainEvents) |

## 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](/docs/sdks/typescript/branding).

| Method | What it does | It calls |
| --- | --- | --- |
| [`branding.get`](/docs/sdks/typescript/branding/get) | Get public branding for domain | [`GET /branding/{domain}`](/docs/api/domains/get_PublicBrandingGet) |
| [`branding.getLogo`](/docs/sdks/typescript/branding/get-logo) | Get public logo image | [`GET /branding/{domain}/logo`](/docs/api/domains/get_PublicBrandingLogoGet) |
| [`branding.getByHost`](/docs/sdks/typescript/branding/get-by-host) | Get public branding by hostname | [`GET /branding/by-host/{host}`](/docs/api/domains/get_PublicBrandingByHostGet) |

## openemail.hostnames

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

| Method | What it does | It calls |
| --- | --- | --- |
| [`hostnames.list`](/docs/sdks/typescript/hostnames/list) | Get vanity hostnames for domain | [`GET /domains/{domain}/hostnames`](/docs/api/domains/get_DomainHostnamesGet) |
| [`hostnames.set`](/docs/sdks/typescript/hostnames/set) | Configure vanity hostname | [`PUT /domains/{domain}/hostnames/{service}`](/docs/api/domains/put_DomainHostnameSet) |
| [`hostnames.delete`](/docs/sdks/typescript/hostnames/delete) | Delete vanity hostname | [`DELETE /domains/{domain}/hostnames/{service}`](/docs/api/domains/delete_DomainHostnameDelete) |
| [`hostnames.check`](/docs/sdks/typescript/hostnames/check) | Check vanity hostnames status | [`POST /domains/{domain}/hostnames/check`](/docs/api/domains/post_DomainHostnamesCheck) |

## 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](/docs/sdks/typescript/dmarc).

| Method | What it does | It calls |
| --- | --- | --- |
| [`dmarc.getSummary`](/docs/sdks/typescript/dmarc/get-summary) | Get DMARC report summary | [`GET /domains/{domain}/dmarc`](/docs/api/domains/get_DomainDmarc) |
| [`dmarc.listReports`](/docs/sdks/typescript/dmarc/list-reports) | List ingested DMARC reports | [`GET /domains/{domain}/dmarc/reports`](/docs/api/domains/get_DomainDmarcReports) |
| [`dmarc.listSources`](/docs/sdks/typescript/dmarc/list-sources) | List DMARC sending sources | [`GET /domains/{domain}/dmarc/sources`](/docs/api/domains/get_DomainDmarcSources) |

## 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](/docs/sdks/typescript/identities).

| Method | What it does | It calls |
| --- | --- | --- |
| [`identities.create`](/docs/sdks/typescript/identities/create) | Create an identity | [`POST /identities`](/docs/api/mailboxes/post_IdentityCreate) |
| [`identities.list`](/docs/sdks/typescript/identities/list) | List mailboxes | [`GET /identities`](/docs/api/mailboxes/get_IdentityList) |
| [`identities.get`](/docs/sdks/typescript/identities/get) | Get identity and bound store usage | [`GET /identities/{identityId}`](/docs/api/mailboxes/get_IdentityGet) |
| [`identities.update`](/docs/sdks/typescript/identities/update) | Update mailbox settings | [`PATCH /identities/{identityId}`](/docs/api/mailboxes/patch_IdentityUpdate) |
| [`identities.delete`](/docs/sdks/typescript/identities/delete) | Delete a mailbox | [`DELETE /identities/{identityId}`](/docs/api/mailboxes/delete_IdentityDelete) |
| [`identities.restore`](/docs/sdks/typescript/identities/restore) | Restore a deleted mailbox | [`POST /identities/{identityId}/restore`](/docs/api/mailboxes/post_IdentityRestore) |
| [`identities.listAddresses`](/docs/sdks/typescript/identities/list-addresses) | List an identity's addresses | [`GET /identities/{identityId}/addresses`](/docs/api/mailboxes/get_IdentityAddressList) |
| [`identities.listClients`](/docs/sdks/typescript/identities/list-clients) | List an identity's clients | [`GET /identities/{identityId}/clients`](/docs/api/credentials/get_IdentityClientList) |
| [`identities.getPreferences`](/docs/sdks/typescript/identities/get-preferences) | Get identity preferences | [`GET /identities/{identityId}/prefs`](/docs/api/mailboxes/get_PrefsGet) |
| [`identities.setPreferences`](/docs/sdks/typescript/identities/set-preferences) | Save identity preferences | [`PUT /identities/{identityId}/prefs`](/docs/api/mailboxes/put_PrefsPut) |

## 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](/docs/sdks/typescript/mailboxes).

| Method | What it does | It calls |
| --- | --- | --- |
| [`mailboxes.get`](/docs/sdks/typescript/mailboxes/get) | Get mailbox details and usage statistics | [`GET /mailboxes/{mailboxId}`](/docs/api/mailboxes/get_MailboxGet) |
| [`mailboxes.getRetention`](/docs/sdks/typescript/mailboxes/get-retention) | Get retention policy and preview | [`GET /mailboxes/{mailboxId}/retention`](/docs/api/mailboxes/get_RetentionGet) |
| [`mailboxes.setRetention`](/docs/sdks/typescript/mailboxes/set-retention) | Set retention window | [`PUT /mailboxes/{mailboxId}/retention`](/docs/api/mailboxes/put_RetentionPut) |
| [`mailboxes.clearRetention`](/docs/sdks/typescript/mailboxes/clear-retention) | Clear retention window | [`DELETE /mailboxes/{mailboxId}/retention`](/docs/api/mailboxes/delete_RetentionDelete) |
| [`mailboxes.getEventWebhook`](/docs/sdks/typescript/mailboxes/get-event-webhook) | Read the mailbox's event webhook | [`GET /mailboxes/{mailboxId}/event-webhook`](/docs/api/mailboxes/get_MailboxEventWebhookGet) |
| [`mailboxes.setEventWebhook`](/docs/sdks/typescript/mailboxes/set-event-webhook) | Create or replace the mailbox's event webhook | [`PUT /mailboxes/{mailboxId}/event-webhook`](/docs/api/mailboxes/put_MailboxEventWebhookSet) |
| [`mailboxes.deleteEventWebhook`](/docs/sdks/typescript/mailboxes/delete-event-webhook) | Remove the mailbox's event webhook | [`DELETE /mailboxes/{mailboxId}/event-webhook`](/docs/api/mailboxes/delete_MailboxEventWebhookDelete) |
| [`mailboxes.testEventWebhook`](/docs/sdks/typescript/mailboxes/test-event-webhook) | Send a test event to the mailbox's event webhook | [`POST /mailboxes/{mailboxId}/event-webhook/test`](/docs/api/mailboxes/post_MailboxEventWebhookTest) |
| [`mailboxes.getMessageWebhook`](/docs/sdks/typescript/mailboxes/get-message-webhook) | Read the mailbox's message webhook | [`GET /mailboxes/{mailboxId}/message-webhook`](/docs/api/mailboxes/get_MailboxMessageWebhookGet) |
| [`mailboxes.setMessageWebhook`](/docs/sdks/typescript/mailboxes/set-message-webhook) | Create or replace the mailbox's message webhook | [`PUT /mailboxes/{mailboxId}/message-webhook`](/docs/api/mailboxes/put_MailboxMessageWebhookSet) |
| [`mailboxes.deleteMessageWebhook`](/docs/sdks/typescript/mailboxes/delete-message-webhook) | Remove the mailbox's message webhook | [`DELETE /mailboxes/{mailboxId}/message-webhook`](/docs/api/mailboxes/delete_MailboxMessageWebhookDelete) |
| [`mailboxes.getRouting`](/docs/sdks/typescript/mailboxes/get-routing) | List what delivers to a mailbox | [`GET /mailboxes/{mailboxId}/routing`](/docs/api/mailboxes/get_MailboxRoutingGet) |
| [`mailboxes.listSendAs`](/docs/sdks/typescript/mailboxes/list-send-as) | List the addresses a mailbox may send as | [`GET /mailboxes/{mailboxId}/send-as`](/docs/api/mailboxes/get_MailboxSendAsList) |
| [`mailboxes.checkSendAs`](/docs/sdks/typescript/mailboxes/check-send-as) | Check whether a mailbox may send from an address | [`POST /mailboxes/{mailboxId}/send-as/check`](/docs/api/mailboxes/post_MailboxSenderCheck) |
| [`mailboxes.getSendUsage`](/docs/sdks/typescript/mailboxes/get-send-usage) | Get outbound send rate limit usage | [`GET /mailboxes/{mailboxId}/send-usage`](/docs/api/mailboxes/get_SendUsageGet) |
| [`mailboxes.getSendState`](/docs/sdks/typescript/mailboxes/get-send-state) | Get whether a mailbox may send | [`GET /mailboxes/{mailboxId}/send-state`](/docs/api/mailboxes/get_MailboxSendState) |

## 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](/docs/sdks/typescript/mailbox-shares).

| Method | What it does | It calls |
| --- | --- | --- |
| [`mailboxShares.grant`](/docs/sdks/typescript/mailbox-shares/grant) | Give another user access to this mailbox | [`PUT /mailboxes/{mailboxId}/shares/{granteeIdentityId}`](/docs/api/mailboxes/put_MailSharePut) |
| [`mailboxShares.revoke`](/docs/sdks/typescript/mailbox-shares/revoke) | Remove another user's access to this mailbox | [`DELETE /mailboxes/{mailboxId}/shares/{granteeIdentityId}`](/docs/api/mailboxes/delete_MailShareDelete) |
| [`mailboxShares.list`](/docs/sdks/typescript/mailbox-shares/list) | List who has access to this mailbox | [`GET /mailboxes/{mailboxId}/shares`](/docs/api/mailboxes/get_MailShareList) |
| [`mailboxShares.listSharedWithMe`](/docs/sdks/typescript/mailbox-shares/list-shared-with-me) | List mailboxes shared with you | [`GET /shared-mailboxes`](/docs/api/mailboxes/get_SharedMailboxList) |

## 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](/docs/sdks/typescript/routes).

| Method | What it does | It calls |
| --- | --- | --- |
| [`routes.create`](/docs/sdks/typescript/routes/create) | Create a routing rule | [`POST /routes`](/docs/api/routing/post_RouteCreate) |
| [`routes.list`](/docs/sdks/typescript/routes/list) | List routing rules | [`GET /routes`](/docs/api/routing/get_RouteList) |
| [`routes.get`](/docs/sdks/typescript/routes/get) | Get email route details | [`GET /routes/{address}`](/docs/api/routing/get_RouteGet) |
| [`routes.update`](/docs/sdks/typescript/routes/update) | Update email route | [`PATCH /routes/{address}`](/docs/api/routing/patch_RouteUpdate) |
| [`routes.delete`](/docs/sdks/typescript/routes/delete) | Delete email route | [`DELETE /routes/{address}`](/docs/api/routing/delete_RouteDelete) |
| [`routes.addMember`](/docs/sdks/typescript/routes/add-member) | Add group member | [`POST /routes/{address}/members`](/docs/api/routing/post_MemberAdd) |
| [`routes.addMembers`](/docs/sdks/typescript/routes/add-members) | Batch add group members | [`POST /routes/{address}/members/batch`](/docs/api/routing/post_MemberBatchAdd) |
| [`routes.listMembers`](/docs/sdks/typescript/routes/list-members) | List group members | [`GET /routes/{address}/members`](/docs/api/routing/get_MemberList) |
| [`routes.replaceMembers`](/docs/sdks/typescript/routes/replace-members) | Replace all group members | [`PUT /routes/{address}/members`](/docs/api/routing/put_MemberReplace) |
| [`routes.removeMember`](/docs/sdks/typescript/routes/remove-member) | Remove group member | [`DELETE /routes/{address}/members/{memberAddress}`](/docs/api/routing/delete_MemberRemove) |

## openemail.patterns

Pattern (wildcard) routes: an address shape on a domain, and where its mail goes. [Its page](/docs/sdks/typescript/patterns).

| Method | What it does | It calls |
| --- | --- | --- |
| [`patterns.create`](/docs/sdks/typescript/patterns/create) | Create pattern route | [`POST /patterns`](/docs/api/routing/post_PatternCreate) |
| [`patterns.list`](/docs/sdks/typescript/patterns/list) | List pattern routes | [`GET /patterns`](/docs/api/routing/get_PatternList) |
| [`patterns.update`](/docs/sdks/typescript/patterns/update) | Update pattern route | [`PATCH /patterns/{patternId}`](/docs/api/routing/patch_PatternUpdate) |
| [`patterns.delete`](/docs/sdks/typescript/patterns/delete) | Delete pattern route | [`DELETE /patterns/{patternId}`](/docs/api/routing/delete_PatternDelete) |

## 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](/docs/sdks/typescript/account-address-lists).

| Method | What it does | It calls |
| --- | --- | --- |
| [`accountAddressLists.create`](/docs/sdks/typescript/account-address-lists/create) | Create an address list | [`POST /accounts/{accountId}/lists`](/docs/api/routing/post_AccountAddressListCreate) |
| [`accountAddressLists.list`](/docs/sdks/typescript/account-address-lists/list) | List address lists | [`GET /accounts/{accountId}/lists`](/docs/api/routing/get_AccountAddressListIndex) |
| [`accountAddressLists.get`](/docs/sdks/typescript/account-address-lists/get) | Get an address list | [`GET /accounts/{accountId}/lists/{listId}`](/docs/api/routing/get_AccountAddressListGet) |
| [`accountAddressLists.update`](/docs/sdks/typescript/account-address-lists/update) | Update an address list | [`PATCH /accounts/{accountId}/lists/{listId}`](/docs/api/routing/patch_AccountAddressListPatch) |
| [`accountAddressLists.delete`](/docs/sdks/typescript/account-address-lists/delete) | Delete an address list | [`DELETE /accounts/{accountId}/lists/{listId}`](/docs/api/routing/delete_AccountAddressListDelete) |
| [`accountAddressLists.addEntry`](/docs/sdks/typescript/account-address-lists/add-entry) | Add a pattern to an address list | [`POST /accounts/{accountId}/lists/{listId}/entries`](/docs/api/routing/post_AccountAddressListEntryCreate) |
| [`accountAddressLists.addEntries`](/docs/sdks/typescript/account-address-lists/add-entries) | Add multiple patterns to an address list | [`POST /accounts/{accountId}/lists/{listId}/entries/batch`](/docs/api/routing/post_AccountAddressListEntryBatch) |
| [`accountAddressLists.listEntries`](/docs/sdks/typescript/account-address-lists/list-entries) | List patterns in an address list | [`GET /accounts/{accountId}/lists/{listId}/entries`](/docs/api/routing/get_AccountAddressListEntryIndex) |
| [`accountAddressLists.importEntries`](/docs/sdks/typescript/account-address-lists/import-entries) | Import patterns into an address list from CSV | [`POST /accounts/{accountId}/lists/{listId}/entries/import`](/docs/api/routing/post_AccountAddressListEntryImport) |
| [`accountAddressLists.exportEntries`](/docs/sdks/typescript/account-address-lists/export-entries) | Export an address list as CSV | [`GET /accounts/{accountId}/lists/{listId}/entries/export`](/docs/api/routing/get_AccountAddressListEntryExport) |
| [`accountAddressLists.removeEntry`](/docs/sdks/typescript/account-address-lists/remove-entry) | Remove a pattern from an address list | [`DELETE /accounts/{accountId}/lists/{listId}/entries/{pattern}`](/docs/api/routing/delete_AccountAddressListEntryDelete) |
| [`accountAddressLists.evaluate`](/docs/sdks/typescript/account-address-lists/evaluate) | Test address list policy against an address | [`POST /accounts/{accountId}/lists/evaluate`](/docs/api/routing/post_AccountAddressListEvaluate) |

## openemail.mailboxAddressLists

A mailbox's address lists: the same allow and block lists, read and written through one mailbox. [Its page](/docs/sdks/typescript/mailbox-address-lists).

| Method | What it does | It calls |
| --- | --- | --- |
| [`mailboxAddressLists.create`](/docs/sdks/typescript/mailbox-address-lists/create) | Create an address list | [`POST /mailboxes/{mailboxId}/lists`](/docs/api/routing/post_MailboxAddressListCreate) |
| [`mailboxAddressLists.list`](/docs/sdks/typescript/mailbox-address-lists/list) | List address lists | [`GET /mailboxes/{mailboxId}/lists`](/docs/api/routing/get_MailboxAddressListIndex) |
| [`mailboxAddressLists.get`](/docs/sdks/typescript/mailbox-address-lists/get) | Get an address list | [`GET /mailboxes/{mailboxId}/lists/{listId}`](/docs/api/routing/get_MailboxAddressListGet) |
| [`mailboxAddressLists.update`](/docs/sdks/typescript/mailbox-address-lists/update) | Update an address list | [`PATCH /mailboxes/{mailboxId}/lists/{listId}`](/docs/api/routing/patch_MailboxAddressListPatch) |
| [`mailboxAddressLists.delete`](/docs/sdks/typescript/mailbox-address-lists/delete) | Delete an address list | [`DELETE /mailboxes/{mailboxId}/lists/{listId}`](/docs/api/routing/delete_MailboxAddressListDelete) |
| [`mailboxAddressLists.addEntry`](/docs/sdks/typescript/mailbox-address-lists/add-entry) | Add a pattern to an address list | [`POST /mailboxes/{mailboxId}/lists/{listId}/entries`](/docs/api/routing/post_MailboxAddressListEntryCreate) |
| [`mailboxAddressLists.addEntries`](/docs/sdks/typescript/mailbox-address-lists/add-entries) | Add multiple patterns to an address list | [`POST /mailboxes/{mailboxId}/lists/{listId}/entries/batch`](/docs/api/routing/post_MailboxAddressListEntryBatch) |
| [`mailboxAddressLists.listEntries`](/docs/sdks/typescript/mailbox-address-lists/list-entries) | List patterns in an address list | [`GET /mailboxes/{mailboxId}/lists/{listId}/entries`](/docs/api/routing/get_MailboxAddressListEntryIndex) |
| [`mailboxAddressLists.importEntries`](/docs/sdks/typescript/mailbox-address-lists/import-entries) | Import patterns into an address list from CSV | [`POST /mailboxes/{mailboxId}/lists/{listId}/entries/import`](/docs/api/routing/post_MailboxAddressListEntryImport) |
| [`mailboxAddressLists.exportEntries`](/docs/sdks/typescript/mailbox-address-lists/export-entries) | Export an address list as CSV | [`GET /mailboxes/{mailboxId}/lists/{listId}/entries/export`](/docs/api/routing/get_MailboxAddressListEntryExport) |
| [`mailboxAddressLists.removeEntry`](/docs/sdks/typescript/mailbox-address-lists/remove-entry) | Remove a pattern from an address list | [`DELETE /mailboxes/{mailboxId}/lists/{listId}/entries/{pattern}`](/docs/api/routing/delete_MailboxAddressListEntryDelete) |
| [`mailboxAddressLists.evaluate`](/docs/sdks/typescript/mailbox-address-lists/evaluate) | Test address list policy against an address | [`POST /mailboxes/{mailboxId}/lists/evaluate`](/docs/api/routing/post_MailboxAddressListEvaluate) |

## openemail.filtering

A mailbox's spam filtering settings. [Its page](/docs/sdks/typescript/filtering).

| Method | What it does | It calls |
| --- | --- | --- |
| [`filtering.get`](/docs/sdks/typescript/filtering/get) | Get mailbox filtering settings | [`GET /mailboxes/{mailboxId}/filtering`](/docs/api/filtering/get_FilteringGet) |
| [`filtering.update`](/docs/sdks/typescript/filtering/update) | Update mailbox filtering settings | [`PUT /mailboxes/{mailboxId}/filtering`](/docs/api/filtering/put_FilteringPut) |

## openemail.rules

A mailbox's filter rules: one flat, ordered list, compiled to Sieve and run on every arrival. [Its page](/docs/sdks/typescript/rules).

| Method | What it does | It calls |
| --- | --- | --- |
| [`rules.get`](/docs/sdks/typescript/rules/get) | Get mailbox filter rules | [`GET /mailboxes/{mailboxId}/rules`](/docs/api/filtering/get_RulesGet) |
| [`rules.set`](/docs/sdks/typescript/rules/set) | Save and activate filter rules | [`PUT /mailboxes/{mailboxId}/rules`](/docs/api/filtering/put_RulesPut) |
| [`rules.delete`](/docs/sdks/typescript/rules/delete) | Delete mailbox filter rules | [`DELETE /mailboxes/{mailboxId}/rules`](/docs/api/filtering/delete_RulesDelete) |

## 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](/docs/sdks/typescript/sieve).

| Method | What it does | It calls |
| --- | --- | --- |
| [`sieve.getCapabilities`](/docs/sdks/typescript/sieve/get-capabilities) | Get Sieve engine capabilities and limits | [`GET /mailboxes/{mailboxId}/sieve/capabilities`](/docs/api/filtering/get_SieveCapabilities) |
| [`sieve.check`](/docs/sdks/typescript/sieve/check) | Validate a Sieve filter script without saving | [`POST /mailboxes/{mailboxId}/sieve/check`](/docs/api/filtering/post_SieveCheck) |
| [`sieve.listScripts`](/docs/sdks/typescript/sieve/list-scripts) | List Sieve filter scripts | [`GET /mailboxes/{mailboxId}/sieve/scripts`](/docs/api/filtering/get_SieveList) |
| [`sieve.getScript`](/docs/sdks/typescript/sieve/get-script) | Get Sieve filter script source | [`GET /mailboxes/{mailboxId}/sieve/scripts/{scriptName}`](/docs/api/filtering/get_SieveGet) |
| [`sieve.putScript`](/docs/sdks/typescript/sieve/put-script) | Upload or replace a Sieve filter script | [`PUT /mailboxes/{mailboxId}/sieve/scripts/{scriptName}`](/docs/api/filtering/put_SievePut) |
| [`sieve.renameScript`](/docs/sdks/typescript/sieve/rename-script) | Rename a Sieve filter script | [`POST /mailboxes/{mailboxId}/sieve/scripts/{scriptName}/rename`](/docs/api/filtering/post_SieveRename) |
| [`sieve.deleteScript`](/docs/sdks/typescript/sieve/delete-script) | Delete a Sieve filter script | [`DELETE /mailboxes/{mailboxId}/sieve/scripts/{scriptName}`](/docs/api/filtering/delete_SieveDelete) |
| [`sieve.getActive`](/docs/sdks/typescript/sieve/get-active) | Get active Sieve filter script name | [`GET /mailboxes/{mailboxId}/sieve/active`](/docs/api/filtering/get_SieveActiveGet) |
| [`sieve.activate`](/docs/sdks/typescript/sieve/activate) | Activate a Sieve filter script | [`PUT /mailboxes/{mailboxId}/sieve/active`](/docs/api/filtering/put_SieveActivate) |
| [`sieve.deactivate`](/docs/sdks/typescript/sieve/deactivate) | Deactivate the active Sieve filter script | [`DELETE /mailboxes/{mailboxId}/sieve/active`](/docs/api/filtering/delete_SieveDeactivate) |

## openemail.vacation

A mailbox's out-of-office auto-reply. [Its page](/docs/sdks/typescript/vacation).

| Method | What it does | It calls |
| --- | --- | --- |
| [`vacation.get`](/docs/sdks/typescript/vacation/get) | Get out-of-office auto-reply settings | [`GET /mailboxes/{mailboxId}/vacation`](/docs/api/filtering/get_VacationGet) |
| [`vacation.set`](/docs/sdks/typescript/vacation/set) | Update out-of-office auto-reply settings | [`PUT /mailboxes/{mailboxId}/vacation`](/docs/api/filtering/put_VacationPut) |

## 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](/docs/sdks/typescript/forwarding).

| Method | What it does | It calls |
| --- | --- | --- |
| [`forwarding.get`](/docs/sdks/typescript/forwarding/get) | Get forwarding destinations and settings | [`GET /mailboxes/{mailboxId}/forwarding`](/docs/api/filtering/get_ForwardingGet) |
| [`forwarding.setForwardAll`](/docs/sdks/typescript/forwarding/set-forward-all) | Forward all mail to a destination | [`PUT /mailboxes/{mailboxId}/forwarding/all`](/docs/api/filtering/put_ForwardingAllSet) |
| [`forwarding.setPaused`](/docs/sdks/typescript/forwarding/set-paused) | Pause or resume forwarding | [`PATCH /mailboxes/{mailboxId}/forwarding/all`](/docs/api/filtering/patch_ForwardingAllPause) |
| [`forwarding.clearForwardAll`](/docs/sdks/typescript/forwarding/clear-forward-all) | Stop forwarding all mail | [`DELETE /mailboxes/{mailboxId}/forwarding/all`](/docs/api/filtering/delete_ForwardingAllClear) |
| [`forwarding.addDestination`](/docs/sdks/typescript/forwarding/add-destination) | Add a forwarding destination | [`POST /mailboxes/{mailboxId}/forwarding/destinations`](/docs/api/filtering/post_ForwardingDestinationAdd) |
| [`forwarding.confirmDestination`](/docs/sdks/typescript/forwarding/confirm-destination) | Confirm a forwarding destination | [`POST /mailboxes/{mailboxId}/forwarding/destinations/{destId}/verify`](/docs/api/filtering/post_ForwardingDestinationVerify) |
| [`forwarding.removeDestination`](/docs/sdks/typescript/forwarding/remove-destination) | Remove a forwarding destination | [`DELETE /mailboxes/{mailboxId}/forwarding/destinations/{destId}`](/docs/api/filtering/delete_ForwardingDestinationDelete) |
| [`forwarding.getDisablePage`](/docs/sdks/typescript/forwarding/get-disable-page) | Forwarding disable link (confirmation page) | [`GET /forwarding/disable/{token}`](/docs/api/filtering/get_ForwardingDisablePage) |
| [`forwarding.disableByToken`](/docs/sdks/typescript/forwarding/disable-by-token) | Forwarding disable link (revoke) | [`POST /forwarding/disable/{token}`](/docs/api/filtering/post_ForwardingDisableRevoke) |

## 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](/docs/sdks/typescript/labels).

| Method | What it does | It calls |
| --- | --- | --- |
| [`labels.create`](/docs/sdks/typescript/labels/create) | Create a new custom label | [`POST /mailboxes/{mailboxId}/labels`](/docs/api/labels/post_LabelCreate) |
| [`labels.list`](/docs/sdks/typescript/labels/list) | List mailbox labels and folder statistics | [`GET /mailboxes/{mailboxId}/labels`](/docs/api/labels/get_LabelList) |
| [`labels.update`](/docs/sdks/typescript/labels/update) | Rename a label or update folder settings | [`PATCH /mailboxes/{mailboxId}/labels/{label}`](/docs/api/labels/patch_LabelRename) |
| [`labels.updateById`](/docs/sdks/typescript/labels/update-by-id) | Rename a label or update folder settings, by id | [`PATCH /mailboxes/{mailboxId}/labels/by-id/{labelId}`](/docs/api/labels/patch_LabelRenameById) |
| [`labels.delete`](/docs/sdks/typescript/labels/delete) | Delete a custom label | [`DELETE /mailboxes/{mailboxId}/labels/{label}`](/docs/api/labels/delete_LabelDelete) |
| [`labels.deleteById`](/docs/sdks/typescript/labels/delete-by-id) | Delete a custom label, by id | [`DELETE /mailboxes/{mailboxId}/labels/by-id/{labelId}`](/docs/api/labels/delete_LabelDeleteById) |
| [`labels.listMessages`](/docs/sdks/typescript/labels/list-messages) | List messages in a label by UID | [`GET /mailboxes/{mailboxId}/labels/{label}/messages`](/docs/api/labels/get_LabelMessageList) |
| [`labels.updateMessages`](/docs/sdks/typescript/labels/update-messages) | Update flags, labels and keywords for every message in a folder | [`PATCH /mailboxes/{mailboxId}/labels/{label}/messages`](/docs/api/labels/patch_LabelMessagesUpdate) |
| [`labels.updateMessagesById`](/docs/sdks/typescript/labels/update-messages-by-id) | Update flags, labels and keywords for every message in a folder, by label id | [`PATCH /mailboxes/{mailboxId}/labels/by-id/{labelId}/messages`](/docs/api/labels/patch_LabelMessagesUpdateById) |
| [`labels.listUids`](/docs/sdks/typescript/labels/list-uids) | List message sync index for a label | [`GET /mailboxes/{mailboxId}/labels/{label}/uids`](/docs/api/labels/get_LabelUidList) |
| [`labels.listVanished`](/docs/sdks/typescript/labels/list-vanished) | List vanished (expunged) message UIDs | [`GET /mailboxes/{mailboxId}/labels/{label}/vanished`](/docs/api/labels/get_LabelVanished) |
| [`labels.expunge`](/docs/sdks/typescript/labels/expunge) | Expunge deleted messages from a label | [`POST /mailboxes/{mailboxId}/labels/{label}/expunge`](/docs/api/labels/post_LabelExpunge) |

## openemail.pickups

POP3 pickup sources: mail fetched from an external POP3 account into a mailbox. [Its page](/docs/sdks/typescript/pickups).

| Method | What it does | It calls |
| --- | --- | --- |
| [`pickups.create`](/docs/sdks/typescript/pickups/create) | Create POP3 pickup source | [`POST /mailboxes/{mailboxId}/pickups`](/docs/api/pickups/post_PickupCreate) |
| [`pickups.list`](/docs/sdks/typescript/pickups/list) | List POP3 pickup sources | [`GET /mailboxes/{mailboxId}/pickups`](/docs/api/pickups/get_PickupList) |
| [`pickups.get`](/docs/sdks/typescript/pickups/get) | Get a POP3 pickup source | [`GET /mailboxes/{mailboxId}/pickups/{pickupId}`](/docs/api/pickups/get_PickupGet) |
| [`pickups.update`](/docs/sdks/typescript/pickups/update) | Update a POP3 pickup source | [`PATCH /mailboxes/{mailboxId}/pickups/{pickupId}`](/docs/api/pickups/patch_PickupUpdate) |
| [`pickups.delete`](/docs/sdks/typescript/pickups/delete) | Delete a POP3 pickup source | [`DELETE /mailboxes/{mailboxId}/pickups/{pickupId}`](/docs/api/pickups/delete_PickupDelete) |
| [`pickups.run`](/docs/sdks/typescript/pickups/run) | Trigger immediate POP3 pickup | [`POST /mailboxes/{mailboxId}/pickups/{pickupId}/run`](/docs/api/pickups/post_PickupRun) |

## 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](/docs/sdks/typescript/messages).

| Method | What it does | It calls |
| --- | --- | --- |
| [`messages.list`](/docs/sdks/typescript/messages/list) | List mailbox messages | [`GET /mailboxes/{mailboxId}/messages`](/docs/api/messages/get_MessageList) |
| [`messages.get`](/docs/sdks/typescript/messages/get) | Get message metadata | [`GET /mailboxes/{mailboxId}/messages/{messageId}`](/docs/api/messages/get_MessageGet) |
| [`messages.getMany`](/docs/sdks/typescript/messages/get-many) | Batch get message metadata | [`POST /mailboxes/{mailboxId}/messages/batch`](/docs/api/messages/post_MessageBatchGet) |
| [`messages.getContent`](/docs/sdks/typescript/messages/get-content) | Get parsed message content and attachments | [`GET /mailboxes/{mailboxId}/messages/{messageId}/content`](/docs/api/messages/get_MessageGetContent) |
| [`messages.getRaw`](/docs/sdks/typescript/messages/get-raw) | Get raw MIME message body | [`GET /mailboxes/{mailboxId}/messages/{messageId}/raw`](/docs/api/messages/get_MessageGetRaw) |
| [`messages.getPart`](/docs/sdks/typescript/messages/get-part) | Get specific message MIME part | [`GET /mailboxes/{mailboxId}/messages/{messageId}/parts/{section}`](/docs/api/messages/get_MessageGetPart) |
| [`messages.getRawHeaders`](/docs/sdks/typescript/messages/get-raw-headers) | Batch get raw header blocks | [`POST /mailboxes/{mailboxId}/messages/heads`](/docs/api/messages/post_MessageHeadBatch) |
| [`messages.getMimeStructures`](/docs/sdks/typescript/messages/get-mime-structures) | Batch get cached MIME structures | [`POST /mailboxes/{mailboxId}/messages/mime`](/docs/api/messages/post_MessageMimeBatch) |
| [`messages.update`](/docs/sdks/typescript/messages/update) | Update message flags and labels | [`PATCH /mailboxes/{mailboxId}/messages/{messageId}`](/docs/api/messages/patch_MessageUpdate) |
| [`messages.updateMany`](/docs/sdks/typescript/messages/update-many) | Update flags and labels for multiple messages or whole conversations | [`PATCH /mailboxes/{mailboxId}/messages`](/docs/api/messages/patch_MessageBatchUpdate) |
| [`messages.delete`](/docs/sdks/typescript/messages/delete) | Delete a message | [`DELETE /mailboxes/{mailboxId}/messages/{messageId}`](/docs/api/messages/delete_MessageDelete) |
| [`messages.deleteMany`](/docs/sdks/typescript/messages/delete-many) | Empty trash, or delete a batch of messages or whole conversations | [`DELETE /mailboxes/{mailboxId}/messages`](/docs/api/messages/delete_MessageEmptyTrash) |
| [`messages.append`](/docs/sdks/typescript/messages/append) | Append raw MIME message to mailbox | [`POST /mailboxes/{mailboxId}/messages`](/docs/api/messages/post_MessageAppend) |
| [`messages.compose`](/docs/sdks/typescript/messages/compose) | Save structured message to mailbox | [`POST /mailboxes/{mailboxId}/messages/compose`](/docs/api/messages/post_MessageCompose) |
| [`messages.copy`](/docs/sdks/typescript/messages/copy) | Copy or move messages and conversations into another mailbox | [`POST /mailboxes/{mailboxId}/messages/copy`](/docs/api/messages/post_MessageCopy) |
| [`messages.restore`](/docs/sdks/typescript/messages/restore) | Restore an expunged message from trash | [`POST /mailboxes/{mailboxId}/messages/{messageId}/restore`](/docs/api/messages/post_MessageRestore) |
| [`messages.restoreMany`](/docs/sdks/typescript/messages/restore-many) | Restore multiple messages from trash | [`POST /mailboxes/{mailboxId}/messages/restore`](/docs/api/messages/post_MessageBatchRestore) |
| [`messages.untrash`](/docs/sdks/typescript/messages/untrash) | Take messages out of Trash, back to where they were filed | [`POST /mailboxes/{mailboxId}/messages/untrash`](/docs/api/messages/post_MessageBatchUntrash) |
| [`messages.unjunk`](/docs/sdks/typescript/messages/unjunk) | Take messages out of Junk, back to where they were filed | [`POST /mailboxes/{mailboxId}/messages/unjunk`](/docs/api/messages/post_MessageBatchUnjunk) |
| [`messages.learn`](/docs/sdks/typescript/messages/learn) | Train spam filter from a message | [`POST /mailboxes/{mailboxId}/messages/{messageId}/learn`](/docs/api/messages/post_MessageLearn) |
| [`messages.learnMany`](/docs/sdks/typescript/messages/learn-many) | Train spam filter from multiple messages | [`POST /mailboxes/{mailboxId}/messages/learn`](/docs/api/messages/post_MessageBatchLearn) |
| [`messages.listKeywords`](/docs/sdks/typescript/messages/list-keywords) | List the keywords in use, with counts | [`GET /mailboxes/{mailboxId}/keywords`](/docs/api/messages/get_MailboxKeywordList) |
| [`messages.getChanges`](/docs/sdks/typescript/messages/get-changes) | Get message sync changes | [`GET /mailboxes/{mailboxId}/messages/changes`](/docs/api/messages/get_MessageChanges) |
| [`messages.send`](/docs/sdks/typescript/messages/send) | Send an email message | [`POST /mailboxes/{mailboxId}/send`](/docs/api/delivery/post_MessageSend) |
| [`messages.sendDraft`](/docs/sdks/typescript/messages/send-draft) | Send a stored draft | [`POST /mailboxes/{mailboxId}/messages/{messageId}/submit`](/docs/api/delivery/post_MessageSubmit) |
| [`messages.getDelivery`](/docs/sdks/typescript/messages/get-delivery) | Get delivery status of a sent message | [`GET /mailboxes/{mailboxId}/messages/{messageId}/delivery`](/docs/api/delivery/get_MessageDeliveryGet) |
| [`messages.getInvitation`](/docs/sdks/typescript/messages/get-invitation) | Get invitation from email message | [`GET /mailboxes/{mailboxId}/messages/{messageId}/invitation`](/docs/api/pim/get_MessageInvitationRoute) |

## 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](/docs/sdks/typescript/search).

| Method | What it does | It calls |
| --- | --- | --- |
| [`search.fullText`](/docs/sdks/typescript/search/full-text) | Full-text search a mailbox | [`GET /mailboxes/{mailboxId}/search`](/docs/api/messages/get_MailboxSearch) |
| [`search.query`](/docs/sdks/typescript/search/query) | Structured filter and query messages | [`POST /mailboxes/{mailboxId}/search/query`](/docs/api/messages/post_MailboxSearchQuery) |
| [`search.updateMatches`](/docs/sdks/typescript/search/update-matches) | Update flags, labels and keywords for every message a search selects | [`PATCH /mailboxes/{mailboxId}/search/query`](/docs/api/messages/patch_MailboxSearchQueryUpdate) |
| [`search.snippets`](/docs/sdks/typescript/search/snippets) | Highlighted excerpts for search results | [`POST /mailboxes/{mailboxId}/search/snippets`](/docs/api/messages/post_MailboxSearchSnippets) |
| [`search.semantic`](/docs/sdks/typescript/search/semantic) | Semantic (meaning-based) search of a mailbox | [`GET /mailboxes/{mailboxId}/search/semantic`](/docs/api/messages/get_MailboxSemanticSearch) |
| [`search.similar`](/docs/sdks/typescript/search/similar) | Messages similar to one message | [`GET /mailboxes/{mailboxId}/messages/{messageId}/similar`](/docs/api/messages/get_MessageSimilar) |

## openemail.threads

Conversations: list a mailbox's threads, read one, and reply to it. [Its page](/docs/sdks/typescript/threads).

| Method | What it does | It calls |
| --- | --- | --- |
| [`threads.list`](/docs/sdks/typescript/threads/list) | List conversation threads | [`GET /mailboxes/{mailboxId}/threads`](/docs/api/threads/get_ThreadList) |
| [`threads.get`](/docs/sdks/typescript/threads/get) | Get a conversation thread | [`GET /mailboxes/{mailboxId}/threads/{threadId}`](/docs/api/threads/get_ThreadGet) |
| [`threads.reply`](/docs/sdks/typescript/threads/reply) | Reply to a conversation thread | [`POST /mailboxes/{mailboxId}/threads/{threadId}/reply`](/docs/api/delivery/post_ThreadReply) |

## openemail.uploads

Attachment bytes staged once, then named by their blobId when sending or composing. [Its page](/docs/sdks/typescript/uploads).

| Method | What it does | It calls |
| --- | --- | --- |
| [`uploads.create`](/docs/sdks/typescript/uploads/create) | Stage a binary attachment upload | [`POST /mailboxes/{mailboxId}/uploads`](/docs/api/uploads/post_UploadCreate) |

## openemail.scheduled

Scheduled sends: list them, read one, change its release time, cancel one or all of them. [Its page](/docs/sdks/typescript/scheduled).

| Method | What it does | It calls |
| --- | --- | --- |
| [`scheduled.list`](/docs/sdks/typescript/scheduled/list) | List scheduled sends | [`GET /mailboxes/{mailboxId}/scheduled`](/docs/api/delivery/get_ScheduledList) |
| [`scheduled.get`](/docs/sdks/typescript/scheduled/get) | Get a scheduled send | [`GET /mailboxes/{mailboxId}/scheduled/{scheduleId}`](/docs/api/delivery/get_ScheduledGet) |
| [`scheduled.reschedule`](/docs/sdks/typescript/scheduled/reschedule) | Change a scheduled send's release time | [`PATCH /mailboxes/{mailboxId}/scheduled/{scheduleId}`](/docs/api/delivery/patch_ScheduledReschedule) |
| [`scheduled.cancel`](/docs/sdks/typescript/scheduled/cancel) | Cancel a scheduled send | [`POST /mailboxes/{mailboxId}/scheduled/{scheduleId}/cancel`](/docs/api/delivery/post_ScheduledCancel) |
| [`scheduled.cancelAll`](/docs/sdks/typescript/scheduled/cancel-all) | Cancel all scheduled sends for a mailbox | [`POST /mailboxes/{mailboxId}/scheduled/cancel`](/docs/api/delivery/post_ScheduledCancelAll) |

## 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](/docs/sdks/typescript/deliveries).

| Method | What it does | It calls |
| --- | --- | --- |
| [`deliveries.list`](/docs/sdks/typescript/deliveries/list) | List delivery statuses for a thread or a set of messages | [`GET /mailboxes/{mailboxId}/deliveries`](/docs/api/delivery/get_DeliveriesList) |
| [`deliveries.download`](/docs/sdks/typescript/deliveries/download) | Fetch webhook attachment or raw message | [`GET /deliveries/fetch/{token}`](/docs/api/routing/get_DeliveryFetch) |

## openemail.mta

The raw-MIME doors the mail transfer agents use: a recipient check, outbound submission and inbound delivery. [Its page](/docs/sdks/typescript/mta).

| Method | What it does | It calls |
| --- | --- | --- |
| [`mta.checkRecipient`](/docs/sdks/typescript/mta/check-recipient) | Check recipient deliverability | [`GET /deliver/check`](/docs/api/delivery/get_DeliverCheck) |
| [`mta.submitOutbound`](/docs/sdks/typescript/mta/submit-outbound) | Submit outbound email message | [`POST /deliver/outbound`](/docs/api/delivery/post_DeliverOutbound) |
| [`mta.deliverInbound`](/docs/sdks/typescript/mta/deliver-inbound) | Deliver inbound email message | [`POST /deliver/inbound`](/docs/api/delivery/post_DeliverInbound) |

## 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](/docs/sdks/typescript/suppressions).

| Method | What it does | It calls |
| --- | --- | --- |
| [`suppressions.list`](/docs/sdks/typescript/suppressions/list) | List email suppressions | [`GET /suppressions`](/docs/api/suppressions/get_SuppressionListEndpoint) |
| [`suppressions.get`](/docs/sdks/typescript/suppressions/get) | Get suppression status for an address | [`GET /suppressions/{address}`](/docs/api/suppressions/get_SuppressionGet) |
| [`suppressions.remove`](/docs/sdks/typescript/suppressions/remove) | Remove email address from suppression list | [`DELETE /suppressions/{address}`](/docs/api/suppressions/delete_SuppressionDelete) |

## openemail.pushSubscriptions

Web Push (RFC 8030) device registrations: register an endpoint, verify or extend it, list them, delete one. [Its page](/docs/sdks/typescript/push-subscriptions).

| Method | What it does | It calls |
| --- | --- | --- |
| [`pushSubscriptions.create`](/docs/sdks/typescript/push-subscriptions/create) | Register a push subscription | [`POST /push-subscriptions`](/docs/api/push/post_PushSubscriptionCreate) |
| [`pushSubscriptions.list`](/docs/sdks/typescript/push-subscriptions/list) | List push subscriptions | [`GET /push-subscriptions`](/docs/api/push/get_PushSubscriptionList) |
| [`pushSubscriptions.update`](/docs/sdks/typescript/push-subscriptions/update) | Verify or extend a push subscription | [`PATCH /push-subscriptions/{id}`](/docs/api/push/patch_PushSubscriptionUpdate) |
| [`pushSubscriptions.delete`](/docs/sdks/typescript/push-subscriptions/delete) | Delete a push subscription | [`DELETE /push-subscriptions/{id}`](/docs/api/push/delete_PushSubscriptionDelete) |

## openemail.freeBusy

Free and busy time: one identity's, or several addresses' at once. [Its page](/docs/sdks/typescript/free-busy).

| Method | What it does | It calls |
| --- | --- | --- |
| [`freeBusy.get`](/docs/sdks/typescript/free-busy/get) | Free/busy for an identity | [`GET /identities/{identityId}/free-busy`](/docs/api/pim/get_IdentityFreeBusy) |
| [`freeBusy.getMany`](/docs/sdks/typescript/free-busy/get-many) | Free/busy for several addresses | [`POST /identities/{identityId}/pim/free-busy`](/docs/api/pim/post_FreeBusyBatch) |

## openemail.schedulingInbox

The calendar scheduling messages (iTIP) waiting for an identity: list them, read one, consume one. [Its page](/docs/sdks/typescript/scheduling-inbox).

| Method | What it does | It calls |
| --- | --- | --- |
| [`schedulingInbox.list`](/docs/sdks/typescript/scheduling-inbox/list) | List arriving scheduling messages | [`GET /identities/{identityId}/scheduling-inbox`](/docs/api/pim/get_SchedulingInbox) |
| [`schedulingInbox.get`](/docs/sdks/typescript/scheduling-inbox/get) | Read one scheduling Inbox entry | [`GET /identities/{identityId}/scheduling-inbox/{entryId}`](/docs/api/pim/get_SchedulingInboxEntry) |
| [`schedulingInbox.consume`](/docs/sdks/typescript/scheduling-inbox/consume) | Consume a scheduling Inbox entry | [`DELETE /identities/{identityId}/scheduling-inbox/{entryId}`](/docs/api/pim/delete_SchedulingInboxConsume) |

## 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](/docs/sdks/typescript/calendars).

| Method | What it does | It calls |
| --- | --- | --- |
| [`calendars.create`](/docs/sdks/typescript/calendars/create) | Create calendar | [`POST /identities/{identityId}/calendars`](/docs/api/pim/post_CalendarCreate) |
| [`calendars.list`](/docs/sdks/typescript/calendars/list) | List calendars | [`GET /identities/{identityId}/calendars`](/docs/api/pim/get_CalendarList) |
| [`calendars.get`](/docs/sdks/typescript/calendars/get) | Get calendar by ID | [`GET /identities/{identityId}/calendars/{calendarId}`](/docs/api/pim/get_CalendarGet) |
| [`calendars.getByName`](/docs/sdks/typescript/calendars/get-by-name) | Get calendar by name | [`GET /identities/{identityId}/calendars/by-name/{name}`](/docs/api/pim/get_CalendarGetByName) |
| [`calendars.update`](/docs/sdks/typescript/calendars/update) | Update calendar | [`PATCH /identities/{identityId}/calendars/{calendarId}`](/docs/api/pim/patch_CalendarUpdate) |
| [`calendars.delete`](/docs/sdks/typescript/calendars/delete) | Delete calendar | [`DELETE /identities/{identityId}/calendars/{calendarId}`](/docs/api/pim/delete_CalendarDelete) |
| [`calendars.listTrash`](/docs/sdks/typescript/calendars/list-trash) | List deleted calendars | [`GET /identities/{identityId}/calendars/trash`](/docs/api/pim/get_CalendarTrashList) |
| [`calendars.restore`](/docs/sdks/typescript/calendars/restore) | Restore deleted calendar | [`POST /identities/{identityId}/calendars/trash/{trashedCalendarId}/restore`](/docs/api/pim/post_CalendarTrashRestore) |
| [`calendars.purge`](/docs/sdks/typescript/calendars/purge) | Purge deleted calendar | [`DELETE /identities/{identityId}/calendars/trash/{trashedCalendarId}`](/docs/api/pim/delete_CalendarTrashPurge) |
| [`calendars.getChanges`](/docs/sdks/typescript/calendars/get-changes) | Sync changes for calendar | [`GET /identities/{identityId}/calendars/{calendarId}/changes`](/docs/api/pim/get_CalendarChanges) |
| [`calendars.import`](/docs/sdks/typescript/calendars/import) | Import calendar data | [`POST /identities/{identityId}/calendars/{calendarId}/import`](/docs/api/pim/post_CalendarImport) |
| [`calendars.export`](/docs/sdks/typescript/calendars/export) | Export whole calendar | [`GET /identities/{identityId}/calendars/{calendarId}/export`](/docs/api/pim/get_CalendarExport) |
| [`calendars.grantAccess`](/docs/sdks/typescript/calendars/grant-access) | Grant calendar access | [`PUT /identities/{identityId}/calendars/{calendarId}/shares/{shareeIdentityId}`](/docs/api/pim/put_CalendarSharePut) |
| [`calendars.revokeAccess`](/docs/sdks/typescript/calendars/revoke-access) | Revoke calendar access | [`DELETE /identities/{identityId}/calendars/{calendarId}/shares/{shareeIdentityId}`](/docs/api/pim/delete_CalendarShareDelete) |
| [`calendars.listAccess`](/docs/sdks/typescript/calendars/list-access) | List calendar access grants | [`GET /identities/{identityId}/calendars/{calendarId}/shares`](/docs/api/pim/get_CalendarShareList) |
| [`calendars.createFeedToken`](/docs/sdks/typescript/calendars/create-feed-token) | Create calendar feed token | [`POST /identities/{identityId}/calendars/{calendarId}/tokens`](/docs/api/pim/post_CalendarTokenCreate) |
| [`calendars.listFeedTokens`](/docs/sdks/typescript/calendars/list-feed-tokens) | List calendar feed tokens | [`GET /identities/{identityId}/calendars/{calendarId}/tokens`](/docs/api/pim/get_CalendarTokenList) |
| [`calendars.revokeFeedToken`](/docs/sdks/typescript/calendars/revoke-feed-token) | Revoke calendar feed token | [`DELETE /identities/{identityId}/calendars/{calendarId}/tokens/{tokenId}`](/docs/api/pim/delete_CalendarTokenRevoke) |
| [`calendars.getInvitationStatus`](/docs/sdks/typescript/calendars/get-invitation-status) | Check invitation status by UID | [`GET /identities/{identityId}/calendars/invitations`](/docs/api/pim/get_PimInvitationStatusRoute) |
| [`calendars.respondToInvitation`](/docs/sdks/typescript/calendars/respond-to-invitation) | Accept or decline emailed invitation | [`POST /identities/{identityId}/calendars/invitations/respond`](/docs/api/pim/post_PimInvitationRespond) |

## 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](/docs/sdks/typescript/calendar-objects).

| Method | What it does | It calls |
| --- | --- | --- |
| [`calendarObjects.list`](/docs/sdks/typescript/calendar-objects/list) | List calendar objects | [`GET /identities/{identityId}/calendars/{calendarId}/objects`](/docs/api/pim/get_CalendarObjectList) |
| [`calendarObjects.get`](/docs/sdks/typescript/calendar-objects/get) | Get calendar object | [`GET /identities/{identityId}/calendars/{calendarId}/objects/{href}`](/docs/api/pim/get_CalendarObjectGet) |
| [`calendarObjects.put`](/docs/sdks/typescript/calendar-objects/put) | Create or replace calendar object | [`PUT /identities/{identityId}/calendars/{calendarId}/objects/{href}`](/docs/api/pim/put_CalendarObjectPut) |
| [`calendarObjects.delete`](/docs/sdks/typescript/calendar-objects/delete) | Delete calendar object | [`DELETE /identities/{identityId}/calendars/{calendarId}/objects/{href}`](/docs/api/pim/delete_CalendarObjectDelete) |
| [`calendarObjects.move`](/docs/sdks/typescript/calendar-objects/move) | Move or rename calendar object | [`POST /identities/{identityId}/calendars/{calendarId}/objects/{href}/move`](/docs/api/pim/post_CalendarObjectMove) |
| [`calendarObjects.respond`](/docs/sdks/typescript/calendar-objects/respond) | RSVP to calendar invitation | [`POST /identities/{identityId}/calendars/{calendarId}/objects/{href}/respond`](/docs/api/pim/post_CalendarObjectRespond) |
| [`calendarObjects.listScheduling`](/docs/sdks/typescript/calendar-objects/list-scheduling) | List what was sent for one event | [`GET /identities/{identityId}/calendars/{calendarId}/objects/{href}/scheduling`](/docs/api/pim/get_CalendarObjectScheduling) |
| [`calendarObjects.listTrash`](/docs/sdks/typescript/calendar-objects/list-trash) | List deleted calendar objects | [`GET /identities/{identityId}/calendars/{calendarId}/trash`](/docs/api/pim/get_CalendarObjectTrashList) |
| [`calendarObjects.emptyTrash`](/docs/sdks/typescript/calendar-objects/empty-trash) | Empty calendar trash | [`DELETE /identities/{identityId}/calendars/{calendarId}/trash`](/docs/api/pim/delete_CalendarObjectTrashEmpty) |
| [`calendarObjects.restore`](/docs/sdks/typescript/calendar-objects/restore) | Restore deleted calendar object | [`POST /identities/{identityId}/calendars/{calendarId}/trash/{objectId}/restore`](/docs/api/pim/post_CalendarObjectTrashRestore) |
| [`calendarObjects.purge`](/docs/sdks/typescript/calendar-objects/purge) | Purge deleted calendar object | [`DELETE /identities/{identityId}/calendars/{calendarId}/trash/{objectId}`](/docs/api/pim/delete_CalendarObjectTrashPurge) |

## openemail.addressbooks

Addressbooks: create, read, update and delete them, their trash, their changes feed, import and export, sharing and feed tokens. [Its page](/docs/sdks/typescript/addressbooks).

| Method | What it does | It calls |
| --- | --- | --- |
| [`addressbooks.create`](/docs/sdks/typescript/addressbooks/create) | Create addressbook | [`POST /identities/{identityId}/addressbooks`](/docs/api/pim/post_AddressbookCreate) |
| [`addressbooks.list`](/docs/sdks/typescript/addressbooks/list) | List addressbooks | [`GET /identities/{identityId}/addressbooks`](/docs/api/pim/get_AddressbookList) |
| [`addressbooks.get`](/docs/sdks/typescript/addressbooks/get) | Get addressbook by ID | [`GET /identities/{identityId}/addressbooks/{addressbookId}`](/docs/api/pim/get_AddressbookGet) |
| [`addressbooks.getByName`](/docs/sdks/typescript/addressbooks/get-by-name) | Get addressbook by name | [`GET /identities/{identityId}/addressbooks/by-name/{name}`](/docs/api/pim/get_AddressbookGetByName) |
| [`addressbooks.update`](/docs/sdks/typescript/addressbooks/update) | Update addressbook | [`PATCH /identities/{identityId}/addressbooks/{addressbookId}`](/docs/api/pim/patch_AddressbookUpdate) |
| [`addressbooks.delete`](/docs/sdks/typescript/addressbooks/delete) | Delete addressbook | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}`](/docs/api/pim/delete_AddressbookDelete) |
| [`addressbooks.listTrash`](/docs/sdks/typescript/addressbooks/list-trash) | List deleted addressbooks | [`GET /identities/{identityId}/addressbooks/trash`](/docs/api/pim/get_AddressbookTrashList) |
| [`addressbooks.restore`](/docs/sdks/typescript/addressbooks/restore) | Restore deleted addressbook | [`POST /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}/restore`](/docs/api/pim/post_AddressbookTrashRestore) |
| [`addressbooks.purge`](/docs/sdks/typescript/addressbooks/purge) | Purge deleted addressbook | [`DELETE /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}`](/docs/api/pim/delete_AddressbookTrashPurge) |
| [`addressbooks.getChanges`](/docs/sdks/typescript/addressbooks/get-changes) | Sync changes for addressbook | [`GET /identities/{identityId}/addressbooks/{addressbookId}/changes`](/docs/api/pim/get_AddressbookChanges) |
| [`addressbooks.import`](/docs/sdks/typescript/addressbooks/import) | Import addressbook data | [`POST /identities/{identityId}/addressbooks/{addressbookId}/import`](/docs/api/pim/post_AddressbookImport) |
| [`addressbooks.export`](/docs/sdks/typescript/addressbooks/export) | Export whole addressbook | [`GET /identities/{identityId}/addressbooks/{addressbookId}/export`](/docs/api/pim/get_AddressbookExport) |
| [`addressbooks.grantAccess`](/docs/sdks/typescript/addressbooks/grant-access) | Grant addressbook access | [`PUT /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}`](/docs/api/pim/put_AddressbookSharePut) |
| [`addressbooks.revokeAccess`](/docs/sdks/typescript/addressbooks/revoke-access) | Revoke addressbook access | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}`](/docs/api/pim/delete_AddressbookShareDelete) |
| [`addressbooks.listAccess`](/docs/sdks/typescript/addressbooks/list-access) | List addressbook access grants | [`GET /identities/{identityId}/addressbooks/{addressbookId}/shares`](/docs/api/pim/get_AddressbookShareList) |
| [`addressbooks.createFeedToken`](/docs/sdks/typescript/addressbooks/create-feed-token) | Create addressbook feed token | [`POST /identities/{identityId}/addressbooks/{addressbookId}/tokens`](/docs/api/pim/post_AddressbookTokenCreate) |
| [`addressbooks.listFeedTokens`](/docs/sdks/typescript/addressbooks/list-feed-tokens) | List addressbook feed tokens | [`GET /identities/{identityId}/addressbooks/{addressbookId}/tokens`](/docs/api/pim/get_AddressbookTokenList) |
| [`addressbooks.revokeFeedToken`](/docs/sdks/typescript/addressbooks/revoke-feed-token) | Revoke addressbook feed token | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}/tokens/{tokenId}`](/docs/api/pim/delete_AddressbookTokenRevoke) |

## openemail.addressbookObjects

The objects in an addressbook (vCard contacts and groups): list, read, write, move and delete them, and their trash. [Its page](/docs/sdks/typescript/addressbook-objects).

| Method | What it does | It calls |
| --- | --- | --- |
| [`addressbookObjects.list`](/docs/sdks/typescript/addressbook-objects/list) | List addressbook objects | [`GET /identities/{identityId}/addressbooks/{addressbookId}/objects`](/docs/api/pim/get_AddressbookObjectList) |
| [`addressbookObjects.get`](/docs/sdks/typescript/addressbook-objects/get) | Get addressbook object | [`GET /identities/{identityId}/addressbooks/{addressbookId}/objects/{href}`](/docs/api/pim/get_AddressbookObjectGet) |
| [`addressbookObjects.put`](/docs/sdks/typescript/addressbook-objects/put) | Create or replace addressbook object | [`PUT /identities/{identityId}/addressbooks/{addressbookId}/objects/{href}`](/docs/api/pim/put_AddressbookObjectPut) |
| [`addressbookObjects.delete`](/docs/sdks/typescript/addressbook-objects/delete) | Delete addressbook object | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}/objects/{href}`](/docs/api/pim/delete_AddressbookObjectDelete) |
| [`addressbookObjects.move`](/docs/sdks/typescript/addressbook-objects/move) | Move or rename addressbook object | [`POST /identities/{identityId}/addressbooks/{addressbookId}/objects/{href}/move`](/docs/api/pim/post_AddressbookObjectMove) |
| [`addressbookObjects.listTrash`](/docs/sdks/typescript/addressbook-objects/list-trash) | List deleted addressbook objects | [`GET /identities/{identityId}/addressbooks/{addressbookId}/trash`](/docs/api/pim/get_AddressbookObjectTrashList) |
| [`addressbookObjects.emptyTrash`](/docs/sdks/typescript/addressbook-objects/empty-trash) | Empty addressbook trash | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}/trash`](/docs/api/pim/delete_AddressbookObjectTrashEmpty) |
| [`addressbookObjects.restore`](/docs/sdks/typescript/addressbook-objects/restore) | Restore deleted addressbook object | [`POST /identities/{identityId}/addressbooks/{addressbookId}/trash/{objectId}/restore`](/docs/api/pim/post_AddressbookObjectTrashRestore) |
| [`addressbookObjects.purge`](/docs/sdks/typescript/addressbook-objects/purge) | Purge deleted addressbook object | [`DELETE /identities/{identityId}/addressbooks/{addressbookId}/trash/{objectId}`](/docs/api/pim/delete_AddressbookObjectTrashPurge) |

## openemail.contacts

Contact suggestions for an address being typed. [Its page](/docs/sdks/typescript/contacts).

| Method | What it does | It calls |
| --- | --- | --- |
| [`contacts.suggest`](/docs/sdks/typescript/contacts/suggest) | Suggest contacts | [`GET /identities/{identityId}/contacts/suggest`](/docs/api/pim/get_ContactSuggest) |

## 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](/docs/sdks/typescript/pim).

| Method | What it does | It calls |
| --- | --- | --- |
| [`pim.listSharedWithMe`](/docs/sdks/typescript/pim/list-shared-with-me) | List collections shared with mailbox | [`GET /identities/{identityId}/pim/shared-with-me`](/docs/api/pim/get_PimSharedWithMeList) |
| [`pim.listPublicDirectory`](/docs/sdks/typescript/pim/list-public-directory) | Browse account public directory | [`GET /identities/{identityId}/pim/public-directory`](/docs/api/pim/get_PimPublicDirectory) |
| [`pim.subscribe`](/docs/sdks/typescript/pim/subscribe) | Subscribe to public collection | [`POST /identities/{identityId}/pim/subscriptions/{publicId}`](/docs/api/pim/post_PimSubscribe) |
| [`pim.unsubscribe`](/docs/sdks/typescript/pim/unsubscribe) | Unsubscribe from public collection | [`DELETE /identities/{identityId}/pim/subscriptions/{publicId}`](/docs/api/pim/delete_PimUnsubscribe) |
| [`pim.listSubscriptions`](/docs/sdks/typescript/pim/list-subscriptions) | List public collection subscriptions | [`GET /identities/{identityId}/pim/subscriptions`](/docs/api/pim/get_PimSubscriptionList) |
| [`pim.getFeed`](/docs/sdks/typescript/pim/get-feed) | Export collection via feed token | [`GET /pim/feeds/{token}`](/docs/api/pim/get_PimFeed) |

## openemail.realtime

The live event sockets: a mailbox's change events, and an identity's calendar and contacts changes, over WebSocket. [Its page](/docs/sdks/typescript/realtime).

| Method | What it does | It calls |
| --- | --- | --- |
| [`realtime.mailbox`](/docs/sdks/typescript/realtime/mailbox) | Subscribe to live mailbox change events over WebSocket | [`GET /mailboxes/{mailboxId}/events`](/docs/api/messages/get_MailboxEvents) |
| [`realtime.pim`](/docs/sdks/typescript/realtime/pim) | Subscribe to live calendar and contacts change events over WebSocket | [`GET /identities/{identityId}/pim/events`](/docs/api/pim/get_PimEvents) |

## openemail.templates

Stored mail templates an account sends by name: create them, write each language's copy, preview and send them. [Its page](/docs/sdks/typescript/templates).

| Method | What it does | It calls |
| --- | --- | --- |
| [`templates.list`](/docs/sdks/typescript/templates/list) | List this account's mail templates | [`GET /accounts/{accountId}/templates`](/docs/api/templates/get_TemplateIndex) |
| [`templates.create`](/docs/sdks/typescript/templates/create) | Create a mail template | [`POST /accounts/{accountId}/templates`](/docs/api/templates/post_TemplateCreate) |
| [`templates.get`](/docs/sdks/typescript/templates/get) | Get one mail template | [`GET /accounts/{accountId}/templates/{slug}`](/docs/api/templates/get_TemplateGet) |
| [`templates.update`](/docs/sdks/typescript/templates/update) | Update a template's metadata | [`PATCH /accounts/{accountId}/templates/{slug}`](/docs/api/templates/patch_TemplatePatch) |
| [`templates.delete`](/docs/sdks/typescript/templates/delete) | Delete a mail template | [`DELETE /accounts/{accountId}/templates/{slug}`](/docs/api/templates/delete_TemplateDelete) |
| [`templates.setVariant`](/docs/sdks/typescript/templates/set-variant) | Write one language's copy | [`PUT /accounts/{accountId}/templates/{slug}/variants/{lang}`](/docs/api/templates/put_TemplateVariantPut) |
| [`templates.deleteVariant`](/docs/sdks/typescript/templates/delete-variant) | Remove one language's copy | [`DELETE /accounts/{accountId}/templates/{slug}/variants/{lang}`](/docs/api/templates/delete_TemplateVariantDelete) |
| [`templates.render`](/docs/sdks/typescript/templates/render) | Render a template without sending it | [`POST /accounts/{accountId}/templates/{slug}/render`](/docs/api/templates/post_TemplateRender) |
| [`templates.send`](/docs/sdks/typescript/templates/send) | Send a template to one or more recipients | [`POST /accounts/{accountId}/templates/{slug}/send`](/docs/api/templates/post_TemplateSend) |

## openemail.system

The platform's public liveness check. [Its page](/docs/sdks/typescript/system).

| Method | What it does | It calls |
| --- | --- | --- |
| [`system.health`](/docs/sdks/typescript/system/health) | Liveness check | [`GET /health`](/docs/api/system/get_Health) |
