Skip to Content

List the keywords in use, with counts.

Every distinct keyword on this mailbox's LIVE messages, most-used first then alphabetical, with how many messages carry each.

Expunged messages are excluded: they keep their keywords so a restore can put them back, but they are not mail the user has. Protocol keywords are NOT filtered out — $forwarded, $junk and the rest are returned like any other, because which of them are worth showing is a client's decision, not core's.

Scoped like every other read: a folder-scoped grant reports the keywords inside the grant and no others.

openemail.messages.listKeywords(
  mailboxId: string,
  options?: MessagesListKeywordsOptions,
): ApiPromise<KeywordListPage>

It calls GET /mailboxes/{mailboxId}/keywords: List the keywords in use, with counts in the API reference.

Example

const keywordListPage = await openemail.messages.listKeywords(mailboxId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.

Options

The last argument, options, a MessagesListKeywordsOptions, takes:

OptionTypeSent asDescription
limitnumberquery limitMaximum distinct keywords to return (default 100, max 500). The cut falls on the least-used, since the order is by count.

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, KeywordListPage. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found or not accessible to this principal
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: KeywordListPage.