Documentation

CalendarItemType extends ItemType
in package

Represents an Exchange calendar item.

Table of Contents

Properties

$AdjacentMeetingCount  : int
Represents the total number of calendar items that are adjacent to a meeting time.
$AdjacentMeetings  : NonEmptyArrayOfAllItemsType
Describes all calendar items that are adjacent to a meeting time.
$AllowNewTimeProposal  : bool
Indicates whether a new meeting time can be proposed for a meeting by an attendee.
$AppointmentReplyTime  : string
Represents the date and time when an attendee replied to a meeting request.
$AppointmentSequenceNumber  : int
Specifies the sequence number of a version of an appointment.
$AppointmentState  : string
Specifies the status of the appointment.
$Attachments  : NonEmptyArrayOfAttachmentsType
Contains the items or files that are attached to an item in the Exchange store.
$Body  : BodyType
Represents the actual body content of a message.
$CalendarItemType  : string
Represents the occurrence type of a calendar item.
$Categories  : ArrayOfStringsType
Represents a collection of strings that identify the categories to which an item in the mailbox belongs.
$ConferenceType  : string
Describes the type of conferencing that is performed with a calendar item.
$ConflictingMeetingCount  : int
Represents the number of meetings that conflict with the calendar item.
$ConflictingMeetings  : NonEmptyArrayOfAllItemsType
Identifies all items that conflict with a meeting time.
$ConversationId  : ItemIdType
Contains the identifier of an item or conversation.
$Culture  : string
Represents the culture for a given item in a mailbox.
$DateTimeCreated  : string
Represents the date and time that a given item in the mailbox was created.
$DateTimeReceived  : string
Represents the date and time that an item in a mailbox was received.
$DateTimeSent  : string
Represents the date and time that an item in a mailbox was sent.
$DateTimeStamp  : string
Indicates the date and time that an instance of a iCalendar object was created.
$DeletedOccurrences  : NonEmptyArrayOfDeletedOccurrencesType
Contains an array of deleted occurrences of a recurring calendar item.
$DisplayCc  : string
Represents the display string that is used for the contents of the Cc line.
$DisplayTo  : string
Represents the display string that is used for the contents of the To line.
$Duration  : string
Represents the duration of a calendar item.
$EffectiveRights  : EffectiveRightsType
Contains the client's rights based on the permission settings for the item or folder.
$End  : string
Represents the end of a duration.
$EndTimeZone  : TimeZoneDefinitionType
Represents the end time zone of the calendar item.
$ExtendedProperty  : array<string|int, ExtendedPropertyType>
Identifies extended properties on folders and items.
$FirstOccurrence  : TimeZoneDefinitionType
Represents the first occurrence of a recurring calendar item.
$HasAttachments  : bool
Represents a property that is set to true if an item has at least one visible attachment.
$Importance  : string
Describes the importance of an item.
$InReplyTo  : string
Represents the identifier of the item to which this item is a reply.
$InternetMessageHeaders  : NonEmptyArrayOfInternetHeadersType
Represents the collection of all Internet message headers that are contained in an item in a mailbox.
$IsAllDayEvent  : bool
Indicates whether a calendar item or meeting request represents an all-day event.
$IsAssociated  : bool
Indicates whether the item is associated with a folder.
$IsCancelled  : bool
Indicates whether an appointment or meeting has been canceled.
$IsDraft  : bool
Indicates whether an item has not yet been sent.
$IsFromMe  : bool
Indicates whether a user sent an item to him or herself.
$IsMeeting  : bool
Indicates whether the calendar item is a meeting or appointment.
$IsOnlineMeeting  : bool
Indicates whether the meeting is online.
$IsRecurring  : bool
Indicates whether a calendar item is part of a recurring item.
$IsResend  : bool
Indicates whether the item had previously been sent.
$IsResponseRequested  : bool
Indicates whether a response to an item is required.
$IsSubmitted  : bool
Indicates whether an item has been submitted to the Outbox default folder.
$IsUnmodified  : bool
Indicates whether the item has been modified.
$ItemClass  : string
Represents the message class of an item.
$ItemId  : ItemIdType
Contains the unique identifier and change key of an item in the Exchange store.
$LastModifiedName  : string
Contains the display name of the last user to modify an item.
$LastModifiedTime  : string
Indicates when an item was last modified.
$LastOccurrence  : OccurrenceInfoType
Represents the last occurrence of a recurring calendar item.
$LegacyFreeBusyStatus  : string
Represents the free/busy status of the calendar item.
$Location  : string
Represents the location of a meeting or appointment.
$MeetingRequestWasSent  : bool
Indicates whether a meeting request has been sent to requested attendees.
$MeetingTimeZone  : TimeZoneType
Represents the time zone of the location where the meeting is hosted.
$MeetingWorkspaceUrl  : string
Contains the URL for the meeting workspace that is linked to by the calendar item.
$MimeContent  : MimeContentType
Contains the native Multipurpose Internet Mail Extensions (MIME) stream of an object that is represented in base64Binary format.
$ModifiedOccurrences  : NonEmptyArrayOfOccurrenceInfoType
Contains an array of recurring calendar item occurrences that have been modified so that they differ from the recurrence master item.
$MyResponseType  : string
Contains the status of or response to a calendar item.
$NetShowUrl  : string
Specifies the URL for a Microsoft NetShow online meeting.
$OptionalAttendees  : NonEmptyArrayOfAttendeesType
Represents attendees that are not required to attend a meeting.
$Organizer  : SingleRecipientType
Represents the organizer of a meeting.
$OriginalStart  : string
Represents the original start time of a calendar item.
$ParentFolderId  : FolderIdType
Represents the identifier of the parent folder that contains the item or folder.
$ReceivedBy  : SingleRecipientType
Identifies the delegate in a delegate access scenario.
$ReceivedRepresenting  : SingleRecipientType
Identifies the principal in a delegate access scenario.
$Recurrence  : RecurrenceType
Contains the recurrence pattern for calendar items and meeting requests.
$RecurrenceId  : string
Used to identify a specific instance of a recurring calendar item.
$ReminderDueBy  : string
Represents the date and time when the event occurs.
$ReminderIsSet  : bool
Indicates whether a reminder has been set for an item in the Exchange store.
$ReminderMinutesBeforeStart  : int
Represents the number of minutes before an event when a reminder is displayed.
$RequiredAttendees  : NonEmptyArrayOfAttendeesType
Represents attendees that are required to attend a meeting.
$Resources  : NonEmptyArrayOfAttendeesType
Represents a scheduled resource for a meeting.
$ResponseObjects  : NonEmptyArrayOfResponseObjectsType
Contains a collection of all the response objects that are associated with an item in the Exchange store.
$Sensitivity  : string
Indicates the sensitivity level of an item.
$Size  : int
Represents the size in bytes of an item.
$Start  : string
Represents the start of a calendar item.
$StartTimeZone  : TimeZoneDefinitionType
Represents the start time zone of the calendar item.
$StoreEntryId  : string
Exchange store identifier of an item.
$Subject  : string
Represents the subject for Exchange store items and response objects.
$TimeZone  : string
Provides a text description of a time zone.
$UID  : string
Identifies a calendar item.
$UniqueBody  : BodyType
Represents an HTML fragment or plain text which represents the unique body of this conversation.
$WebClientEditFormQueryString  : string
Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to edit an item in Outlook Web App.
$WebClientReadFormQueryString  : string
Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to read an item in Outlook Web App.
$When  : string
Provides information about when a calendar item occurs.

