calendars.delete
Delete calendar.
Deletes a calendar collection and all objects stored within it. Both move to the trash tier: GET …/calendars/trash lists them, POST …/trash/{id}/restore brings the collection and its members back (private, since grants and feed tokens were retired), and the purge duty removes them for good fourteen days after deletion.
openemail.calendars.delete(
identityId: string,
calendarId: string,
options?: CalendarsDeleteOptions,
): ApiPromise<CalendarsDeleteResult>It calls DELETE /identities/{identityId}/calendars/{calendarId}: Delete calendar in the API reference.
Example
const result = await openemail.calendars.delete(identityId, calendarId)Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
calendarId | string | Collection ULID or its name slug. The path's {calendarId}. |
Options
The last argument, options, a CalendarsDeleteOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
notify | boolean | query notify | Send iTIP scheduling messages for this write: 'true' cancels as organizer or declines as attendee, 'false' sends nothing. Absent keeps the default — organizers schedule, attendees stay silent. |
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, CalendarsDeleteResult. 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 |
403 | default_collection — default collection cannot be deleted |
404 | No such collection, or mailbox not accessible |
503 | scheduling_unavailable: preparation could not complete; no deletion committed. Or 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) |
507 | scheduling_backlog_full: pending-work or batch budget exhausted; no deletion committed |
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
CalendarsDeleteResult
/** What `calendars.delete` answers. */
type CalendarsDeleteResult = {
deleted: boolean
objectsDestroyed: number
}