CalendarItem

Topic Last Modified: 2009-07-23

The CalendarItem element represents an Exchange calendar item.

Syntax

<CalendarItem>
   <MimeContent/>
   <ItemId/>
   <ParentFolderId/>
   <ItemClass/>
   <Subject/>
   <Sensitivity/>
   <Body/>
   <Attachments/>
   <DateTimeReceived/>
   <Size/>
   <Categories/>
   <InReplyTo/>
   <IsSubmitted/>
   <IsDraft/>
   <IsFromMe/>
   <IsResend/>
   <IsUnmodified/>
   <InternetMessageHeaders/>
   <DateTimeSent/>
   <DateTimeCreated/>
   <ResponseObjects/>
   <ReminderDueBy/>
   <ReminderIsSet/>
   <ReminderMinutesBeforeStart/>
   <DisplayCc/>
   <DisplayTo/>
   <HasAttachments/>
   <ExtendedProperty/>
   <Culture/>
   <Start/>
   <End/>
   <OriginalStart/>
   <IsAllDayEvent/>
   <LegacyFreeBusyStatus/>
   <Location/>
   <When/>
   <IsMeeting/>
   <IsCancelled/>
   <IsRecurring/>
   <MeetingRequestWasSent/>
   <IsResponseRequested/>
   <CalendarItemType/>
   <MyResponseType/>
   <Organizer/>
   <RequiredAttendees/>
   <OptionalAttendees/>
   <Resources/>
   <ConflictingMeetingCount/>
   <AdjacentMeetingCount/>
   <ConflictingMeetings/>
   <AdjacentMeetings/>
   <Duration/>
   <TimeZone/>
   <AppointmentReplyTime/>
   <AppointmentSequenceNumber/>
   <AppointmentState/>
   <Recurrence/>
   <FirstOccurrence/>
   <LastOccurrence/>
   <ModifiedOccurrences/>
   <DeletedOccurrences/>
   <MeetingTimeZone/>
   <ConferenceType/>
   <AllowNewTimeProposal/>
   <IsOnlineMeeting/>
   <MeetingWorkspaceUrl/>
   <NetShowUrl/>
   <EffectiveRights/>
   <ReceivedBy/>
   <ReceivedRepresenting/>
</CalendarItem>

Type

CalendarItemType

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child Elements

Element Description

MimeContent

Contains the native Multipurpose Internet Mail Extensions (MIME) stream of an object that is represented in base64Binary format.

ItemId

Contains the unique identifier and change key of an item in the Exchange store.

ParentFolderId

Represents the identifier of the parent folder that contains the item or folder.

ItemClass

Represents the message class of an item.

Subject

Represents the subject for Exchange store items and response objects.

Sensitivity

Indicates the sensitivity level of an item.

Body

Represents the actual body content of a message.

Attachments

Contains the items or files that are attached to an item in the Exchange store.

DateTimeReceived

Represents the date and time that an item in a mailbox was received.

Size

Represents the size in bytes of an item. This property is read-only.

Categories

Represents a collection of strings that identify the categories to which an item in the mailbox belongs.

Importance

Describes the importance of an item.

InReplyTo

Represents the identifier of the item to which this item is a reply.

IsSubmitted

Indicates whether an item has been submitted to the Outbox default folder.

IsDraft

Indicates whether an item has not yet been sent.

IsFromMe

Indicates whether a user sent an item to him or herself.

IsResend

Indicates whether the item had previously been sent.

IsUnmodified

Indicates whether the item has been modified.

InternetMessageHeaders

Represents the collection of all Internet message headers that are contained in an item in a mailbox.

DateTimeSent

Represents the date and time that an item in a mailbox was sent.

DateTimeCreated

Represents the date and time that a given item in the mailbox was created.

ResponseObjects

Contains a collection of all the response objects that are associated with an item in the Exchange store.

ReminderDueBy

Represents the date and time when the event occurs. This is used by the ReminderMinutesBeforeStart element to determine when the reminder is displayed.

ReminderIsSet

Indicates whether a reminder has been set for an item in the Exchange store.

ReminderMinutesBeforeStart

Represents the number of minutes before an event when a reminder is displayed.

DisplayCc

Represents the display string that is used for the contents of the Cc line. This is the concatenated string of all Cc recipient display names.

DisplayTo

Represents the display string that is used for the contents of the To line. This is the concatenated string of all To recipient display names.

HasAttachments

Represents a property that is set to true if an item has at least one visible attachment. This property is read-only.

ExtendedProperty

Identifies extended properties on folders and items.

Culture

Represents the culture for a given item in a mailbox.

UID

Identifies a calendar item.

RecurrenceId

Used to identify a specific instance of a recurring calendar item.