Methods

__clone()  : mixed
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.

Properties

$AdjacentMeetingCount

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

public int $AdjacentMeetingCount
Tags
since

Exchange 2007

$AdjacentMeetings

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

public NonEmptyArrayOfAllItemsType $AdjacentMeetings
Tags
since

Exchange 2007

$AllowNewTimeProposal

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

public bool $AllowNewTimeProposal
Tags
since

Exchange 2007

$AppointmentReplyTime

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

public string $AppointmentReplyTime
Tags
since

Exchange 2007

todo

Make a DateTime object.

$AppointmentSequenceNumber

Specifies the sequence number of a version of an appointment.

public int $AppointmentSequenceNumber
Tags
since

Exchange 2007

$AppointmentState

Specifies the status of the appointment.

public string $AppointmentState
Tags
since

Exchange 2007

see
AppointmentState

$Attachments

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

public NonEmptyArrayOfAttachmentsType $Attachments

This property is read-only.

Tags
since

Exchange 2007

$Body

Represents the actual body content of a message.

public BodyType $Body
Tags
since

Exchange 2007

$CalendarItemType

Represents the occurrence type of a calendar item.

public string $CalendarItemType
Tags
since

Exchange 2007

see
CalendarItemTypeType

$Categories

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

public ArrayOfStringsType $Categories
Tags
since

Exchange 2007

$ConferenceType

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

public string $ConferenceType
Tags
since

Exchange 2007

see
ConferenceType

$ConflictingMeetingCount

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

public int $ConflictingMeetingCount
Tags
since

Exchange 2007

$ConflictingMeetings

Identifies all items that conflict with a meeting time.

public NonEmptyArrayOfAllItemsType $ConflictingMeetings
Tags
since

Exchange 2007

$ConversationId

Contains the identifier of an item or conversation.

public ItemIdType $ConversationId
Tags
since

Exchange 2010

$Culture

Represents the culture for a given item in a mailbox.

public string $Culture

Specified by using the RFC 1766 culture identifier; for example, en-US.

Tags
since

Exchange 2007

