calendarObjects.listTrash
List deleted calendar objects.
The objects deleted out of this calendar within the last fourteen days, newest first, metadata only (a restore is how the body comes back). Owner only.
openemail.calendarObjects.listTrash(
identityId: string,
calendarId: string,
options?: CalendarObjectsListTrashOptions,
): PagePromise<PimTrashedObjectPage, PimTrashedObject>It calls GET /identities/{identityId}/calendars/{calendarId}/trash: List deleted calendar objects in the API reference.
Example
for await (const pimTrashedObject of openemail.calendarObjects.listTrash(identityId, calendarId)) {
// every item of every page (await the call instead for one page)
}Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
calendarId | string | Live collection ULID or its name slug. The path's {calendarId}. |
Options
The last argument, options, a CalendarObjectsListTrashOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
limit | number | query limit | Page size (default 200) |
cursor | string | query cursor | nextCursor from the previous page |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
It is a listing, a PagePromise. Awaited, it is one page as the API answers it, PimTrashedObjectPage. Iterated with for await, it is every PimTrashedObject of every page, each page fetched as the loop reaches it.
Errors
| Status | What it means |
|---|---|
400 | invalid_cursor |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | not_found: no such live collection, or mailbox not accessible |
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
It names these types of the API, each on a page of its own: PimTrashedObject, PimTrashedObjectPage.