MessageInvitation
The MessageInvitation type of the TypeScript SDK, which messages.getInvitation take or answer.
type MessageInvitation = {
allDay: boolean
attendeeCount: number
attendees: PimAttendee[]
calendarId: string | null
canRespond: boolean
component: ('VEVENT' | 'VTODO' | 'VJOURNAL') | null
dtend: number | null
dtstart: number | null
found: boolean
href: string | null
isOrganizer: boolean
location: string | null
method: string | null
myAddress: string | null
myPartstat: string | null
organizer: string | null
rrule: string | null
section: string
summary: string | null
uid: string | null
}Fields
| Field | Type | Description |
|---|---|---|
allDay | boolean | True when DTSTART is a DATE; render the start as a UTC calendar date without a time |
attendeeCount | number | Total number of attendees |
attendees | PimAttendee[] | List of parsed attendees |
calendarId | string | null | Calendar ID holding the stored copy, or null |
canRespond | boolean | True if the caller can submit an RSVP response |
component | ('VEVENT' | 'VTODO' | 'VJOURNAL') | null | iCalendar component type |
dtend | number | null | End timestamp in epoch seconds, or null |
dtstart | number | null | Start timestamp in epoch seconds, or null |
found | boolean | True if this event is already stored in a calendar |
href | string | null | DAV resource path of the stored copy, or null |
isOrganizer | boolean | True if this mailbox is the organizer of the event |
location | string | null | Event location |
method | string | null | iTIP method (REQUEST, CANCEL, REPLY), or null |
myAddress | string | null | Recipient address matching an attendee on this invite |
myPartstat | string | null | Caller's current reply status (ACCEPTED, DECLINED, TENTATIVE, NEEDS-ACTION) |
organizer | string | null | Organizer email address, or null |
rrule | string | null | Recurrence rule (RRULE), or null |
section | string | MIME section of the text/calendar part |
summary | string | null | Event title or summary |
uid | string | null | Calendar event UID, or null |
Used by
| Method | What it does |
|---|---|
messages.getInvitation | Get invitation from email message |