$DateTimeCreated

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

public string $DateTimeCreated
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DateTimeReceived

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

public string $DateTimeReceived
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DateTimeSent

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

public string $DateTimeSent
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DateTimeStamp

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

public string $DateTimeStamp
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DeletedOccurrences

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

public NonEmptyArrayOfDeletedOccurrencesType $DeletedOccurrences

This element is valid if CalendarItemType has the RecurringMaster value.

Tags
since

Exchange 2007

$DisplayCc

Represents the display string that is used for the contents of the Cc line.

public string $DisplayCc

This is the concatenated string of all Cc recipient display names.

Tags
since

Exchange 2007

$DisplayTo

Represents the display string that is used for the contents of the To line.

public string $DisplayTo

This is the concatenated string of all To recipient display names.

Tags
since

Exchange 2007

$Duration

Represents the duration of a calendar item.

public string $Duration
Tags
since

Exchange 2007

$EffectiveRights

Contains the client's rights based on the permission settings for the item or folder.

public EffectiveRightsType $EffectiveRights

This property is read-only.

Tags
since

Exchange 2007 SP1

$End

Represents the end of a duration.

public string $End

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

Tags
since

Exchange 2007

todo

Make a DateTime object.

$EndTimeZone

Represents the end time zone of the calendar item.

public TimeZoneDefinitionType $EndTimeZone
Tags
since

Exchange 2010

$ExtendedProperty

Identifies extended properties on folders and items.

public array<string|int, ExtendedPropertyType> $ExtendedProperty = array()
Tags
since

Exchange 2007

$FirstOccurrence

Represents the first occurrence of a recurring calendar item.

public TimeZoneDefinitionType $FirstOccurrence

This element is valid if CalendarItemType has the RecurringMaster value.

Tags
since

Exchange 2007

$HasAttachments

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

public bool $HasAttachments

This property is read-only.

Tags
since

Exchange 2007

$Importance

Describes the importance of an item.

public string $Importance
Tags
since

Exchange 2007

see
ImportanceChoicesType

$InReplyTo

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

public string $InReplyTo
Tags
since

Exchange 2007

$InternetMessageHeaders

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

public NonEmptyArrayOfInternetHeadersType $InternetMessageHeaders
Tags
since

Exchange 2007

$IsAllDayEvent

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

public bool $IsAllDayEvent
Tags
since

Exchange 2007

$IsAssociated

Indicates whether the item is associated with a folder.

public bool $IsAssociated
Tags
since

Exchange 2010

$IsCancelled

Indicates whether an appointment or meeting has been canceled.

public bool $IsCancelled
Tags
since

Exchange 2007

$IsDraft

Indicates whether an item has not yet been sent.

public bool $IsDraft
Tags
since

Exchange 2007

$IsFromMe

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

public bool $IsFromMe
Tags
since

Exchange 2007

$IsMeeting

Indicates whether the calendar item is a meeting or appointment.

public bool $IsMeeting
Tags
since

Exchange 2007

$IsOnlineMeeting

Indicates whether the meeting is online.

public bool $IsOnlineMeeting
Tags
since

Exchange 2007

$IsRecurring

Indicates whether a calendar item is part of a recurring item.

public bool $IsRecurring

This element is read-only.

Tags
since

Exchange 2007

$IsResend

Indicates whether the item had previously been sent.

public bool $IsResend
Tags
since

Exchange 2007

$IsResponseRequested

Indicates whether a response to an item is required.

public bool $IsResponseRequested
Tags
since

Exchange 2007

$IsSubmitted

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

public bool $IsSubmitted
Tags
since

Exchange 2007

$IsUnmodified

Indicates whether the item has been modified.

public bool $IsUnmodified
Tags
since

Exchange 2007

$ItemClass

Represents the message class of an item.

public string $ItemClass
Tags
since

Exchange 2007

see
ItemClassType

$ItemId

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

public ItemIdType $ItemId
Tags
since

Exchange 2007

$LastModifiedName

Contains the display name of the last user to modify an item.

public string $LastModifiedName
Tags
since

Exchange 2010

$LastModifiedTime

Indicates when an item was last modified.

public string $LastModifiedTime
Tags
since

Exchange 2010

todo

Make a DateTime object.

$LastOccurrence

Represents the last occurrence of a recurring calendar item.

public OccurrenceInfoType $LastOccurrence

This element is valid if CalendarItemType has the RecurringMaster value.

Tags
since

Exchange 2007

$LegacyFreeBusyStatus

Represents the free/busy status of the calendar item.

public string $LegacyFreeBusyStatus
Tags
since

Exchange 2007

see
LegacyFreeBusyType

$Location

Represents the location of a meeting or appointment.

public string $Location
Tags
since

Exchange 2007

$MeetingRequestWasSent

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

public bool $MeetingRequestWasSent
Tags
since

