Skip to Content
GET
/api/v1/mailboxes/{mailboxId}/messages/{messageId}/invitation

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

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

messageId*string

Message ULID identifier

Response Body

Parsed meeting invitation details and RSVP options

application/json
  1. response
allDay*boolean

True when DTSTART is a DATE; render the start as a UTC calendar date without a time

attendeeCount*integer

Total number of attendees

attendees*array<>

List of parsed attendees

calendarId*|

Calendar ID holding the stored copy, or null

canRespond*boolean

True if the caller can submit an RSVP response

component*|

iCalendar component type

Value in"VEVENT""VTODO""VJOURNAL"
dtend*|

End timestamp in epoch seconds, or null

Formatint64
dtstart*|

Start timestamp in epoch seconds, or null

Formatint64
found*boolean

True if this event is already stored in a calendar

href*|

DAV resource path of the stored copy, or null

isOrganizer*boolean

True if this mailbox is the organizer of the event

location*|

Event location

method*|

iTIP method (REQUEST, CANCEL, REPLY), or null

myAddress*|

Recipient address matching an attendee on this invite

myPartstat*|

Caller's current reply status (ACCEPTED, DECLINED, TENTATIVE, NEEDS-ACTION)

organizer*|

Organizer email address, or null

rrule*|

Recurrence rule (RRULE), or null

section*string

MIME section of the text/calendar part

summary*|

Event title or summary

uid*|

Calendar event UID, or null

Example Request
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/messages/string/invitation'
Example Response
{
  "allDay": true,
  "attendeeCount": 0,
  "attendees": [
    {
      "cn": "string",
      "email": "string",
      "partstat": "string",
      "role": "string",
      "rsvp": true
    }
  ],
  "calendarId": "string",
  "canRespond": true,
  "component": "VEVENT",
  "dtend": 0,
  "dtstart": 0,
  "found": true,
  "href": "string",
  "isOrganizer": true,
  "location": "string",
  "method": "string",
  "myAddress": "string",
  "myPartstat": "string",
  "organizer": "string",
  "rrule": "string",
  "section": "string",
  "summary": "string",
  "uid": "string"
}