@types/office-js-preview 1.0.406 → 1.0.408

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Thu, 17 Aug 2023 17:32:52 GMT
+ * Last updated: Thu, 24 Aug 2023 19:33:02 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -1135,7 +1135,7 @@ declare namespace Office {
              * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
              * to signal that a reported message has finished processing, this property specifies the Outlook mailbox folder to which the message will be moved.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1156,13 +1156,40 @@ declare namespace Office {
              * @beta
              */
             folderName?: string;
+            /**
+             * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
+             * to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
+             *
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
+             *
+             * @remarks
+             *
+             * [Api set: Mailbox preview]
+             *
+             * **{@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**:
+             *
+             * In Outlook on Windows, you can only use this property in a spam-reporting add-in starting in Version 2308 (Build 16724.10000).
+             * If you're using an earlier build that supports the integrated spam-reporting feature, use the `postProcessingAction`
+             * property instead.
+             *
+             * If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
+             * the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
+             * `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
+             *
+             * @beta
+             */
+            moveItemTo?: Office.MailboxEnums.MoveSpamItemTo;
             /**
              * When set to `true`, deletes a reported message if an error occurs while the message is processed.
              * If this property is set to `false` or isn't specified in the
              * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method},
              * the reported message remains in its current mailbox folder.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1177,17 +1204,18 @@ declare namespace Office {
             onErrorDeleteItem?: boolean;
             /**
              * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * to signal that a reported message has finished processing, this property specifies the next action to be performed on the message. The following post-processing actions are available:
+             * to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
+             * The following post-processing actions are available.
              *
-             * - `delete` - Deletes the reported message.
+             * - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
              *
              * - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
              *
-             * - `moveToSpamFolder` - Moves the reported message to the Junk Email folder of the mailbox.
+             * - `moveToSpamFolder` - Moves the reported message to the **Junk Email** folder of the mailbox.
              *
              * - `noMove` - Leaves the reported message in its current folder.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1197,9 +1225,14 @@ declare namespace Office {
              *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
              *
-             * **Important**: If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which the message will be moved in the `folderName`
-             * property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to `moveToSpamFolder` and move the reported message to the
-             * Junk Email folder.
+             * **Important**:
+             *
+             * In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
+             * If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
+             *
+             * If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
+             * the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
+             * `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
              *
              * @beta
              */
@@ -1209,7 +1242,7 @@ declare namespace Office {
              * to signal that a reported message has finished processing, this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property
              * must contain a title and a description. If this property isn't specified, a dialog isn't shown to the user once their reported message is processed. 
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -9038,6 +9071,44 @@ declare namespace Office {
              */
             Dec = "dec"
         }
+        /**
+         * Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in.
+         *
+         * To learn more about the integrated spam-reporting feature, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in (preview)}.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
+         *
+         * **Important**: This enum can only be used to assign values to the
+         * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.eventcompletedoptions?view=outlook-js-preview&preserve-view=true#office-office-addincommands-eventcompletedoptions-moveitemto-member |
+         * moveItemTo} property of the `event.completed` method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
+         * you must assign it different string values. For a list of supported string values, see
+         * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.eventcompletedoptions?view=outlook-js-preview&preserve-view=true#office-office-addincommands-eventcompletedoptions-postprocessingaction-member |
+         * Office.AddinCommands.EventCompletedOptions.postProcessingAction}.
+         *
+         * @beta
+         */
+        enum MoveSpamItemTo {
+            /**
+             * Specifies that a reported message is moved to a custom folder in the mailbox.
+             */
+            CustomFolder = "customFolder",
+            /**
+             * Specifies that a reported message is moved to the **Deleted Items** folder of the mailbox.
+             */
+            DeletedItemsFolder = "deletedItemsFolder",
+            /**
+             * Specifies that a reported message is moved to the **Junk Email** folder of the mailbox.
+             */
+            JunkFolder = "junkFolder",
+            /**
+             * Specifies that a reported message remains in its current folder in the mailbox.
+             */
+            NoMove = "noMove"
+        }
         /**
          * Represents the current view of Outlook on the web.
          */
@@ -10843,76 +10914,77 @@ declare namespace Office {
         /**
          * Asynchronously saves an item.
          *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
+         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item is saved as a normal
+         * appointment on the user's calendar. For new appointments that haven't been saved before, no invitation is sent.
+         * For existing appointments, an update is sent to added or removed attendees.
          *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
+         * @remarks
+         * [Api set: Mailbox 1.3]
          *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * **{@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}**: Appointment Organizer
+         *
+         * **Important**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
          * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
          *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
          *
-         * **Note**: In Outlook on Mac, only build 16.35.308 or later supports saving a meeting.
+         * - In Outlook on Mac, only Build 16.35.308 or later supports saving a meeting.
          * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode.
          * For a workaround, see {@link https://learn.microsoft.com/outlook/troubleshoot/calendars/cannot-save-meeting-as-draft-in-outlook-for-mac | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}.
          *
-         * @remarks
-         * [Api set: Mailbox 1.3]
-         *
-         * **{@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}**: Appointment Organizer
-         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they 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 of
-         *                   type `Office.AsyncResult`.
+         * @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. The appointment ID is returned in the `asyncResult.value` property.
          */
         saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Asynchronously saves an item.
          *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item is saved as a normal
+         * appointment on the user's calendar. For new appointments that haven't been saved before, no invitation is sent.
+         * For existing appointments, an update is sent to added or removed attendees.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.3]
          *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         *
+         * **Important**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
          * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
          *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
          * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
          *
-         * **Note**: In Outlook on Mac, only build 16.35.308 or later supports saving a meeting.
+         * - In Outlook on Mac, only Build 16.35.308 or later supports saving a meeting.
          * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode.
          * For a workaround, see {@link https://learn.microsoft.com/outlook/troubleshoot/calendars/cannot-save-meeting-as-draft-in-outlook-for-mac | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}.
          *
-         * @remarks
-         * [Api set: Mailbox 1.3]
-         *
-         * **{@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}**: Appointment Organizer
-         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
-         * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
-         *                   type `Office.AsyncResult`.
+         * @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. The appointment ID is returned in the `asyncResult.value` property.
          */
         saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
@@ -16581,22 +16653,7 @@ declare namespace Office {
          */
         removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
-         * Asynchronously saves an item.
-         *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
-         *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
-         *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
-         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
-         *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
-         * Until the item is synced, using the itemId will return an error.
+         * Asynchronously saves the current message as a draft.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -16605,33 +16662,35 @@ 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**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * Until the item is synced, using the item ID will return an error.
+         *
+         * - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
+         * from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
+         * in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
+         * shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
+         * there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
+         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they 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 of
-         *                 type `Office.AsyncResult`.
+         * @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. The message ID is returned in the `asyncResult.value` property.
          */
         saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Asynchronously saves an item.
-         *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
-         *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
-         *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
-         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
-         *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
-         * Until the item is synced, using the `itemId` will return an error.
+         * Asynchronously saves the current message as a draft.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -16640,12 +16699,29 @@ 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**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * Until the item is synced, using the item ID will return an error.
+         *
+         * - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
+         * from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
+         * in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
+         * shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
+         * there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
+         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
-         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
-         *                 type `Office.AsyncResult`.
+         * @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. The message ID is returned in the `asyncResult.value` property.
          */
         saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.406",
+    "version": "1.0.408",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "f33ec520d0a910a872508b76e142c614d2e5c8c3fd7a2dc4ec24485cb153057e",
+    "typesPublisherContentHash": "f138bc7b98f3e21b6d6ab063d872521600d7837574544caf59e86db9dbb81959",
     "typeScriptVersion": "4.3"
 }