CData Python Connector for Microsoft Exchange

Build 25.0.9454

Tasks

Maintains a list of tasks, including due dates, completion status, priorities, and reminders. It supports full task lifecycle management through CRUD operations.

Table Specific Information

Update and Delete

The connector will need the ItemChangeKey to update or delete an item. However, if you are unsure of the ItemChangeKey, the connector 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

Uniquely identifies the item within the Exchange store. This value is immutable and used to retrieve or reference the item programmatically. It is a read-only system-generated identifier.

MimeContent String True

Stores the MIME-encoded content of the item in Base64 format, preserving the original structure and encoding used for email transmission. This is useful for interoperability with external mail systems.

ItemChangeKey String True

Contains the change key that reflects the version of the item. It updates whenever the item is modified, allowing clients to detect and handle concurrent changes. This property is read-only.

ParentFolderId String False

Identifies the folder in which the item resides by its unique ID. This enables clients to organize or retrieve items based on their container folder. This value is read-only.

ParentFolderChangeKey String True

Represents the change key for the parent folder, which changes when the folder's metadata or content changes. Used to ensure consistency in folder-level operations. This property is read-only.

ItemClass String False

Specifies the message class of the item, which determines how the item is processed by Exchange and client applications. Common values include IPM.Task for tasks and IPM.Note for emails.

Subject String False

Holds the text that appears as the subject or title of the item. This is displayed prominently in user interfaces and limited to 255 characters to maintain compatibility with clients.

Sensitivity String True

Defines the sensitivity of the item, such as Normal, Personal, Private, or Confidential. This value can be used to control visibility in shared mailbox scenarios.

Body String False

Contains the main content or description of the task. This field supports plain text or HTML, depending on the message format, and is used to convey task details to users.

DateTimeReceived Datetime True

Captures the timestamp when the item was received in the mailbox. For tasks, this can reflect the creation time or synchronization timestamp from an external system.

Size Integer True

Indicates the total size of the item in bytes, including attachments and message headers. Useful for storage management and quota enforcement. This property is read-only.

Categories String False

Represents a list of user-defined tags or labels assigned to the item. These categories help organize and group items in the mailbox for easier filtering and reporting.

InReplyTo String True

References the item Id of the message to which this item is a response, supporting threaded conversations and message correlation in task discussions.

IsSubmitted Boolean True

Returns true if the item has been submitted to the Outbox for sending. This typically applies to messages or meeting requests generated from a task.

IsDraft Boolean True

Indicates whether the item is still in draft status, meaning it has been saved but not sent or finalized. Drafts can be reopened and edited.

IsFromMe Boolean True

Returns true if the sender of the item is the same as the mailbox owner, which can be used to identify self-addressed tasks or test messages.

IsResend Boolean True

Specifies whether the item was a resend of a previous message or task. Useful for tracking duplicates or repeated submissions.

IsUnmodified Boolean True

Indicates whether the item has remained unchanged since it was last retrieved. Helpful in sync scenarios to detect stale or untouched records.

InternetMessageHeaders String True

Contains all Internet message headers for the item, such as MIME headers and custom transport headers, allowing inspection of routing, origin, and metadata related to the message.

DateTimeSent Datetime True

Stores the exact date and time when the item, such as a task request or message, was sent from the originating mailbox.

DateTimeCreated Datetime True

Records the timestamp indicating when the task or item was initially created in the Exchange system, which can differ from the send or received time.

ReminderDueBy Datetime False

Specifies the date and time when a reminder notification is scheduled to appear, typically used for upcoming task deadlines or important events.

ReminderIsSet Boolean False

Indicates whether a reminder has been enabled for this item. If true, the Exchange client will alert the user at the specified time.

ReminderMinutesBeforeStart Integer False

Defines how many minutes in advance of the due time the reminder should trigger. This helps users receive alerts ahead of key deadlines.

DisplayCc String True

Displays the concatenated display names of recipients listed in the Cc field of the message. This is a read-only string used for rendering the UI.

