@types/office-js-preview 1.0.675 → 1.0.677
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +49 -16
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated: Mon,
|
|
11
|
+
* Last updated: Mon, 12 Jan 2026 18:02:16 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -17430,7 +17430,8 @@ declare namespace Office {
|
|
|
17430
17430
|
* **Important**:
|
|
17431
17431
|
*
|
|
17432
17432
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
17433
|
-
* In this case, the `from` property returns the
|
|
17433
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
17434
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
17434
17435
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
17435
17436
|
*
|
|
17436
17437
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
@@ -17446,8 +17447,13 @@ declare namespace Office {
|
|
|
17446
17447
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17447
17448
|
*
|
|
17448
17449
|
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
17449
|
-
* consider using
|
|
17450
|
-
*
|
|
17450
|
+
* consider using one of the following options depending on your Exchange environment.
|
|
17451
|
+
*
|
|
17452
|
+
* - For Exchange Online, use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/microsoft-graph | Microsoft Graph} to get the
|
|
17453
|
+
* {@link https://learn.microsoft.com/graph/api/resources/message | internetMessageId} property.
|
|
17454
|
+
*
|
|
17455
|
+
* - For Exchange Server (on-premises), use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get the
|
|
17456
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | InternetMessageId} property from the server.
|
|
17451
17457
|
*/
|
|
17452
17458
|
internetMessageId: string;
|
|
17453
17459
|
/**
|
|
@@ -17636,7 +17642,8 @@ declare namespace Office {
|
|
|
17636
17642
|
* **Important**:
|
|
17637
17643
|
*
|
|
17638
17644
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
17639
|
-
* In this case, the `from` property returns the
|
|
17645
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
17646
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
17640
17647
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
17641
17648
|
*
|
|
17642
17649
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
@@ -21388,6 +21395,10 @@ declare namespace Office {
|
|
|
21388
21395
|
*
|
|
21389
21396
|
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
21390
21397
|
*
|
|
21398
|
+
* - The `sendAsync` method is available for preview in Outlook on Mac starting in Version 16.105 (Build 25121117).
|
|
21399
|
+
* To test this feature, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program}
|
|
21400
|
+
* and select the **Beta Channel** option to access Office beta builds.
|
|
21401
|
+
*
|
|
21391
21402
|
* @param options - An object literal that contains the `asyncContext` property. Use the `asyncContext` property to specify any object you want to access in the
|
|
21392
21403
|
* callback function.
|
|
21393
21404
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
@@ -21423,6 +21434,10 @@ declare namespace Office {
|
|
|
21423
21434
|
*
|
|
21424
21435
|
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
21425
21436
|
*
|
|
21437
|
+
* - The `sendAsync` method is available for preview in Outlook on Mac starting in Version 16.105 (Build 25121117).
|
|
21438
|
+
* To test this feature, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program}
|
|
21439
|
+
* and select the **Beta Channel** option to access Office beta builds.
|
|
21440
|
+
*
|
|
21426
21441
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
21427
21442
|
* parameter is an `Office.AsyncResult` object.
|
|
21428
21443
|
*/
|
|
@@ -21739,7 +21754,8 @@ declare namespace Office {
|
|
|
21739
21754
|
* **Important**:
|
|
21740
21755
|
*
|
|
21741
21756
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
21742
|
-
* In this case, the `from` property returns the
|
|
21757
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
21758
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
21743
21759
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
21744
21760
|
*
|
|
21745
21761
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
@@ -21748,15 +21764,20 @@ declare namespace Office {
|
|
|
21748
21764
|
/**
|
|
21749
21765
|
* Gets the internet message identifier for an email message.
|
|
21750
21766
|
*
|
|
21751
|
-
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
21752
|
-
* consider using {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get this
|
|
21753
|
-
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | property from the server}.
|
|
21754
|
-
*
|
|
21755
21767
|
* @remarks
|
|
21756
21768
|
*
|
|
21757
21769
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
21758
21770
|
*
|
|
21759
21771
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21772
|
+
*
|
|
21773
|
+
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
21774
|
+
* consider using one of the following options depending on your Exchange environment.
|
|
21775
|
+
*
|
|
21776
|
+
* - For Exchange Online, use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/microsoft-graph | Microsoft Graph} to get the
|
|
21777
|
+
* {@link https://learn.microsoft.com/graph/api/resources/message | internetMessageId} property.
|
|
21778
|
+
*
|
|
21779
|
+
* - For Exchange Server (on-premises), use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get the
|
|
21780
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | InternetMessageId} property from the server.
|
|
21760
21781
|
*/
|
|
21761
21782
|
internetMessageId: string;
|
|
21762
21783
|
/**
|
|
@@ -21934,7 +21955,8 @@ declare namespace Office {
|
|
|
21934
21955
|
* **Important**:
|
|
21935
21956
|
*
|
|
21936
21957
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
21937
|
-
* In this case, the `from` property returns the
|
|
21958
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
21959
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
21938
21960
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
21939
21961
|
*
|
|
21940
21962
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
@@ -24947,16 +24969,15 @@ declare namespace Office {
|
|
|
24947
24969
|
*
|
|
24948
24970
|
* The customizable button in the Smart Alerts dialog varies depending on the Outlook client and its version.
|
|
24949
24971
|
*
|
|
24950
|
-
* - In Outlook on the web, new Outlook on Windows, and classic Outlook on Windows starting in Version 2412 (Build 18324.20000), the `cancelLabel` property customizes the text of the **Take Action** button.
|
|
24972
|
+
* - In Outlook on the web, on Mac (in preview starting in Version 16.105 (Build 25121117)), new Outlook on Windows, and classic Outlook on Windows starting in Version 2412 (Build 18324.20000), the `cancelLabel` property customizes the text of the **Take Action** button.
|
|
24951
24973
|
* The **Take Action** button only appears on the Smart Alerts dialog if the `commandId` option is configured in the `event.completed` call. The option must be configured
|
|
24952
24974
|
* if you want to customize the text of the dialog button. In this implementation, the **Don't Send** button cancels the item being sent. Its text and functionality can't be customized.
|
|
24953
24975
|
* If you previously customized the text of the **Don't Send** button without assigning it a task pane or function command, your custom text won't take effect in the latest Outlook client versions.
|
|
24954
24976
|
* If you previously assigned a task pane or function command to the **Don't Send** button, no additional action is needed to implement the **Take Action** button in the latest versions.
|
|
24955
24977
|
* The default or customized **Take Action** button will automatically appear the next time a user receives a Smart Alerts dialog. Although no implementation changes are needed, we recommend notifying users of this updated experience.
|
|
24956
24978
|
*
|
|
24957
|
-
* - In
|
|
24958
|
-
*
|
|
24959
|
-
* and Outlook on Mac, the `cancelLabel` property customizes the text of the **Don't Send** button. The **Don't Send** button cancels the item being sent.
|
|
24979
|
+
* - In classic Outlook on Windows (prior to Version 2412 (Build 18324.20000) and Outlook on Mac (prior to Version 16.105 (Build 25121117)),
|
|
24980
|
+
* the `cancelLabel` property customizes the text of the **Don't Send** button. The **Don't Send** button cancels the item being sent.
|
|
24960
24981
|
*/
|
|
24961
24982
|
cancelLabel?: string;
|
|
24962
24983
|
/**
|
|
@@ -24984,13 +25005,13 @@ declare namespace Office {
|
|
|
24984
25005
|
* - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function command in the "controls" array.
|
|
24985
25006
|
*
|
|
24986
25007
|
* The button in the Smart Alerts dialog that opens a task pane or runs a function varies depending on the Outlook client and version.
|
|
24987
|
-
* In Outlook on the web, new Outlook on Windows, and classic Outlook on Windows starting in Version 2412 (Build 18324.20000), the **Take Action** button opens a
|
|
25008
|
+
* In Outlook on the web, on Mac (in preview starting in Version 16.105 (Build 25121117)), new Outlook on Windows, and classic Outlook on Windows starting in Version 2412 (Build 18324.20000), the **Take Action** button opens a
|
|
24988
25009
|
* task pane or runs a function. In this implementation, the **Don't Send** button cancels the item being sent. Its text and functionality can't be customized.
|
|
24989
25010
|
* In earlier supported versions of classic Outlook on Windows (versions prior to Version 2412 (Build 18324.20000) that support
|
|
24990
25011
|
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets#version-support-for-requirement-sets-in-classic-outlook-on-windows | Mailbox requirement set 1.14}),
|
|
24991
25012
|
* and Outlook on Mac, the **Don't Send** button opens a task pane or runs a function.
|
|
24992
25013
|
*
|
|
24993
|
-
* If you customized the text and functionality of the **Don't Send** button in your Smart Alerts add-in prior to Version 2412 (Build 18324.20000) of classic Outlook on Windows,
|
|
25014
|
+
* If you've already customized the text and functionality of the **Don't Send** button in your Smart Alerts add-in prior to Version 2412 (Build 18324.20000) of classic Outlook on Windows or prior to Version 16.105 (Build 25121117) of Outlook on Mac,
|
|
24994
25015
|
* no additional action is needed to implement the **Take Action** button in the latest supported versions. The default or customized **Take Action** button will automatically appear the next time a user receives a Smart Alerts dialog.
|
|
24995
25016
|
* Although no implementation changes are needed, we recommend notifying users of this updated experience.
|
|
24996
25017
|
*
|
|
@@ -25001,6 +25022,10 @@ declare namespace Office {
|
|
|
25001
25022
|
*
|
|
25002
25023
|
* When you configure a button in the Smart Alerts dialog to run a function, a button for the function is also added to the ribbon or action bar of the Outlook client.
|
|
25003
25024
|
* Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
|
|
25025
|
+
*
|
|
25026
|
+
* Programming a button in the Smart Alerts dialog to run a function is available for preview in Outlook on Mac starting in Version 16.105 (Build 25121117).
|
|
25027
|
+
* To test this feature, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program}
|
|
25028
|
+
* and select the **Beta Channel** option to access Office beta builds.
|
|
25004
25029
|
*/
|
|
25005
25030
|
commandId?: string;
|
|
25006
25031
|
/**
|
|
@@ -25189,6 +25214,10 @@ declare namespace Office {
|
|
|
25189
25214
|
* `Office.MailboxEnums.MoveSpamItemTo.NoMove`.
|
|
25190
25215
|
*
|
|
25191
25216
|
* - 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.
|
|
25217
|
+
*
|
|
25218
|
+
* - The `commandId` option is available for preview in Outlook on Mac starting in Version 16.103 (Build 25101816). To test this option, join the
|
|
25219
|
+
* {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program}
|
|
25220
|
+
* and select the **Beta Channel** option to access Office beta builds.
|
|
25192
25221
|
*/
|
|
25193
25222
|
commandId?: string;
|
|
25194
25223
|
/**
|
|
@@ -25226,6 +25255,10 @@ declare namespace Office {
|
|
|
25226
25255
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
25227
25256
|
* 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
|
|
25228
25257
|
* `JSON.parse()` once you retrieve it.
|
|
25258
|
+
*
|
|
25259
|
+
* - The `contextData` option is available for preview in Outlook on Mac starting in Version 16.103 (Build 25101816). To test this option, join the
|
|
25260
|
+
* {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program}
|
|
25261
|
+
* and select the **Beta Channel** option to access Office beta builds.
|
|
25229
25262
|
*/
|
|
25230
25263
|
contextData?: any;
|
|
25231
25264
|
/**
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.677",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "9b5968942085820e7f7b7b7484123a9a243559bdc9e1764511227ce1decfab5a",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|