pim.getFeed
Export collection via feed token.
Returns a full iCalendar or vCard feed for calendar and addressbook sync. No bearer credential: the secret token in the path IS the credential, made to be pasted into a third-party calendar or contacts app.
openemail.pim.getFeed(token: string, options?: CallOptions): ApiPromise<string>It calls GET /pim/feeds/{token}: Export collection via feed token in the API reference. The operation is public: the client sends it without its credential.
Example
const text = await openemail.pim.getFeed(token)Arguments
| Argument | Type | Description |
|---|---|---|
token | string | Secret feed token. The path's {token}. |
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 text the API answers, a string. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
404 | not_found: unknown, expired, or revoked token. credential_reissue_required (with a message): a token in the format feed URLs had before the platform's directory cutover, which no longer serves (recognized by its shape, so a token of that format is refused this way whether or not it was ever issued); the collection's owner creates a new feed token and the subscriber adds its URL in place of the old one. Both are permanent: do not retry. |
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.