DateTimeStamp

Indicates the date and time that an instance of a iCalendar object was created.

Start

Represents the start of a calendar item. This element only applies to a single occurrence of a calendar item.

End

Represents the end of a duration. This element only applies to a single occurrence of a calendar item.

OriginalStart

Represents the original start time of an occurrence.

IsAllDayEvent

Indicates whether a calendar item or meeting request represents an all-day event.

LegacyFreeBusyStatus

Represents the free/busy status of the calendar item.

Location

Represents the location of a meeting or appointment.

When

Provides information about when a calendar item occurs.

IsMeeting

Indicates whether the calendar item is a meeting or appointment.

IsCancelled

Indicates whether an appointment or meeting has been canceled.

IsRecurring

Indicates whether a calendar item is part of a recurring item. This element is read-only.

MeetingRequestWasSent

Indicates whether a meeting request has been sent to requested attendees.

IsResponseRequested

Indicates whether a response to an item is required.

CalendarItemType

Represents the type of a calendar item.

MyResponseType

Contains the status of or response to a calendar item.

Organizer

Represents the organizer of a meeting.

RequiredAttendees

Represents attendees that are required to attend a meeting.

OptionalAttendees

Represents attendees that are not required to attend a meeting.

Resources

Represents a scheduled resource for a meeting.

ConflictingMeetingCount

Represents the number of meetings that conflict with the calendar item.

AdjacentMeetingCount

Represents the total number of calendar items that are adjacent to a meeting time.

ConflictingMeetings

Identifies all calendar items that conflict with a meeting time.

AdjacentMeetings

Describes all calendar items that are adjacent to a meeting time.

Duration (Items)

Represents the duration of a calendar item.

TimeZone (Item)

Provides a text description of a time zone.

AppointmentReplyTime

Represents the date and time when an attendee replied to a meeting request.

AppointmentSequenceNumber

Specifies the sequence number of a version of an appointment.

AppointmentState

Specifies the status of the appointment.

Recurrence (RecurrenceType)

Contains the recurrence pattern for calendar items and meeting requests.

This element is valid if CalendarItemType has the RecurringMaster value.

FirstOccurrence

Represents the first occurrence of a recurring calendar item.

This element is valid if CalendarItemType has the RecurringMaster value.

LastOccurrence

Represents the last occurrence of a recurring calendar item.

This element is valid if CalendarItemType has the RecurringMaster value.

ModifiedOccurrences

Contains an array of recurring calendar item occurrences that have been modified so that they differ from the recurrence master item.

This element is valid if CalendarItemType has the RecurringMaster value.

DeletedOccurrences

Contains an array of deleted occurrences of a recurring calendar item.

This element is valid if CalendarItemType has the RecurringMaster value.

MeetingTimeZone

Represents the time zone of the location where the meeting is hosted.

ConferenceType

Describes the type of conferencing that is performed with a calendar item.

AllowNewTimeProposal

Indicates whether a new meeting time can be proposed for a meeting by an attendee.

IsOnlineMeeting

Indicates whether the meeting is online.

MeetingWorkspaceUrl

Contains the URL for the meeting workspace that is linked to by the calendar item.

NetShowUrl

Specifies the URL for a Microsoft NetShow online meeting.

EffectiveRights

Contains the client's rights based on the permission settings for the item or folder. This element is read-only. This element was introduced in Microsoft Exchange Server 2007 Service Pack 1 (SP1).

ReceivedBy

Identifies the delegate in a delegate access scenario. This element was introduced in Exchange 2007 SP1.

ReceivedRepresenting

Identifies the principal in a delegate access scenario. This element was introduced in Exchange 2007 SP1.

Parent Elements

Element Description

AdjacentMeetings

Describes all calendar items that are adjacent to a meeting time.

AppendToItemField

Identifies data to append to a single property of an item or folder during an UpdateItem Operation.

ConflictingMeetings

Identifies all items that conflict with a meeting time.

Create (ItemSync)

Identifies a single folder to create in the local client store.

ItemAttachment

Represents an Exchange item that is attached to another Exchange item.

Items

Contains an array of items.

Items (CreateItem)

Contains an array of items to create in the folder that is identified by the ParentFolderId (Create) element.

SetItemField

Represents an update to a single property of an item in an UpdateItem Operation.

Update (ItemSync)

Identifies a single item to update in the local client store.

Remarks

When a single calendar item is updated to become a recurring master calendar item, the MeetingTimeZone element must be specified to preserve the calendar item's original time zone.

The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Element Information

Namespace

https://schemas.microsoft.com/exchange/services/2006/types

Schema name

Types schema

Validation file

Types.xsd

Can be empty

False