addressbooks.createFeedToken
Create addressbook feed token.
Generates a secret read-only feed token URL for syncing a addressbook in external apps (webcal/.ics/.vcf).
openemail.addressbooks.createFeedToken(
identityId: string,
addressbookId: string,
body?: AddressbooksCreateFeedTokenBody,
options?: CallOptions,
): ApiPromise<PimTokenCreated>It calls POST /identities/{identityId}/addressbooks/{addressbookId}/tokens: Create addressbook feed token in the API reference.
Example
const pimTokenCreated = await openemail.addressbooks.createFeedToken(identityId, addressbookId, {})Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
addressbookId | string | Collection ULID or its name slug. The path's {addressbookId}. |
body | AddressbooksCreateFeedTokenBody | Optional. The request's body. |
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, PimTokenCreated. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | No such collection, or mailbox not accessible |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
503 | temporary_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
AddressbooksCreateFeedTokenBody
/** The body of `addressbooks.createFeedToken`. */
type AddressbooksCreateFeedTokenBody = {
/** Unix expiration timestamp in seconds (omit for never) */
expiresAt?: number
/** Human-readable token description (e.g. 'Apple Calendar') */
label?: string
}It names these types of the API, each on a page of its own: PimTokenCreated.