Skip to Content

List push subscriptions.

Returns the subscriptions registered by the CALLING credential (another app password's registrations on the same mailbox are not visible: they belong to that credential), plus vapidPublicKey, the applicationServerKey a client passes to PushManager.subscribe before POSTing the resulting endpoint here. A null vapidPublicKey means Web Push is not configured on this deployment and POST would refuse. Requires a mailbox app password (oemp_…): subscriptions belong to the credential that creates them, so account and system keys are refused with 403 mailbox_credential_required.

openemail.pushSubscriptions.list(
  options?: CallOptions,
): ApiPromise<PushSubscriptionPage>

It calls GET /push-subscriptions: List push subscriptions in the API reference.

Example

const pushSubscriptionPage = await openemail.pushSubscriptions.list()

Options

It takes no options of its own. 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, PushSubscriptionPage. 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
403mailbox_credential_required
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: PushSubscriptionPage.