Exchange 2007

$MeetingTimeZone

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

public TimeZoneType $MeetingTimeZone
Tags
since

Exchange 2007

$MeetingWorkspaceUrl

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

public string $MeetingWorkspaceUrl
Tags
since

Exchange 2007

$MimeContent

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

public MimeContentType $MimeContent
Tags
since

Exchange 2007

$ModifiedOccurrences

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

public NonEmptyArrayOfOccurrenceInfoType $ModifiedOccurrences

This element is valid if CalendarItemType has the RecurringMaster value.

Tags
since

Exchange 2007

$MyResponseType

Contains the status of or response to a calendar item.

public string $MyResponseType
Tags
since

Exchange 2007

see
ResponseTypeType

$NetShowUrl

Specifies the URL for a Microsoft NetShow online meeting.

public string $NetShowUrl
Tags
since

Exchange 2007

$OptionalAttendees

Represents attendees that are not required to attend a meeting.

public NonEmptyArrayOfAttendeesType $OptionalAttendees
Tags
since

Exchange 2007

$Organizer

Represents the organizer of a meeting.

public SingleRecipientType $Organizer
Tags
since

Exchange 2007

$OriginalStart

Represents the original start time of a calendar item.

public string $OriginalStart
Tags
since

Exchange 2007

todo

Make a DateTime object.

$ParentFolderId

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

public FolderIdType $ParentFolderId
Tags
since

Exchange 2007

$ReceivedBy

Identifies the delegate in a delegate access scenario.

public SingleRecipientType $ReceivedBy
Tags
since

Exchange 2007 SP1

deprecated

Exchange 2010

$ReceivedRepresenting

Identifies the principal in a delegate access scenario.

public SingleRecipientType $ReceivedRepresenting
Tags
since

Exchange 2007 SP1

deprecated

Exchange 2010

$Recurrence

Contains the recurrence pattern for calendar items and meeting requests.

public RecurrenceType $Recurrence

This element is valid if CalendarItemType has the RecurringMaster value.

Tags
since

Exchange 2007

$RecurrenceId

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

public string $RecurrenceId
Tags
since

Exchange 2007

todo

Make a DateTime object.

$ReminderDueBy

Represents the date and time when the event occurs.

public string $ReminderDueBy

This is used by the ReminderMinutesBeforeStart element to determine when the reminder is displayed.

Tags
since

Exchange 2007

todo

Make a DateTime object.

$ReminderIsSet

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

public bool $ReminderIsSet
Tags
since

Exchange 2007

$ReminderMinutesBeforeStart

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

public int $ReminderMinutesBeforeStart
Tags
since

Exchange 2007

todo

Determine if we need a ReminderMinutesBeforeStartType implementation.

$RequiredAttendees

Represents attendees that are required to attend a meeting.

public NonEmptyArrayOfAttendeesType $RequiredAttendees
Tags
since

Exchange 2007

$Resources

Represents a scheduled resource for a meeting.

public NonEmptyArrayOfAttendeesType $Resources
Tags
since

Exchange 2007

$ResponseObjects

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

public NonEmptyArrayOfResponseObjectsType $ResponseObjects
Tags
since

Exchange 2007

$Sensitivity

Indicates the sensitivity level of an item.

public string $Sensitivity
Tags
since

Exchange 2007

see
SensitivityChoicesType

$Size

Represents the size in bytes of an item.

public int $Size

This property is read-only.

Tags
since

Exchange 2007

$Start

Represents the start of a calendar item.

public string $Start

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

Tags
since

Exchange 2007

todo

Make a DateTime object.

$StartTimeZone

Represents the start time zone of the calendar item.

public TimeZoneDefinitionType $StartTimeZone
Tags
since

Exchange 2010

$StoreEntryId

Exchange store identifier of an item.

public string $StoreEntryId
Tags
since

Exchange 2010 SP2

todo

Create a base64 class?

$Subject

Represents the subject for Exchange store items and response objects.

public string $Subject
Tags
since

Exchange 2007

$TimeZone

Provides a text description of a time zone.

public string $TimeZone
Tags
since

Exchange 2007

$UID

Identifies a calendar item.

public string $UID
Tags
since

Exchange 2007

$UniqueBody

Represents an HTML fragment or plain text which represents the unique body of this conversation.

public BodyType $UniqueBody
Tags
since

Exchange 2010

$WebClientEditFormQueryString

Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to edit an item in Outlook Web App.

public string $WebClientEditFormQueryString
Tags
since

Exchange 2010

$WebClientReadFormQueryString

Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to read an item in Outlook Web App.

public string $WebClientReadFormQueryString
Tags
since

Exchange 2010

$When

Provides information about when a calendar item occurs.

public string $When
Tags
since

Exchange 2007

Methods

__clone()

Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.

public __clone() : mixed

        
On this page

Search results