@types/office-js-preview 1.0.402 → 1.0.403

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: Tue, 18 Jul 2023 19:32:54 GMT
+ * Last updated: Thu, 20 Jul 2023 21:02:47 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -231,7 +231,6 @@ declare namespace Office {
          */
         resolve(): Promise<void>;
     }
-
     /**
      * Gets the Context object that represents the runtime environment of the add-in and provides access to the top-level objects of the API.
      *
@@ -1063,7 +1062,6 @@ declare namespace Office {
              * This property is supported in Outlook only in {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later.
              */
             source:Source;
-
             /**
              * Indicates that the add-in has completed processing and will automatically be closed.
              *
@@ -1072,10 +1070,13 @@ declare namespace Office {
              * - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
              *
              * - An event defined in the {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
-             * For example, an `OnMessageSend` event. 
+             * For example, an `OnMessageSend` event.
              * 
              * - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
              * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
+             * 
+             * - An event defined in the
+             * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint?view=outlook-js-preview&preserve-view=true#reportphishingcommandsurface-preview | ReportPhishingCommandSurface extension point (preview)}.
              *
              * @remarks
              *
@@ -1091,18 +1092,19 @@ declare namespace Office {
              */
             completed(options?: EventCompletedOptions): void;
         }
-
         /**
          * Specifies the behavior for when the event is completed.
          */
         interface EventCompletedOptions {
             /**
-             * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
+             * 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 completion of an event handler, this property indicates if the handled event should continue execution or be canceled.
              * For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
              * sending of an item. For a complete sample, see the
              * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
              * 
+             * **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
+             *
              * @remarks
              *
              * [Api set: Mailbox 1.8]
@@ -1111,14 +1113,15 @@ declare namespace Office {
              *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
              */
-            allowEvent: boolean;
-
+            allowEvent?: boolean;
             /**
-             * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
-             * that will be displayed to the user. For an example, see the  
+             * 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 completion of an event handler and set its `allowEvent` property to `false`, this property sets the error message
+             * that will be displayed to the user. For an example, see the
              * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
              *
+             * **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
+             *
              * @remarks
              * 
              * [Api set: Mailbox 1.12]
@@ -1128,8 +1131,98 @@ declare namespace Office {
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
              */
             errorMessage?: 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 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}.
+             *
+             * @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**:
+             *
+             * - If the specified folder doesn't exist yet, it will be created before the message is moved.
+             *
+             * - If the `postProcessingAction` property is set to `moveToCustomFolder`, the `folderName` property must be specified.
+             * Otherwise, the reported message is moved to the Junk Email folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
+             * the `folderName` property is ignored.
+             *
+             * @beta
+             */
+            folderName?: string;
+            /**
+             * 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}.
+             *
+             * @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
+             *
+             * @beta
+             */
+            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:
+             *
+             * - `delete` - Deletes the reported message.
+             *
+             * - `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.
+             *
+             * - `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}.
+             *
+             * @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**: 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
+             */
+            postProcessingAction?: 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 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}.
+             *
+             * @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
+             *
+             * @beta
+             */
+            showPostProcessingDialog?: object;
         }
-
         /**
          * Encapsulates source data for add-in events.
          */
@@ -1427,7 +1520,6 @@ declare namespace Office {
          */
         openBrowserWindow(url: string): void;
     }
-
     /**
      * Provides information about which Requirement Sets are supported in the current environment.
      */
@@ -1450,7 +1542,6 @@ declare namespace Office {
         */
        isSetSupported(name: string, minVersionNumber?: number): boolean;
     }
-
     /**
      * Provides options for how a dialog is displayed.
      */
@@ -1482,7 +1573,6 @@ declare namespace Office {
          */
         asyncContext?: any
     }
-
     /**
      * The Office Auth namespace, `Office.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
      * Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
@@ -2074,7 +2164,6 @@ declare namespace Office {
          */
         sendMessage(name: string): void;
     }
-
     /**
      * Returns a promise of an object described in the expression. Callback is invoked only if the function fails.
      *
@@ -2446,6 +2535,15 @@ declare namespace Office {
          * **Applications**: Excel, PowerPoint, Word
          */
         SettingsChanged,
+        /**
+         * Occurs in Outlook when an unsolicited message is reported. The event handler receives an argument of type
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventargs?view=outlook-js-preview&preserve-view=true | Office.SpamReportingEventArgs}.
+         *
+         * [Api set: Mailbox preview]
+         *
+         * @beta
+         */
+        SpamReporting,
         /**
          * Triggers when a Task selection happens in Project.
          */
@@ -3020,7 +3118,6 @@ declare namespace Office {
          */
         setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;
     }
-
     /**
      * Provides information about the binding that raised the DataChanged event.
      */
@@ -3035,7 +3132,6 @@ declare namespace Office {
          */
         type: EventType;
     }
-
     /**
      * Provides information about the binding that raised the SelectionChanged event.
      */
@@ -3089,7 +3185,6 @@ declare namespace Office {
          */
         type: EventType;
     }
-
     /**
      * Represents the bindings the add-in has within the document.
      */
@@ -3705,7 +3800,6 @@ declare namespace Office {
          */
         removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
     }
-
     /**
      * Provides information about the deleted node that raised the nodeDeleted event.
      */
@@ -3726,7 +3820,6 @@ declare namespace Office {
          */
         oldNode: CustomXmlNode;
     }
-
     /**
      * Provides information about the inserted node that raised the nodeInserted event.
      */
@@ -3742,7 +3835,6 @@ declare namespace Office {
          */
         newNode: CustomXmlNode;
     }
-
     /**
      * Provides information about the replaced node that raised the nodeReplaced event.
      */
@@ -3765,7 +3857,6 @@ declare namespace Office {
          */
         oldNode: CustomXmlNode;
     }
-
     /**
      * Represents a collection of CustomXmlPart objects.
      *
@@ -17244,6 +17335,42 @@ declare namespace Office {
          *                If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
          */
         getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the current message in EML format encoded in Base64.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
+         *
+         * @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, `asyncResult`, which is an
+         *          `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
+         *          returned in the `asyncResult.error` property.
+         *
+         * @beta
+         */
+        getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the current message in EML format encoded in Base64.
+         * 
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
+         *
+         * @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 Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
+         *          returned in the `asyncResult.error` property.
+         *
+         * @beta
+         */
+        getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
          *
@@ -19612,6 +19739,25 @@ declare namespace Office {
          */
         delegatePermissions: MailboxEnums.DelegatePermissions;
     }
+    /**
+     * Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
+     *
+     * @remarks
+     * [Api set: Mailbox preview]
+     *
+     * @beta
+     */
+    export interface SpamReportingEventArgs {
+        /**
+         * The type of event that was raised. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * @beta
+         */
+        type: "SpamReporting";
+    }
     /**
      * Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
      *

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.402",
+    "version": "1.0.403",
     "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": "a3545d6007c97f7cee291d7c5d89d3ef78859764061d65765aa8e3283d407122",
+    "typesPublisherContentHash": "9ea48e89ef1e30419184fdfd11eaf309bb032b35463f9149de643190ae155d6a",
     "typeScriptVersion": "4.3"
 }