[office-js][office-js-preview] (Outlook) Publish Mailbox 1.15 (DefinitelyTyped#71474)

Author: samantharamon

types/office-js-preview/index.d.ts

@@ -15136,7 +15136,7 @@ declare namespace Office {
      * A `LoadedMessageCompose` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in compose mode.
      *
      * @remarks
-     * [Api set: Mailbox preview]
+     * [Api set: Mailbox 1.15]
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
      *
@@ -15150,8 +15150,6 @@ declare namespace Office {
      *
      * - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
      * This must be done before calling `loadItemByIdAsync` on another item.
-     *
-     * @beta
      */
     interface LoadedMessageCompose {
         /**
@@ -15309,9 +15307,7 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
-         * **Important**:
-         *
-         * - Only the `getAllAsync` method of the NotificationMessages object is supported.
+         * **Important**: Only the `getAllAsync` method of the NotificationMessages object is supported.
          */
         notificationMessages: NotificationMessages;
         /**
@@ -16021,7 +16017,7 @@ declare namespace Office {
          * When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16038,15 +16034,13 @@ declare namespace Office {
          * @param options - An object literal that contains the `asyncContext` property. Assign any object you wish to access in the callback function to the `asyncContext` property.
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
          *                   which is an `Office.AsyncResult` object.
-         *
-         * @beta
          */
         unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16062,8 +16056,6 @@ declare namespace Office {
          *
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
          *                   which is an `Office.AsyncResult` object.
-         *
-         * @beta
          */
         unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
@@ -16072,7 +16064,7 @@ declare namespace Office {
      * A `LoadedMessageRead` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in read mode.
      *
      * @remarks
-     * [Api set: Mailbox preview]
+     * [Api set: Mailbox 1.15]
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
      *
@@ -16086,8 +16078,6 @@ declare namespace Office {
      *
      * - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
      * This must be done before calling `loadItemByIdAsync` on another item.
-     *
-     * @beta
      */
     interface LoadedMessageRead {
         /**
@@ -16932,7 +16922,7 @@ declare namespace Office {
          * When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16949,15 +16939,13 @@ declare namespace Office {
          * @param options - An object literal that contains the `asyncContext` property. Assign any object you wish to access in the callback function to the `asyncContext` property.
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
          *                   which is an `Office.AsyncResult` object.
-         *
-         * @beta
          */
         unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16973,8 +16961,6 @@ declare namespace Office {
          *
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
          *                   which is an `Office.AsyncResult` object.
-         *
-         * @beta
          */
         unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
@@ -18190,12 +18176,12 @@ declare namespace Office {
          * Then, gets an object that provides the properties and methods of the loaded item.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
-         * 
+         *
          * **Important**:
          *
          * - This method only applies to messages.
@@ -18211,27 +18197,25 @@ declare namespace Office {
          *
          * - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
          *
-         * @param itemId - The EWS ID of a selected item.
+         * @param itemId - The EWS ID of a mail item.
          * @param options - An object literal that contains the `asyncContext` property.
          *        In this property, provide any object you wish to access in the callback function.
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
          *        `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
-         *        in the `asyncResult.value` property. This object provides the properties of the selected item that's currently loaded.
-         *
-         * @beta
+         *        in the `asyncResult.value` property. This object provides the properties of the item that's currently loaded.
          */
         loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
         /**
          * Loads a single mail item by its Exchange Web Services (EWS) ID.
          * Then, gets an object that provides the properties and methods of the loaded item.
          *
          * @remarks
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
-         * 
+         *
          * **Important**:
          *
          * - This method only applies to messages.
@@ -18247,12 +18231,10 @@ declare namespace Office {
          *
          * - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
          *
-         * @param itemId - The EWS ID of a selected item.
+         * @param itemId - The EWS ID of a mail item.
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
          *        `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
-         *        in the `asyncResult.value` property. This object provides the properties of the selected item that's currently loaded.
-         *
-         * @beta
+         *        in the `asyncResult.value` property. This object provides the properties of the item that's currently loaded.
          */
         loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
         /**
@@ -23661,7 +23643,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
          *
@@ -23676,8 +23658,6 @@ declare namespace Office {
          *
          * - If you format the dialog message using the `errorMessageMarkdown` property, we recommend you also add a plaintext version of the message using the `errorMessage` property.
          * This ensures that the message is displayed properly in Outlook clients that don't support Markdown.
-         *
-         * @beta
          */
         errorMessageMarkdown?: string;
         /**
@@ -23765,19 +23745,16 @@ declare namespace Office {
          *
          * @remarks
          *
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
          * **Important**:
          *
-         * - The `commandId` option is currently in preview in Outlook on the web and on Windows (new and classic). To preview this feature in classic Outlook on Windows,
-         * install Version 2411 (Build 18227.20034) or later. Then, join the
-         * {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
-         * and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview | Open a task pane after reporting a message (preview)}.
+         * - To learn how to implement the `commandId` property in your spam-reporting add-in, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message | Open a task pane after reporting a message}.
          *
          * - The `commandId` value must match the task pane ID specified in the manifest of your add-in. In an add-in only manifest,
          * the ID is specified in the `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element that represents the task pane.
@@ -23786,9 +23763,10 @@ declare namespace Office {
          * - If you configure the `commandId` option in the `event.completed` call, a post-processing dialog isn't shown to the user
          * even if the `showPostProcessingDialog` option is specified in the call.
          *
-         * - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
+         * - To ensure that the task pane of your spam-reporting add-in opens after a message is reported, you must set the `moveItemTo` option of the `event.completed` call to
+         * `Office.MailboxEnums.MoveSpamItemTo.NoMove`.
          *
-         * @beta
+         * - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
          */
         commandId?: string;
         /**
@@ -23797,33 +23775,31 @@ declare namespace Office {
          *
          * @remarks
          *
-         * [Api set: Mailbox preview]
+         * [Api set: Mailbox 1.15]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
          * **Important**:
          *
-         * - The `contextData` option is currently in preview in Outlook on the web and on Windows (new and classic). To preview this feature in classic Outlook on Windows,
-         * install Version 2411 (Build 18227.20034) or later. Then, join the
-         * {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
-         * and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview | Open a task pane after reporting a message (preview)}.
+         * - To learn how to implement the `contextData` property in your spam-reporting add-in, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message | Open a task pane after reporting a message}.
          *
          * - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.
          *
          * - If you configure the `commandId` and `contextData` options in the `event.completed` call, a post-processing dialog isn't shown to the user
          * even if the `showPostProcessingDialog` option is specified in the call.
          *
+         * - To ensure that the task pane of your spam-reporting add-in opens and receives context data after a message is reported, you must set the `moveItemTo` option of the `event.completed` call to
+         * `Office.MailboxEnums.MoveSpamItemTo.NoMove`.
+         *
          * - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
          *
          * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
          * of your task pane. If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using
          * `JSON.parse()` once you retrieve it.
-         *
-         * @beta
          */
         contextData?: any;
         /**