DisplayTo String True

Shows the concatenated display names of all primary recipients in the To field. This is primarily used for displaying message recipients in user interfaces.

HasAttachments Boolean True

Indicates whether the task or item includes one or more file or item attachments. A true value implies that attachments are present.

Culture String False

Represents the locale and language setting (culture code) associated with the item, such as en-US or fr-FR, which can influence formatting and localization.

ActualWork Integer False

Captures the total amount of time, in minutes, that has been reported as spent working on the task. This value can be used for tracking task progress.

AssignedTime Datetime False

Records the date and time when the task was officially assigned to a recipient, often used to calculate task duration or aging.

BillingInformation String False

Stores billing-related metadata associated with the task, such as charge codes or client references used for internal cost tracking.

ChangeCount Integer False

Tracks the number of times the task has been modified. Each update to the task typically increments this counter, helping with versioning or synchronization.

Companies1 String False

Lists the names of companies associated with the task. Multiple columns (Companies1, Companies2, Companies3) are used to support multiple entries due to schema design.

Companies2 String False

Additional field for listing company names associated with the task. Used when the number of related companies exceeds the capacity of a single field.

Companies3 String False

Third field for listing companies related to the task, allowing extended support for multiple organization associations.

CompleteDate Datetime False

Specifies the date and time when the task was marked as completed. This timestamp is important for workflow tracking and reporting.

Contacts1 String False

Contains the first group of contact names or identifiers associated with the task, often used for tracking stakeholders or collaborators.

Contacts2 String False

Provides a secondary list of associated contacts for the task, continuing from Contacts1 if more contacts are present.

Contacts3 String False

Extends the list of task-associated contacts beyond Contacts1 and Contacts2, supporting a broader range of linked individuals or entities.

DelegationState String False

Indicates the current status of a delegated task, such as whether it has been accepted, declined, or still pending. This helps track the task's lifecycle within a delegation workflow.

Delegator String False

Specifies the display name or identifier of the user who assigned the task to someone else, providing insight into the task's origin and accountability chain.

DueDate Datetime False

Defines the deadline by which the task should be completed. This is used for scheduling, reminders, and task prioritization.

IsAssignmentEditable Boolean False

Indicates whether the assignee can modify the task's properties, such as its subject, due date, or completion status. This is relevant in shared or delegated task scenarios.

IsComplete Boolean False

Shows whether the task has been marked as completed by the user or system. This is used for filtering and reporting on task progress.

IsRecurring Boolean True

Identifies whether the task is configured to repeat at regular intervals. Useful for tasks that must be completed on a recurring basis, such as weekly reports or monthly reviews.

IsTeamTask Boolean False

Indicates whether the task is assigned to a team rather than an individual, helping differentiate between personal and collaborative responsibilities.

Mileage String False

Stores mileage information associated with the task, typically used for expense tracking or travel-related activities logged through the task system.

Owner String False

Represents the user who owns or created the task. This is often the task originator and can differ from the assignee in delegated scenarios.

PercentComplete Double False

Reflects the progress of the task as a percentage value between 0.0 and 100.0, enabling incremental tracking and visual indicators of task status.

Recurrence_Type String False

Specifies the recurrence pattern type for the task, such as daily, weekly, monthly, or yearly, defining how often the task repeats.

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

Recurrence_DaysOfWeek String False

Lists the days of the week (for example, Monday, Wednesday, Friday) on which the task is scheduled to recur. Used in weekly and monthly recurrence rules.

Recurrence_DayOfWeekIndex String False

Indicates which instance of the day is used in the recurrence, such as 'first', 'second', or 'last' Monday of the month. Relevant for relative recurrence rules.

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

Recurrence_Month String False

Specifies the month in which an annually recurring task occurs. Supports scheduling events like yearly audits or anniversaries.

Recurrence_DayOfMonth Integer False

