Cmdlets for Microsoft Exchange

Build 24.0.9060

Tasks

Create, update, delete, and query Tasks items.

Table Specific Information

Update and Delete

The cmdlet will need the ItemChangeKey to update or delete an item. However, if you are unsure of the ItemChangeKey, the cmdlet is able to retrieve it from the Exchange server automatically. Note that this may increase the time it takes to perform a query.

Recurrence Fields

In order to INSERT, SELECT, or UPDATE the Recurrence fields in a Task, you'll need to make sure that you only set the fields associated with the Recurrence_Type and Recurrence_Duration fields. Please see the tables below:

Recurrence_Type Values & Associated Fields

RelativeYearlyRecurrenceRecurrence_DaysOfWeek, Recurrence_DaysOfWeekIndex, Recurrence_Month
AbsoluteYearlyRecurrenceRecurrence_DayOfMonth, Recurrence_Month
RelativeMonthlyRecurrenceRecurrence_Interval, Recurrence_DaysOfWeek, Recurrence_DaysOfWeekIndex
AbsoluteMonthlyRecurrenceRecurrence_Interval, Recurrence_DayOfMonth
WeeklyRecurrenceRecurrence_Interval, Recurrence_DaysOfWeek, Recurrence_FirstDayOfWeek
DailyRecurrence_Interval
*RegenerationRecurrence_Interval

Recurrence_Duration & Associated Fields

NoEndRecurrenceRecurrence_StartDate
EndDateRecurrenceRecurrence_StartDate, Recurrence_EndDate
NumberedRecurrenceRecurrence_StartDate, Recurrence_NumberOfOccurrences

Columns

Name Type ReadOnly Description
ItemId [KEY] String True

Contains the unique identifier of an item in the Exchange store. This property is read-only.

MimeContent String True

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

ItemChangeKey String True

Contains the unique change key of an item in the Exchange store. This property is read-only.

ParentFolderId String False

Represents the unique identifier of the parent folder that contains the item or folder. This property is read-only.

ParentFolderChangeKey String True

Represents the unique change key of the parent folder that contains the item or folder. This property is read-only.

ItemClass String False

Represents the message class of an item.

Subject String False

Represents the subject for Exchange store items and response objects. The subject is limited to 255 characters.

Sensitivity String True

Indicates the sensitivity level of an item.

Body String False

This field contains the body for the Task.

DateTimeReceived Datetime True

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

Size Integer True

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

Categories String False

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

InReplyTo String True

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

IsSubmitted Boolean True

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

IsDraft Boolean True

Represents whether an item has not yet been sent.

IsFromMe Boolean True

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

IsResend Boolean True

Indicates whether the item had previously been sent.

IsUnmodified Boolean True

Indicates whether the item has been modified.

InternetMessageHeaders String True

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

DateTimeSent Datetime True

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

DateTimeCreated Datetime True

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

ReminderDueBy Datetime False

Represents the date and time when the event occurs.

ReminderIsSet Boolean False

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

ReminderMinutesBeforeStart Integer False

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

DisplayCc String True

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

DisplayTo String True

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

HasAttachments Boolean True

Indicates whether an item has attachments.

Culture String False

Represents the Culture of an item.

ActualWork Integer False

Represents the actual amount of time that is spent on a task.

AssignedTime Datetime False

Represents the time when a task is assigned to a contact.

BillingInformation String False

Holds billing information for a task.

ChangeCount Integer False

Specifies the version of the task.

Companies1 String False

Represents the collection of companies that are associated with a contact or task.

Companies2 String False

Represents the collection of companies that are associated with a contact or task.

Companies3 String False

Represents the collection of companies that are associated with a contact or task.

CompleteDate Datetime False

Represents the date on which a task is completed.

Contacts1 String False

Contains a list of contacts who are associated with a task.

Contacts2 String False

Contains a list of contacts who are associated with a task.

Contacts3 String False

Contains a list of contacts who are associated with a task.

DelegationState String False

Represents the status of a delegated task.

Delegator String False

Contains the name of the delegator who assigned the task.

DueDate Datetime False

Represents the date when a task item is due.

IsAssignmentEditable Boolean False

Indicates whether the task is editable or not.

IsComplete Boolean False

Indicates whether the task has been completed or not.

IsRecurring Boolean True

Indicates whether a task is part of a recurring item.

IsTeamTask Boolean False

Indicates whether the task is owned by a team or not.

Mileage String False

Represents mileage for a task item.

Owner String False

Represents the owner of a task.

PercentComplete Double False

Describes the completion status of a task.

Recurrence_Type String False

Contains the recurrence type for task items and meeting requests.

The allowed values are RelativeYearlyRecurrence, AbsoluteYearlyRecurrence, RelativeMonthlyRecurrence, AbsoluteMonthlyRecurrence, WeeklyRecurrence, DailyRecurrence, DailyRegeneration, WeeklyRegeneration, MonthlyRegeneration, YearlyRegeneration.

Recurrence_DaysOfWeek String False

Describes days of the week that are used in item recurrence patterns.

Recurrence_DayOfWeekIndex String False

Describes which week in a month is used in a relative yearly recurrence pattern.

The allowed values are First, Second, Third, Fourth, Last.

Recurrence_Month String False

Describes the month when a yearly recurring item occurs.

Recurrence_DayOfMonth Integer False

Describes the day in a month on which a recurring item occurs.

Recurrence_Interval Integer False

Defines the interval between two consecutive recurring items.

Recurrence_FirstDayOfWeek String False

Specifies the first day of the week.

Recurrence_Duration String False

Contains the recurrence duration type for task items and meeting requests.

The allowed values are NoEndRecurrence, EndDateRecurrence, NumberedRecurrence.

Recurrence_StartDate Datetime False

Represents the start date of a recurring task or calendar item.

Recurrence_EndDate Datetime False

Represents the end date of a recurring task or calendar item.

Recurrence_NumberOfOccurrences Integer False

Contains the number of occurrences of a recurring item.

StartDate Datetime False

Represents the start date of a task item.

Status String False

Represents the status of a task item.

StatusDescription String True

Contains an explanation of the task status.

TotalWork Integer False

Contains a description of how much work is associated with an item.

EffectiveRights_CreateAssociated Boolean True

Indicates whether a client can create an associated contents table.

EffectiveRights_CreateContents Boolean True

Indicates whether a client can create a contents table.

EffectiveRights_CreateHierarchy Boolean True

Indicates whether a client can create a hierarchy table.

EffectiveRights_Delete Boolean True

Indicates whether a client can delete a folder or item.

EffectiveRights_Modify Boolean True

Indicates whether a client can modify a folder or item.

EffectiveRights_Read Boolean True

Indicates whether a client can read a folder or item.

EffectiveRights_ViewPrivateItems Boolean True

Indicates whether a private item can be viewed.

LastModifiedName String True

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

LastModifiedTime Datetime True

Indicates when an item was last modified.

IsAssociated Boolean False

Indicates whether the item is associated with a folder.

WebClientReadFormQueryString String True

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

WebClientEditFormQueryString String True

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

ConversationId String True

Contains the identifier of an item or conversation.

ConversationChangeKey String True

Contains the change key of an item or conversation.

UniqueBody String False

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

UniqueBodyType String False

Describes how the unique item body is stored in the item (HTML or TEXT).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ImpersonationUser String

The Identifier of the user to impersonate.

ImpersonationType String

The type of Identifier used for the impersonation user (PrincipalName, SID, PrimarySmtpAddress, SmtpAddress).

SharedMailboxEmail String

The email of a shared mailbox. Use this to retrieve the task items of a shared mailbox.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060