# calendars.export

Export whole calendar.

Exports the entire calendar collection as a single iCalendar (.ics) text stream.

```ts
openemail.calendars.export(
  identityId: string,
  calendarId: string,
  options?: CallOptions,
): ApiPromise<string>
```

It calls `GET /identities/{identityId}/calendars/{calendarId}/export`: [Export whole calendar](/docs/api/pim/get_CalendarExport) in the API reference.

## Example

```ts
const text = await openemail.calendars.export(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

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](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the text the API answers, a `string`. It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.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 |
| `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`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.