Defines the specific day of the month (1–31) on which the task recurs, commonly used in monthly and yearly recurrence rules.

Recurrence_Interval Integer False

Represents the frequency interval between recurring task occurrences. For example, a value of 2 with a weekly recurrence means every two weeks.

Recurrence_FirstDayOfWeek String False

Defines which day is considered the start of the week (for example, Sunday or Monday), affecting weekly recurrence patterns and calendar alignment.

Recurrence_Duration String False

Describes how long the recurrence pattern lasts, such as whether it is bounded by a number of occurrences or an end date.

The allowed values are NoEndRecurrence, EndDateRecurrence, NumberedRecurrence.

Recurrence_StartDate Datetime False

Indicates the start date from which the recurrence pattern begins, marking the first occurrence of the repeating task or event.

Recurrence_EndDate Datetime False

Indicates the date on which the recurrence pattern ends, beyond which no additional task instances will be created.

Recurrence_NumberOfOccurrences Integer False

Specifies the total number of instances for a recurring task. This helps determine how many times the task should repeat based on its recurrence pattern.

StartDate Datetime False

Defines the date and time at which the task is scheduled to begin. This is typically used to track when work on the task should commence.

Status String False

Indicates the current progress state of the task, such as NotStarted, InProgress, Completed, WaitingOnOthers, or Deferred.

StatusDescription String True

Provides a human-readable explanation of the task's status, offering more detail than the categorical status field.

TotalWork Integer False

Represents the estimated amount of work, in minutes, that is expected to complete the task. This is useful for workload planning and reporting.

EffectiveRights_CreateAssociated Boolean True

Indicates whether the current user or application has permission to create associated items, such as hidden items used internally by applications.

EffectiveRights_CreateContents Boolean True

Specifies whether the user has the right to add new content (for example, tasks or items) to the folder.

EffectiveRights_CreateHierarchy Boolean True

Indicates if the user has the ability to create subfolders within the current folder hierarchy.

EffectiveRights_Delete Boolean True

Denotes whether the user is allowed to delete this item or folder. This can be restricted based on permissions or item state.

EffectiveRights_Modify Boolean True

Specifies whether the user is authorized to make modifications to this item or folder.

EffectiveRights_Read Boolean True

Indicates if the item or folder is readable by the user, which is fundamental to access and view permissions.

EffectiveRights_ViewPrivateItems Boolean True

Specifies whether the user can view items that have been marked as private within the folder.

LastModifiedName String True

Displays the name of the last user who modified the task. This helps identify who last made changes for auditing or tracking purposes.

LastModifiedTime Datetime True

Records the date and time when the task item was last changed. Useful for identifying the most recent updates.

IsAssociated Boolean False

Indicates whether the item is an associated item, which typically means it is not visible in the folder's content view but is used for system or background operations.

WebClientReadFormQueryString String True

Provides the query string segment to append to the Outlook Web App (OWA) base URL to generate a link for reading the task in a browser interface.

WebClientEditFormQueryString String True

Supplies the query string segment used to construct a link for editing the task directly in Outlook Web App (OWA).

ConversationId String True

Stores the unique identifier that links this item to a conversation thread. Useful for grouping related items together.

ConversationChangeKey String True

Holds the change key associated with the conversation or item, which helps detect version changes and maintain synchronization.

UniqueBody String False

Contains the portion of the message body that is unique to this item, excluding any repeated content from previous items in the conversation. Can be in HTML or plain text.

UniqueBodyType String False

Specifies the format used to store the unique body content, such as HTML or plain text, allowing applications to render it appropriately.

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

Specifies the identifier of the user to impersonate when accessing Exchange data. This is used in delegated access scenarios where one account acts on behalf of another.

ImpersonationType String

Defines the type of user identifier provided for impersonation. Supported values include PrincipalName, SID, PrimarySmtpAddress, and SmtpAddress.

SharedMailboxEmail String

Specifies the email address of a shared mailbox. Used to query task data from a shared Exchange mailbox context.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454