office.appointmentread.yml

### YamlMime:TSType
name: Office.AppointmentRead
uid: 'outlook!Office.AppointmentRead:interface'
package: outlook!
fullName: Office.AppointmentRead
summary: >-
  The appointment attendee mode of [Office.context.mailbox.item](xref:outlook!Office.Item:interface)<!-- -->.


  **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. You should
  treat this as a mode of `Office.context.mailbox.item`<!-- -->. For more information, refer to the [Object
  Model](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.5/office.context.mailbox.item)
  page.


  Parent interfaces:


  - [ItemRead](xref:outlook!Office.ItemRead:interface)


  - [Appointment](xref:outlook!Office.Appointment:interface)
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: attachments
    uid: 'outlook!Office.AppointmentRead#attachments:member'
    package: outlook!
    fullName: attachments
    summary: Gets the item's attachments as an array.
    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)<!--
      -->**: Appointment Attendee


      **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not
      returned. For more information, see [Blocked attachments in
      Outlook](https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519)<!-- -->.


      #### Examples


      ```TypeScript

      // The following code builds an HTML string with details of all attachments on the current item.

      const item = Office.context.mailbox.item;

      let outputString = "";


      if (item.attachments.length > 0) {
          for (let i = 0 ; i < item.attachments.length ; i++) {
              const attachment = item.attachments[i];
              outputString += "<BR>" + i + ". Name: ";
              outputString += attachment.name;
              outputString += "<BR>ID: " + attachment.id;
              outputString += "<BR>contentType: " + attachment.contentType;
              outputString += "<BR>size: " + attachment.size;
              outputString += "<BR>attachmentType: " + attachment.attachmentType;
              outputString += "<BR>isInline: " + attachment.isInline;
          }
      }


      console.log(outputString);

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml


      const attachments = Office.context.mailbox.item.attachments;

      console.log(attachments);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'attachments: AttachmentDetails[];'
      return:
        type: '<xref uid="outlook!Office.AttachmentDetails:interface" />[]'
  - name: body
    uid: 'outlook!Office.AppointmentRead#body:member'
    package: outlook!
    fullName: body
    summary: Gets an object that provides methods for manipulating the body of an item.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // This example gets the body of the item as plain text.

      Office.context.mailbox.item.body.getAsync(
          "text",
          { asyncContext: "This is passed to the callback" },
          function callback(result) {
              // Do something with the result.
          });

      // The following is an example of the result parameter passed to the callback function.

      {
          "value": "TEXT of whole body (including threads below)",
          "status": "succeeded",
          "asyncContext": "This is passed to the callback"
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'body: Body;'
      return:
        type: '<xref uid="outlook!Office.Body:interface" />'
  - name: dateTimeCreated
    uid: 'outlook!Office.AppointmentRead#dateTimeCreated:member'
    package: outlook!
    fullName: dateTimeCreated
    summary: Gets the date and time that an item was created.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml


      console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dateTimeCreated: Date;'
      return:
        type: Date
  - name: dateTimeModified
    uid: 'outlook!Office.AppointmentRead#dateTimeModified:member'
    package: outlook!
    fullName: dateTimeModified
    summary: Gets the date and time that an item was last modified.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on
      supported APIs in Outlook mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml


      console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dateTimeModified: Date;'
      return:
        type: Date
  - name: end
    uid: 'outlook!Office.AppointmentRead#end:member'
    package: outlook!
    fullName: end
    summary: >-
      Gets the date and time that the appointment is to end.


      The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. You can
      use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time.


      When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to
      convert the local time on the client to UTC for the server.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml


      console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'end: Date;'
      return:
        type: Date
  - name: itemClass
    uid: 'outlook!Office.AppointmentRead#itemClass:member'
    package: outlook!
    fullName: itemClass
    summary: >-
      Gets the Exchange Web Services item class of the selected appointment.


      Returns `IPM.Appointment` for non-recurring appointments and `IPM.Appointment.Occurrence` for recurring
      appointments.
    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)<!--
      -->**: Appointment Attendee


      **Important**: You can create custom classes that extend a default item class. For example,
      `IPM.Appointment.Contoso`<!-- -->.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml


      console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'itemClass: string;'
      return:
        type: string
  - name: itemId
    uid: 'outlook!Office.AppointmentRead#itemId:member'
    package: outlook!
    fullName: itemId
    summary: >-
      Gets the [Exchange Web Services item
      identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)
      for the current item.


      The `itemId` property is not available in compose mode. If an item identifier is required, the `saveAsync` method
      can be used to save the item to the store, which will return the item identifier in the `asyncResult.value`
      parameter in the callback function.


      **Note**: The identifier returned by the `itemId` property is the same as the [Exchange Web Services item
      identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)<!--
      -->. The `itemId` property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
      making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
      -->. For more details, see [Use the Outlook REST APIs from an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id)<!-- -->.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // The following code checks for the presence of an item

      // identifier. If the `itemId` property returns `null` or

      // `undefined`, it saves the item to the store and gets the

      // item identifier from the asynchronous result.

      // **Important**: `saveAsync` was introduced with requirement set 1.3

      // so you can't get the `itemId` in Compose mode in earlier sets.

      let itemId = Office.context.mailbox.item.itemId;

      if (itemId === null || itemId == undefined) {
          Office.context.mailbox.item.saveAsync(function(result) {
              itemId = result.value;
          });
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'itemId: string;'
      return:
        type: string
  - name: itemType
    uid: 'outlook!Office.AppointmentRead#itemType:member'
    package: outlook!
    fullName: itemType
    summary: >-
      Gets the type of item that an instance represents.


      The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object
      instance is a message or an appointment.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml


      const itemType = Office.context.mailbox.item.itemType;

      switch (itemType) {
          case Office.MailboxEnums.ItemType.Appointment:
              console.log(`Current item is an ${itemType}.`);
              break;
          case Office.MailboxEnums.ItemType.Message:
              console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
              break;
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'itemType: MailboxEnums.ItemType | string;'
      return:
        type: '<xref uid="outlook!Office.MailboxEnums.ItemType:enum" /> | string'
  - name: location
    uid: 'outlook!Office.AppointmentRead#location:member'
    package: outlook!
    fullName: location
    summary: |-
      Gets the location of an appointment.

      The `location` property returns a string that contains the location of the appointment.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      const location = Office.context.mailbox.item.location;

      console.log("location: " + location);

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml


      console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'location: string;'
      return:
        type: string
  - name: normalizedSubject
    uid: 'outlook!Office.AppointmentRead#normalizedSubject:member'
    package: outlook!
    fullName: normalizedSubject
    summary: >-
      Gets the subject of an item, with all prefixes removed (including RE: and FWD:).


      The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:)
      that are added by email programs. To get the subject of the item with the prefixes intact, use the `subject`
      property.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml


      console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'normalizedSubject: string;'
      return:
        type: string
  - name: notificationMessages
    uid: 'outlook!Office.AppointmentRead#notificationMessages:member'
    package: outlook!
    fullName: notificationMessages
    summary: Gets the notification messages for an item.
    remarks: >-
      \[ [API set: Mailbox 1.3](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml


      // Adds a progress indicator to the mail item.

      const id = $("#notificationId").val().toString();

      const details =
        {
          type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
          message: "Progress indicator with id = " + id
        };
      Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);


      ...


      // Adds an informational notification to the mail item.

      const id = $("#notificationId").val().toString();

      const details =
        {
          type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
          message: "Non-persistent informational notification message with id = " + id,
          icon: "icon1",
          persistent: false
        };
      Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);


      ...


      // Adds a persistent information notification to the mail item.

      const id = $("#notificationId").val().toString();

      const details =
        {
          type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
          message: "Persistent informational notification message with id = " + id,
          icon: "icon1",
          persistent: true
        };
      Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);


      ...


      // Gets all the notification messages and their keys for the current mail item.

      Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
          console.log(asyncResult.error.message);
          return;
        }

        console.log(asyncResult.value);
      });


      ...


      // Replaces a notification message of a given key with another message.

      const id = $("#notificationId").val().toString();

      Office.context.mailbox.item.notificationMessages.replaceAsync(
        id,
        {
          type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
          message: "Notification message with id = " + id + " has been replaced with an informational message.",
          icon: "icon2",
          persistent: false
        },
        handleResult);

      ...


      // Removes a notification message from the current mail item.

      const id = $("#notificationId").val().toString();

      Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'notificationMessages: NotificationMessages;'
      return:
        type: '<xref uid="outlook!Office.NotificationMessages:interface" />'
  - name: optionalAttendees
    uid: 'outlook!Office.AppointmentRead#optionalAttendees:member'
    package: outlook!
    fullName: optionalAttendees
    summary: >-
      Provides access to the optional attendees of an event. The type of object and level of access depend on the mode
      of the current item.


      The `optionalAttendees` property returns an array that contains an
      [EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each optional attendee to the
      meeting. The maximum number of attendees returned varies per Outlook client.


      - Windows: 500 attendees


      - Android, classic Mac UI, iOS: 100 attendees


      - New Mac UI, web browser: No limit
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml


      const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;

      console.log("Optional attendees:");

      for (let i = 0; i < apptOptionalAttendees.length; i++) {
        console.log(
          apptOptionalAttendees[i].displayName +
            " (" +
            apptOptionalAttendees[i].emailAddress +
            ") - response: " +
            apptOptionalAttendees[i].appointmentResponse
        );
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'optionalAttendees: EmailAddressDetails[];'
      return:
        type: '<xref uid="outlook!Office.EmailAddressDetails:interface" />[]'
  - name: organizer
    uid: 'outlook!Office.AppointmentRead#organizer:member'
    package: outlook!
    fullName: organizer
    summary: Gets the meeting organizer's email properties.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml


      const apptOrganizer = Office.context.mailbox.item.organizer;

      console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'organizer: EmailAddressDetails;'
      return:
        type: '<xref uid="outlook!Office.EmailAddressDetails:interface" />'
  - name: requiredAttendees
    uid: 'outlook!Office.AppointmentRead#requiredAttendees:member'
    package: outlook!
    fullName: requiredAttendees
    summary: >-
      Provides access to the required attendees of an event. The type of object and level of access depend on the mode
      of the current item.


      The `requiredAttendees` property returns an array that contains an
      [EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each required attendee to the
      meeting. The maximum number of attendees returned varies per Outlook client.


      - Windows: 500 attendees


      - Android, classic Mac UI, iOS: 100 attendees


      - New Mac UI, web browser: No limit
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml


      const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;

      console.log("Required attendees:");

      for (let i = 0; i < apptRequiredAttendees.length; i++) {
        console.log(
          apptRequiredAttendees[i].displayName +
            " (" +
            apptRequiredAttendees[i].emailAddress +
            ") - response: " +
            apptRequiredAttendees[i].appointmentResponse
        );
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'requiredAttendees: EmailAddressDetails[];'
      return:
        type: '<xref uid="outlook!Office.EmailAddressDetails:interface" />[]'
  - name: start
    uid: 'outlook!Office.AppointmentRead#start:member'
    package: outlook!
    fullName: start
    summary: >-
      Gets the date and time that the appointment is to begin.


      The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. You
      can use the `convertToLocalClientTime` method to convert the value to the client's local date and time.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml


      console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'start: Date;'
      return:
        type: Date
  - name: subject
    uid: 'outlook!Office.AppointmentRead#subject:member'
    package: outlook!
    fullName: subject
    summary: >-
      Gets the description that appears in the subject field of an item.


      The `subject` property gets or sets the entire subject of the item, as sent by the email server.


      The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading
      prefixes such as RE: and FW:.
    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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml


      console.log(`Subject: ${Office.context.mailbox.item.subject}`);

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'subject: string;'
      return:
        type: string
methods:
  - name: displayReplyAllForm(formData)
    uid: 'outlook!Office.AppointmentRead#displayReplyAllForm:member(1)'
    package: outlook!
    fullName: displayReplyAllForm(formData)
    summary: >-
      Displays a reply form that includes either the sender and all recipients of the selected message or the organizer
      and all attendees of the selected appointment.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in
      the 2-column or 1-column view.


      - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.


      - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all
      attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form
      UI. If this isn't possible, then no error message is thrown.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // The following code passes a string to the `displayReplyAllForm` method.

      Office.context.mailbox.item.displayReplyAllForm('hello there');

      Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');


      // Reply with an empty body.

      Office.context.mailbox.item.displayReplyAllForm({});


      // Reply with just a body.

      Office.context.mailbox.item.displayReplyAllForm(

      {

      'htmlBody' : 'hi'

      });


      // Reply with a body and a file attachment.

      Office.context.mailbox.item.displayReplyAllForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
              'type' : Office.MailboxEnums.AttachmentType.File,
              'name' : 'squirrel.png',
              'url' : 'http://i.imgur.com/sRgTlGR.jpg'
              }
          ]
      });


      // Reply with a body and an item attachment.

      Office.context.mailbox.item.displayReplyAllForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
              'type' : 'item',
              'name' : 'rand',
              'itemId' : Office.context.mailbox.item.itemId
              }
          ]
      });


      // Reply with a body, file attachment, item attachment, and a callback.

      Office.context.mailbox.item.displayReplyAllForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
                  'type' : Office.MailboxEnums.AttachmentType.File,
                  'name' : 'squirrel.png',
                  'url' : 'http://i.imgur.com/sRgTlGR.jpg'
              },
              {
                  'type' : 'item',
                  'name' : 'rand',
                  'itemId' : Office.context.mailbox.item.itemId
              }
          ],
          'callback' : function(asyncResult)
          {
              console.log(asyncResult.value);
          }
      });

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml


      Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'displayReplyAllForm(formData: string | ReplyFormData): void;'
      parameters:
        - id: formData
          description: >-
            A string that contains text and HTML and that represents the body of the reply form. The string is limited
            to 32 KB OR a [ReplyFormData](xref:outlook!Office.ReplyFormData:interface) object that contains body or
            attachment data and a callback function.
          type: 'string | <xref uid="outlook!Office.ReplyFormData:interface" />'
      return:
        type: void
        description: ''
  - name: displayReplyForm(formData)
    uid: 'outlook!Office.AppointmentRead#displayReplyForm:member(1)'
    package: outlook!
    fullName: displayReplyForm(formData)
    summary: >-
      Displays a reply form that includes only the sender of the selected message or the organizer of the selected
      appointment.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in
      the 2-column or 1-column view.


      - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.


      - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all
      attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form
      UI. If this isn't possible, then no error message is thrown.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // The following code passes a string to the `displayReplyForm` method.

      Office.context.mailbox.item.displayReplyForm('hello there');

      Office.context.mailbox.item.displayReplyForm('<b>hello there</b>');


      // Reply with an empty body.

      Office.context.mailbox.item.displayReplyForm({});


      // Reply with just a body.

      Office.context.mailbox.item.displayReplyForm(

      {
          'htmlBody' : 'hi'
      });


      // Reply with a body and a file attachment.

      Office.context.mailbox.item.displayReplyForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
                  'type' : Office.MailboxEnums.AttachmentType.File,
                  'name' : 'squirrel.png',
                  'url' : 'http://i.imgur.com/sRgTlGR.jpg'
              }
          ]
      });


      // Reply with a body and an item attachment.

      Office.context.mailbox.item.displayReplyForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
                  'type' : 'item',
                  'name' : 'rand',
                  'itemId' : Office.context.mailbox.item.itemId
              }
          ]
      });


      // Reply with a body, file attachment, item attachment, and a callback.

      Office.context.mailbox.item.displayReplyForm(

      {
          'htmlBody' : 'hi',
          'attachments' :
          [
              {
                  'type' : Office.MailboxEnums.AttachmentType.File,
                  'name' : 'squirrel.png',
                  'url' : 'http://i.imgur.com/sRgTlGR.jpg'
              },
              {
                  'type' : 'item',
                  'name' : 'rand',
                  'itemId' : Office.context.mailbox.item.itemId
              }
          ],
          'callback' : function(asyncResult)
          {
              console.log(asyncResult.value);
          }
      });

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml


      Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");


      ...


      Office.context.mailbox.item.displayReplyForm({
        htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
        attachments: [
          { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
          { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
        ],
        options: { asyncContext: null },
        callback: function(result) {
          if (result.status !== Office.AsyncResultStatus.Succeeded) {
            console.error(`Action failed with message ${result.error.message}`);
          }
        }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'displayReplyForm(formData: string | ReplyFormData): void;'
      parameters:
        - id: formData
          description: >-
            A string that contains text and HTML and that represents the body of the reply form. The string is limited
            to 32 KB OR a [ReplyFormData](xref:outlook!Office.ReplyFormData:interface) object that contains body or
            attachment data and a callback function.
          type: 'string | <xref uid="outlook!Office.ReplyFormData:interface" />'
      return:
        type: void
        description: ''
  - name: getEntities()
    uid: 'outlook!Office.AppointmentRead#getEntities:member(1)'
    package: outlook!
    fullName: getEntities()
    summary: Gets the entities found in the selected item's body.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The
      work to retire this method will start in May and continue until the end of June. After June, contextual add-ins
      will no longer be able to detect entities in mail items to perform tasks on them. Regular expression rules will
      continue to be supported after entity-based contextual add-ins are retired. 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 [Use regular expression activation rules to show an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
      -->. To learn more about the retirement of entity-based contextual Outlook add-ins, see [Retirement of
      entity-based contextual Outlook
      add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
      -->.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml


      const entities = Office.context.mailbox.item.getEntities();

      let entityTypesFound = 0;

      if (entities.addresses.length > 0) {
          console.warn("physical addresses: ");
          console.log(entities.addresses);
          entityTypesFound++;
      }

      if (entities.contacts.length > 0) {
          console.warn("contacts: ");
          entities.contacts.forEach(function (contact) { console.log(contact.personName); })
          entityTypesFound++;
      }

      if (entities.emailAddresses.length > 0) {
          console.warn("email addresses: ");
          console.log(entities.emailAddresses);
          entityTypesFound++;
      }

      if (entities.meetingSuggestions.length > 0) {
          console.warn("meetings suggestions: ");
          entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
          entityTypesFound++;
      }

      if (entities.phoneNumbers.length > 0) {
          console.warn("phone numbers: ");
          entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
          entityTypesFound++;
      }

      if (entities.taskSuggestions.length > 0) {
          console.warn("task suggestions: ");
          entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
          entityTypesFound++;
      }

      if (entities.urls.length > 0) {
          console.warn("URLs: ");
          console.log(entities.urls);
          entityTypesFound++;
      }

      if (entityTypesFound == 0)

      {
          console.log("No entities found on this item.");
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getEntities(): Entities;'
      return:
        type: '<xref uid="outlook!Office.Entities:interface" />'
        description: ''
  - name: getEntitiesByType(entityType)
    uid: 'outlook!Office.AppointmentRead#getEntitiesByType:member(1)'
    package: outlook!
    fullName: getEntitiesByType(entityType)
    summary: Gets an array of all the entities of the specified entity type found in the selected item's body.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[Minimum permission
      level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
      -->**: **restricted**


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


      **Important**:


      - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of
      2024. The work to retire this method will start in May and continue until the end of June. After June, contextual
      add-ins will no longer be able to detect entities in mail items to perform tasks on them. Regular expression rules
      will continue to be supported after entity-based contextual add-ins are retired. 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 [Use regular expression activation rules to show an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
      -->. To learn more about the retirement of entity-based contextual Outlook add-ins, see [Retirement of
      entity-based contextual Outlook
      add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
      -->.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml


      console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion |
        PhoneNumber | TaskSuggestion>;
      parameters:
        - id: entityType
          description: >-
            One of the `EntityType` enumeration values.


            While the minimum permission level to use this method is **restricted**, some entity types require
            **read item** to access, as specified in the following table.


            <table> <tr> <th>Value of entityType</th> <th>Type of objects in returned array</th> <th>Required permission
            level</th> </tr> <tr> <td>Address</td> <td>String</td> <td>Restricted</td> </tr> <tr> <td>Contact</td>
            <td>Contact</td> <td>ReadItem</td> </tr> <tr> <td>EmailAddress</td> <td>String</td> <td>ReadItem</td> </tr>
            <tr> <td>MeetingSuggestion</td> <td>MeetingSuggestion</td> <td>ReadItem</td> </tr> <tr> <td>PhoneNumber</td>
            <td>PhoneNumber</td> <td>Restricted</td> </tr> <tr> <td>TaskSuggestion</td> <td>TaskSuggestion</td>
            <td>ReadItem</td> </tr> <tr> <td>URL</td> <td>String</td> <td>Restricted</td> </tr> </table>
          type: '<xref uid="outlook!Office.MailboxEnums.EntityType:enum" /> | string'
      return:
        type: >-
          Array&lt;string | <xref uid="outlook!Office.Contact:interface" /> | <xref
          uid="outlook!Office.MeetingSuggestion:interface" /> | <xref uid="outlook!Office.PhoneNumber:interface" /> |
          <xref uid="outlook!Office.TaskSuggestion:interface" />&gt;
        description: >-
          If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns
          null. If no entities of the specified type are present in the item's body, the method returns an empty array.
          Otherwise, the type of the objects in the returned array depends on the type of entity requested in the
          `entityType` parameter.
  - name: getFilteredEntitiesByName(name)
    uid: 'outlook!Office.AppointmentRead#getFilteredEntitiesByName:member(1)'
    package: outlook!
    fullName: getFilteredEntitiesByName(name)
    summary: Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2
      of 2024. The work to retire this method will start in May and continue until the end of June. After June,
      contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them. Regular
      expression rules will continue to be supported after entity-based contextual add-ins are retired. 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 [Use regular expression activation rules to show an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
      -->. To learn more about the retirement of entity-based contextual Outlook add-ins, see [Retirement of
      entity-based contextual Outlook
      add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
      -->.


      - This method is used with the [activation rules feature for Outlook
      add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules)<!-- -->, which isn't supported
      by the [unified manifest for Microsoft
      365](https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview)<!-- -->.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml


      // This API would only work when you click on highlighted physical address that has the word "Way" in it.

      console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber |
        TaskSuggestion>;
      parameters:
        - id: name
          description: The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
          type: string
      return:
        type: >-
          Array&lt;string | <xref uid="outlook!Office.Contact:interface" /> | <xref
          uid="outlook!Office.MeetingSuggestion:interface" /> | <xref uid="outlook!Office.PhoneNumber:interface" /> |
          <xref uid="outlook!Office.TaskSuggestion:interface" />&gt;
        description: >-
          The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
          manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in
          the manifest with a `FilterName` element value that matches the `name` parameter, the method returns
          `null`<!-- -->. If the `name` parameter matches an `ItemHasKnownEntity` element in the manifest, but there are
          no entities in the current item that match, the method returns an empty array.
  - name: getRegExMatches()
    uid: 'outlook!Office.AppointmentRead#getRegExMatches:member(1)'
    package: outlook!
    fullName: getRegExMatches()
    summary: Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no
      longer be able to detect entities in mail items to perform tasks on them. Regular expression rules will continue
      to be supported after entity-based contextual add-ins are retired. 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 [Use
      regular expression activation rules to show an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
      -->. To learn more about the retirement of entity-based contextual add-ins, see [Retirement of entity-based
      contextual Outlook
      add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
      -->.


      - This method is used with the [activation rules feature for Outlook
      add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules)<!-- -->, which isn't supported
      by the [unified manifest for Microsoft
      365](https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview)<!-- -->.


      - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression
      should further filter the body and shouldn't attempt to return the entire body of the item. Using a regular
      expression such as `.*` to obtain the entire body of an item doesn't always return the expected results. Instead,
      use the `Body.getAsync` method to retrieve the entire body.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Consider an add-in manifest has the following `Rule` element:

      //<Rule xsi:type="RuleCollection" Mode="And">

      //  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />

      //  <Rule xsi:type="RuleCollection" Mode="Or">

      //    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut"
      PropertyName="BodyAsPlaintext" IgnoreCase="true" />

      //    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies"
      RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />

      //  </Rule>

      //</Rule>


      // The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.

      //{

      //'fruits': ['apple','banana','Banana','coconut'],

      //'veggies': ['tomato','onion','spinach','broccoli']

      //}


      // The following example shows how to access the array of

      // matches for the regular expression rule elements `fruits`

      // and `veggies`, which are specified in the manifest.

      const allMatches = Office.context.mailbox.item.getRegExMatches();

      const fruits = allMatches.fruits;

      const veggies = allMatches.veggies;

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml


      // This API would only work when you click on highlighted word "ScriptLab".

      console.log(Office.context.mailbox.item.getRegExMatches());

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getRegExMatches(): any;'
      return:
        type: any
        description: >-
          An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
          The name of each array is equal to the corresponding value of the RegExName attribute of the matching
          `ItemHasRegularExpressionMatch` rule or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
          For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's
          specified by that rule. The `PropertyName` simple type defines the supported properties.
  - name: getRegExMatchesByName(name)
    uid: 'outlook!Office.AppointmentRead#getRegExMatchesByName:member(1)'
    package: outlook!
    fullName: getRegExMatchesByName(name)
    summary: >-
      Returns string values in the selected item that match the named regular expression defined in an XML manifest
      file.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      **[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)<!--
      -->**: Appointment Attendee


      **Important**:


      - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no
      longer be able to detect entities in mail items to perform tasks on them. Regular expression rules will continue
      to be supported after entity-based contextual add-ins are retired. 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 [Use
      regular expression activation rules to show an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
      -->. To learn more about the retirement of entity-based contextual add-ins, see [Retirement of entity-based
      contextual Outlook
      add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
      -->.


      - This method is used with the [activation rules feature for Outlook
      add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules)<!-- -->, which isn't supported
      by the [unified manifest for Microsoft
      365](https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview)<!-- -->.


      - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression
      should further filter the body and shouldn't attempt to return the entire body of the item. Using a regular
      expression such as `.*` to obtain the entire body of an item doesn't always return the expected results. Instead,
      use the `Body.getAsync` method to retrieve the entire body.


      - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook
      mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
      devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


      #### Examples


      ```TypeScript

      // Consider an add-in manifest has the following `Rule` element:

      //<Rule xsi:type="RuleCollection" Mode="And">

      //  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />

      //  <Rule xsi:type="RuleCollection" Mode="Or">

      //    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut"
      PropertyName="BodyAsPlaintext" IgnoreCase="true" />

      //    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies"
      RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />

      //  </Rule>

      //</Rule>


      // The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.

      //{

      //'fruits': ['apple','banana','Banana','coconut'],

      //'veggies': ['tomato','onion','spinach','broccoli']

      //}


      const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");

      const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml


      // This API would only work when you click on highlighted word "ScriptLab".

      console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getRegExMatchesByName(name: string): string[];'
      parameters:
        - id: name
          description: The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
          type: string
      return:
        type: 'string[]'
        description: >-
          An array that contains the strings that match the regular expression defined in the
          `ItemHasRegularExpressionMatch` rule element in the manifest XML file, with the specified `RegExName` element
          value.
  - name: 'loadCustomPropertiesAsync(callback, userContext)'
    uid: 'outlook!Office.AppointmentRead#loadCustomPropertiesAsync:member(1)'
    package: outlook!
    fullName: 'loadCustomPropertiesAsync(callback, userContext)'
    summary: >-
      Asynchronously loads custom properties for this add-in on the selected item.


      Custom properties are stored as key-value pairs on a per-app, per-item basis. This method returns a
      [CustomProperties](xref:outlook!Office.CustomProperties:interface) object in the callback, which provides methods
      to access the custom properties specific to the current item and the current add-in. Custom properties aren't
      encrypted on the item, so this shouldn't be used as secure storage.


      The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. This object
      can be used to get, set, save, and remove custom properties from the mail item.
    remarks: >-
      \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]


      To learn more about custom properties, see [Get and set add-in metadata for an Outlook
      add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/metadata-for-an-outlook-add-in)<!-- -->.


      **[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)<!--
      -->**: Appointment Attendee


      #### Examples


      ```TypeScript

      // The following example shows how to use the loadCustomPropertiesAsync method

      // to asynchronously load custom properties that are specific to the current item.

      // The example also shows how to use the saveAsync method to save these properties

      // back to the server. After loading the custom properties, the example uses the

      // get method to read the custom property myProp, the set method to write the

      // custom property otherProp, and then finally calls the saveAsync method to save

      // the custom properties.

      Office.initialize = function () {
          // Checks for the DOM to load using the jQuery ready method.
          $(document).ready(function () {
              // After the DOM is loaded, add-in-specific code can run.
              const mailbox = Office.context.mailbox;
              mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
          });
      };


      function customPropsCallback(asyncResult) {
          const customProps = asyncResult.value;
          const myProp = customProps.get("myProp");

          customProps.set("otherProp", "value");
          customProps.saveAsync(saveCallback);
      }


      function saveCallback(asyncResult) {

      }

      ```

      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml


      Office.context.mailbox.item.loadCustomPropertiesAsync(function (result) {
        if (result.status === Office.AsyncResultStatus.Succeeded) {
          console.log("Loaded following custom properties:");
          customProps = result.value;
          const dataKey = Object.keys(customProps)[0];
          const data = customProps[dataKey];
          for (let propertyName in data)
          {
            let propertyValue = data[propertyName];
            console.log(`${propertyName}: ${propertyValue}`);
          }              
        }
        else {
          console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
        }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void,
        userContext?: any): void;
      parameters:
        - id: callback
          description: >-
            When the method completes, the function passed in the `callback` parameter is called with a single parameter
            of type `Office.AsyncResult`<!-- -->.
          type: >-
            (asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;<xref
            uid="outlook!Office.CustomProperties:interface" />&gt;) =&gt; void
        - id: userContext
          description: >-
            Optional. Developers can provide any object they wish to access in the callback function. This object can be
            accessed by the `asyncResult.asyncContext` property in the callback function.
          type: any
      return:
        type: void
        description: ''
extends: '<xref uid="outlook!Office.Appointment:interface" />'