Skip to Content

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

FieldTypeDescription
allDaybooleanTrue when DTSTART is a DATE; render the start as a UTC calendar date without a time
attendeeCountnumberTotal number of attendees
attendeesPimAttendee[]List of parsed attendees
calendarIdstring | nullCalendar ID holding the stored copy, or null
canRespondbooleanTrue if the caller can submit an RSVP response
component('VEVENT' | 'VTODO' | 'VJOURNAL') | nulliCalendar component type
dtendnumber | nullEnd timestamp in epoch seconds, or null
dtstartnumber | nullStart timestamp in epoch seconds, or null
foundbooleanTrue if this event is already stored in a calendar
hrefstring | nullDAV resource path of the stored copy, or null
isOrganizerbooleanTrue if this mailbox is the organizer of the event
locationstring | nullEvent location
methodstring | nulliTIP method (REQUEST, CANCEL, REPLY), or null
myAddressstring | nullRecipient address matching an attendee on this invite
myPartstatstring | nullCaller's current reply status (ACCEPTED, DECLINED, TENTATIVE, NEEDS-ACTION)
organizerstring | nullOrganizer email address, or null
rrulestring | nullRecurrence rule (RRULE), or null
sectionstringMIME section of the text/calendar part
summarystring | nullEvent title or summary
uidstring | nullCalendar event UID, or null

Used by

MethodWhat it does
messages.getInvitationGet invitation from email message

On this page