schedulingInbox.get
Read one scheduling Inbox entry.
The scheduling message an Inbox entry holds — METHOD and all — as text/calendar. Owner-only. 404 once the entry has been consumed.
openemail.schedulingInbox.get(
identityId: string,
entryId: string,
options?: CallOptions,
): ApiPromise<string>It calls GET /identities/{identityId}/scheduling-inbox/{entryId}: Read one scheduling Inbox entry in the API reference.
Example
const text = await openemail.schedulingInbox.get(identityId, entryId)Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Identity ULID identifier. The path's {identityId}. |
entryId | string | Inbox entry ULID, from the listing. The path's {entryId}. |
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 |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | No such pending entry, or not this principal's identity |
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.