office.tasksuggestion.yml

### YamlMime:TSType
name: Office.TaskSuggestion
uid: 'outlook!Office.TaskSuggestion:interface'
package: outlook!
fullName: Office.TaskSuggestion
summary: >-
  Represents a suggested task identified in an item. Read mode only.


  The list of tasks suggested in an email message is returned in the `taskSuggestions` property of the
  [Entities](xref:outlook!Office.Entities:interface) object that's returned when the `getEntities` or
  `getEntitiesByType` method is called on the active item.


  **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still
  supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
  For guidance on how to implement these rules, see [Contextual Outlook
  add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: >-
  **[Minimum permission
  level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
  **read item**


  **[Applicable Outlook
  mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
  Read


  #### Examples


  ```TypeScript

  const item = Office.context.mailbox.item;

  // Get an array of strings that represent task suggestions in the current item's body.

  const taskSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.TaskSuggestion);

  console.log("There are " + taskSuggestions.length + " task suggestions.")

  taskSuggestions.forEach(function (taskSuggestion) {
      console.log("Assignees: " + JSON.stringify(taskSuggestion.assignees));
      console.log("Task: " + JSON.stringify(taskSuggestion.taskString));
  });

  ```
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
  Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
  instead.
type: interface
properties:
  - name: assignees
    uid: 'outlook!Office.TaskSuggestion#assignees:member'
    package: outlook!
    fullName: assignees
    summary: >-
      Gets the users that should be assigned a suggested task.


      **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
      still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
      solution. For guidance on how to implement these rules, see [Contextual Outlook
      add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
    remarks: ''
    isPreview: false
    isDeprecated: true
    customDeprecatedMessage: >-
      Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
      instead.
    syntax:
      content: 'assignees: EmailUser[];'
      return:
        type: '<xref uid="outlook!Office.EmailUser:interface" />[]'
  - name: taskString
    uid: 'outlook!Office.TaskSuggestion#taskString:member'
    package: outlook!
    fullName: taskString
    summary: >-
      Gets the text of an item that was identified as a task suggestion.


      **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
      still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
      solution. For guidance on how to implement these rules, see [Contextual Outlook
      add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
    remarks: ''
    isPreview: false
    isDeprecated: true
    customDeprecatedMessage: >-
      Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
      instead.
    syntax:
      content: 'taskString: string;'
      return:
        type: string