# messages.getInvitation

Get invitation from email message.

Extracts and parses the iCalendar (.ics) meeting invitation from an email message with filing status and RSVP options.

```ts
openemail.messages.getInvitation(
  mailboxId: string,
  messageId: string,
  options?: CallOptions,
): ApiPromise<MessageInvitation>
```

It calls `GET /mailboxes/{mailboxId}/messages/{messageId}/invitation`: [Get invitation from email message](/docs/api/pim/get_MessageInvitationRoute) in the API reference.

## Example

```ts
const messageInvitation = await openemail.messages.getInvitation(mailboxId, messageId)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `messageId` | `string` | Message ULID identifier. The path's `{messageId}`. |

## 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 API's JSON, [`MessageInvitation`](/docs/sdks/typescript/types/message-invitation). 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` | not_found or no_invitation (message has no calendar invitation part) |
| `413` | message_too_large or invitation_too_large |
| `422` | unparseable_message |
| `500` | blob_missing |
| `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.

## Types

It names these types of the API, each on a page of its own: [`MessageInvitation`](/docs/sdks/typescript/types/message-invitation).
