outlookTaskFolder resource type (deprecated)
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Caution
The Outlook tasks API is deprecated and stopped returning data on August 20, 2022. Use the To Do API instead.
A folder that contains Outlook tasks (collection of outlookTask objects).
In Outlook, the default task group, My Tasks, contains a default task folder, Tasks, for the user's mailbox.
You can't rename or delete these default task groups or folders, but you can create new task groups and folders.
Methods
| Method | Return Type | Description | |||
|---|---|---|---|---|---|
| Get | outlookTaskFolder | Get the properties and relationships of the specified Outlook task folder. | |||
| Create task folder in group | outlookTask | Create an Outlook task in the specified task folder. | |||
| List task folders in group | outlookTask collection | Get all the Outlook tasks in the specified folder. | |||
| Update | outlookTaskFolder | Update the writable properties of an Outlook task folder. | |||
| Delete | None | Delete the specified Outlook task folder. | |||
| Permanently delete | None | Permanently delete an Outlook task and place it in the Purges folder in the Recoverable Items folder in the user's mailbox. | ](../api/outlooktaskfolder-permanentdelete.md) | None | Permanently delete an Outlook task folder and remove its items from the user's mailbox. |
| Extended properties | |||||
| Create single-value property | outlookTaskFolder | Create one or more single-value extended properties in a new or existing Outlook task folder. | |||
| Get single-value property | outlookTaskFolder | Get Outlook task folders that contain a single-value extended property by using $expand or $filter. |
|||
| Create multi-value property | outlookTaskFolder | Create one or more multi-value extended properties in a new or existing Outlook task folder. | |||
| Get multi-value property | outlookTaskFolder | Get an Outlook task folder that contains a multi-value extended property by using $expand. |
Properties
| Property | Type | Description |
|---|---|---|
| changeKey | String | The version of the task folder. |
| id | String | The identifier of the task folder, unique in the user's mailbox. Read-only. |
| isDefaultFolder | Boolean | True if the folder is the default task folder. |
| name | String | The name of the task folder. |
| parentGroupKey | Guid | The unique GUID identifier for the task folder's parent group. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | The collection of multi-value extended properties defined for the task folder. Read-only. Nullable. |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | The collection of single-value extended properties defined for the task folder. Read-only. Nullable. |
| tasks | outlookTask collection | The tasks in this task folder. Read-only. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"changeKey": "String",
"id": "String (identifier)",
"isDefaultFolder": true,
"name": "String",
"parentGroupKey": "Guid"
}