@types/office-js-preview 1.0.568 → 1.0.570
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 +321 -82
- 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:
|
|
11
|
+
* Last updated: Wed, 12 Mar 2025 21:02:14 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -652,6 +652,22 @@ declare namespace Office {
|
|
|
652
652
|
* [Api set: Mailbox 1.10]
|
|
653
653
|
*/
|
|
654
654
|
InfobarClicked,
|
|
655
|
+
/**
|
|
656
|
+
* Occurs in Outlook when an add-in's task pane is opened from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
|
|
657
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
|
|
658
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
|
|
659
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog.
|
|
660
|
+
* This event prevents an add-in from relaunching if its task pane is already open in Outlook.
|
|
661
|
+
*
|
|
662
|
+
* **Important**: The `InitializationContextChanged` event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
663
|
+
*
|
|
664
|
+
* To add an event handler for the `InitializationContextChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
665
|
+
* The event handler receives an argument of type
|
|
666
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15 | Office.InitializationContextChangedEventArgs}.
|
|
667
|
+
*
|
|
668
|
+
* [Api set: Mailbox 1.15]
|
|
669
|
+
*/
|
|
670
|
+
InitializationContextChanged,
|
|
655
671
|
/**
|
|
656
672
|
* Occurs when a different Outlook item is selected for viewing while the task pane is pinned.
|
|
657
673
|
*
|
|
@@ -8874,26 +8890,42 @@ declare namespace Office {
|
|
|
8874
8890
|
*
|
|
8875
8891
|
* @remarks
|
|
8876
8892
|
*
|
|
8893
|
+
* [Api set: Mailbox 1.1]
|
|
8894
|
+
*
|
|
8877
8895
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8878
8896
|
*/
|
|
8879
8897
|
enum AttachmentType {
|
|
8880
8898
|
/**
|
|
8881
|
-
* The attachment is a file.
|
|
8882
|
-
|
|
8883
|
-
|
|
8884
|
-
|
|
8885
|
-
*
|
|
8899
|
+
* The attachment is a Base64-encoded file.
|
|
8900
|
+
*
|
|
8901
|
+
* **Important**: The `base64` attachment type is only supported by the `displayReplyAllForm`, `displayReplyAllFormAsync`, `displayReplyForm`, and
|
|
8902
|
+
* `displayReplyFormAsync` methods.
|
|
8903
|
+
*
|
|
8904
|
+
* [Api set: Mailbox 1.15]
|
|
8886
8905
|
*/
|
|
8887
|
-
|
|
8906
|
+
Base64 = "base64",
|
|
8888
8907
|
/**
|
|
8889
8908
|
* The attachment is stored in a cloud location, such as OneDrive.
|
|
8890
8909
|
*
|
|
8891
|
-
* **Important**: In Read mode, the `id` property of the attachment's
|
|
8910
|
+
* **Important**: In Read mode, the `id` property of the attachment's
|
|
8911
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.attachmentdetails | AttachmentDetails} object
|
|
8892
8912
|
* contains a URL to the file.
|
|
8893
|
-
* From requirement set 1.8, the `url` property included in the attachment's
|
|
8913
|
+
* From requirement set 1.8, the `url` property included in the attachment's
|
|
8914
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.attachmentdetailscompose | AttachmentDetailsCompose} object
|
|
8894
8915
|
* contains a URL to the file in Compose mode.
|
|
8916
|
+
*
|
|
8917
|
+
* The `cloud` attachment type isn't supported by the `displayNewMessageForm`, `displayNewMessageFormAsync`, `displayReplyAllForm`, `displayReplyAllFormAsync`,
|
|
8918
|
+
* `displayReplyForm`, and `displayReplyFormAsync` methods.
|
|
8919
|
+
*/
|
|
8920
|
+
Cloud = "cloud",
|
|
8921
|
+
/**
|
|
8922
|
+
* The attachment is a file.
|
|
8923
|
+
*/
|
|
8924
|
+
File = "file",
|
|
8925
|
+
/**
|
|
8926
|
+
* The attachment is an Exchange item.
|
|
8895
8927
|
*/
|
|
8896
|
-
|
|
8928
|
+
Item = "item"
|
|
8897
8929
|
}
|
|
8898
8930
|
/**
|
|
8899
8931
|
* Specifies the category color.
|
|
@@ -11456,6 +11488,74 @@ declare namespace Office {
|
|
|
11456
11488
|
* which is an `Office.AsyncResult` object. The EWS appointment ID is returned in the `asyncResult.value` property.
|
|
11457
11489
|
*/
|
|
11458
11490
|
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
11491
|
+
/**
|
|
11492
|
+
* Sends the appointment being composed.
|
|
11493
|
+
*
|
|
11494
|
+
* @remarks
|
|
11495
|
+
* [Api set: Mailbox 1.15]
|
|
11496
|
+
*
|
|
11497
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
11498
|
+
*
|
|
11499
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
11500
|
+
*
|
|
11501
|
+
* **Important**:
|
|
11502
|
+
*
|
|
11503
|
+
* - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
11504
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
11505
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
11506
|
+
*
|
|
11507
|
+
* - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
|
|
11508
|
+
* This is because the `sendAsync` method is an asynchronous API and events outside the add-in's control (for example, events handled by a separately installed
|
|
11509
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events| Smart Alerts add-in}) could block the item from being sent.
|
|
11510
|
+
* Since you can't rely on the status returned in `asyncResult.status` to run certain operations, you should only call the
|
|
11511
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | event.completed }
|
|
11512
|
+
* method in the callback function. The `event.completed` call signals that the add-in has completed processing. Other than this call, other code in the callback function
|
|
11513
|
+
* isn't guaranteed to run. We recommend processing other operations before calling `sendAsync`.
|
|
11514
|
+
*
|
|
11515
|
+
* - In a task pane implementation, any code included to run when `asyncResult.status` is `Office.AsyncResultStatus.Success` isn't guaranteed to be processed.
|
|
11516
|
+
* This is because the item may have already been sent and the add-in has completed processing. We recommend processing other operations before calling `sendAsync`.
|
|
11517
|
+
*
|
|
11518
|
+
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
11519
|
+
*
|
|
11520
|
+
* @param options - An object literal that contains the `asyncContext` property. Use the `asyncContext` property to specify any object you want to access in the
|
|
11521
|
+
* callback function.
|
|
11522
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
11523
|
+
* parameter is an `Office.AsyncResult` object.
|
|
11524
|
+
*/
|
|
11525
|
+
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
11526
|
+
/**
|
|
11527
|
+
* Sends the appointment being composed.
|
|
11528
|
+
*
|
|
11529
|
+
* @remarks
|
|
11530
|
+
* [Api set: Mailbox 1.15]
|
|
11531
|
+
*
|
|
11532
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
11533
|
+
*
|
|
11534
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
11535
|
+
*
|
|
11536
|
+
* **Important**:
|
|
11537
|
+
*
|
|
11538
|
+
* - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
11539
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
11540
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
11541
|
+
*
|
|
11542
|
+
* - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
|
|
11543
|
+
* This is because the `sendAsync` method is an asynchronous API and events outside the add-in's control (for example, events handled by a separately installed
|
|
11544
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events| Smart Alerts add-in}) could block the item from being sent.
|
|
11545
|
+
* Since you can't rely on the status returned in `asyncResult.status` to run certain operations, you should only call the
|
|
11546
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | event.completed }
|
|
11547
|
+
* method in the callback function. The `event.completed` call signals that the add-in has completed processing. Other than this call, other code in the callback function
|
|
11548
|
+
* isn't guaranteed to run. We recommend processing other operations before calling `sendAsync`.
|
|
11549
|
+
*
|
|
11550
|
+
* - In a task pane implementation, any code included to run when `asyncResult.status` is `Office.AsyncResultStatus.Success` isn't guaranteed to be processed.
|
|
11551
|
+
* This is because the item may have already been sent and the add-in has completed processing. We recommend processing other operations before calling `sendAsync`.
|
|
11552
|
+
*
|
|
11553
|
+
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
11554
|
+
*
|
|
11555
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
11556
|
+
* parameter is an `Office.AsyncResult` object.
|
|
11557
|
+
*/
|
|
11558
|
+
sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
11459
11559
|
/**
|
|
11460
11560
|
* Asynchronously inserts data into the body or subject of a message.
|
|
11461
11561
|
*
|
|
@@ -14737,6 +14837,33 @@ declare namespace Office {
|
|
|
14737
14837
|
*/
|
|
14738
14838
|
infobarType: MailboxEnums.InfobarType;
|
|
14739
14839
|
}
|
|
14840
|
+
/**
|
|
14841
|
+
* Provides data from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
|
|
14842
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
|
|
14843
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
|
|
14844
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog when the
|
|
14845
|
+
* `Office.EventType.InitializationContextChanged` event occurs.
|
|
14846
|
+
*
|
|
14847
|
+
* @remarks
|
|
14848
|
+
* [Api set: Mailbox 1.15]
|
|
14849
|
+
*/
|
|
14850
|
+
export interface InitializationContextChangedEventArgs {
|
|
14851
|
+
/**
|
|
14852
|
+
* Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated
|
|
14853
|
+
* spam-reporting dialog.
|
|
14854
|
+
*
|
|
14855
|
+
* @remarks
|
|
14856
|
+
* [Api set: Mailbox 1.15]
|
|
14857
|
+
*/
|
|
14858
|
+
initializationContextData: string;
|
|
14859
|
+
/**
|
|
14860
|
+
* Represents the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
14861
|
+
*
|
|
14862
|
+
* @remarks
|
|
14863
|
+
* [Api set: Mailbox 1.15]
|
|
14864
|
+
*/
|
|
14865
|
+
type: "olkInitializationContextChanged";
|
|
14866
|
+
}
|
|
14740
14867
|
/**
|
|
14741
14868
|
* The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
|
|
14742
14869
|
* and is converted to a MIME message.
|
|
@@ -15011,7 +15138,7 @@ declare namespace Office {
|
|
|
15011
15138
|
* A `LoadedMessageCompose` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in compose mode.
|
|
15012
15139
|
*
|
|
15013
15140
|
* @remarks
|
|
15014
|
-
* [Api set: Mailbox
|
|
15141
|
+
* [Api set: Mailbox 1.15]
|
|
15015
15142
|
*
|
|
15016
15143
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15017
15144
|
*
|
|
@@ -15025,8 +15152,6 @@ declare namespace Office {
|
|
|
15025
15152
|
*
|
|
15026
15153
|
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
15027
15154
|
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
15028
|
-
*
|
|
15029
|
-
* @beta
|
|
15030
15155
|
*/
|
|
15031
15156
|
interface LoadedMessageCompose {
|
|
15032
15157
|
/**
|
|
@@ -15184,9 +15309,7 @@ declare namespace Office {
|
|
|
15184
15309
|
*
|
|
15185
15310
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15186
15311
|
*
|
|
15187
|
-
* **Important**:
|
|
15188
|
-
*
|
|
15189
|
-
* - Only the `getAllAsync` method of the NotificationMessages object is supported.
|
|
15312
|
+
* **Important**: Only the `getAllAsync` method of the NotificationMessages object is supported.
|
|
15190
15313
|
*/
|
|
15191
15314
|
notificationMessages: NotificationMessages;
|
|
15192
15315
|
/**
|
|
@@ -15896,7 +16019,7 @@ declare namespace Office {
|
|
|
15896
16019
|
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
15897
16020
|
*
|
|
15898
16021
|
* @remarks
|
|
15899
|
-
* [Api set: Mailbox
|
|
16022
|
+
* [Api set: Mailbox 1.15]
|
|
15900
16023
|
*
|
|
15901
16024
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15902
16025
|
*
|
|
@@ -15913,15 +16036,13 @@ declare namespace Office {
|
|
|
15913
16036
|
* @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.
|
|
15914
16037
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
15915
16038
|
* which is an `Office.AsyncResult` object.
|
|
15916
|
-
*
|
|
15917
|
-
* @beta
|
|
15918
16039
|
*/
|
|
15919
16040
|
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
15920
16041
|
/**
|
|
15921
16042
|
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
15922
16043
|
*
|
|
15923
16044
|
* @remarks
|
|
15924
|
-
* [Api set: Mailbox
|
|
16045
|
+
* [Api set: Mailbox 1.15]
|
|
15925
16046
|
*
|
|
15926
16047
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15927
16048
|
*
|
|
@@ -15937,8 +16058,6 @@ declare namespace Office {
|
|
|
15937
16058
|
*
|
|
15938
16059
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
15939
16060
|
* which is an `Office.AsyncResult` object.
|
|
15940
|
-
*
|
|
15941
|
-
* @beta
|
|
15942
16061
|
*/
|
|
15943
16062
|
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
15944
16063
|
}
|
|
@@ -15947,7 +16066,7 @@ declare namespace Office {
|
|
|
15947
16066
|
* A `LoadedMessageRead` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in read mode.
|
|
15948
16067
|
*
|
|
15949
16068
|
* @remarks
|
|
15950
|
-
* [Api set: Mailbox
|
|
16069
|
+
* [Api set: Mailbox 1.15]
|
|
15951
16070
|
*
|
|
15952
16071
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15953
16072
|
*
|
|
@@ -15961,8 +16080,6 @@ declare namespace Office {
|
|
|
15961
16080
|
*
|
|
15962
16081
|
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
15963
16082
|
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
15964
|
-
*
|
|
15965
|
-
* @beta
|
|
15966
16083
|
*/
|
|
15967
16084
|
interface LoadedMessageRead {
|
|
15968
16085
|
/**
|
|
@@ -16807,7 +16924,7 @@ declare namespace Office {
|
|
|
16807
16924
|
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
16808
16925
|
*
|
|
16809
16926
|
* @remarks
|
|
16810
|
-
* [Api set: Mailbox
|
|
16927
|
+
* [Api set: Mailbox 1.15]
|
|
16811
16928
|
*
|
|
16812
16929
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16813
16930
|
*
|
|
@@ -16824,15 +16941,13 @@ declare namespace Office {
|
|
|
16824
16941
|
* @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.
|
|
16825
16942
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
16826
16943
|
* which is an `Office.AsyncResult` object.
|
|
16827
|
-
*
|
|
16828
|
-
* @beta
|
|
16829
16944
|
*/
|
|
16830
16945
|
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16831
16946
|
/**
|
|
16832
16947
|
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
16833
16948
|
*
|
|
16834
16949
|
* @remarks
|
|
16835
|
-
* [Api set: Mailbox
|
|
16950
|
+
* [Api set: Mailbox 1.15]
|
|
16836
16951
|
*
|
|
16837
16952
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16838
16953
|
*
|
|
@@ -16848,8 +16963,6 @@ declare namespace Office {
|
|
|
16848
16963
|
*
|
|
16849
16964
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
16850
16965
|
* which is an `Office.AsyncResult` object.
|
|
16851
|
-
*
|
|
16852
|
-
* @beta
|
|
16853
16966
|
*/
|
|
16854
16967
|
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16855
16968
|
}
|
|
@@ -17610,9 +17723,10 @@ declare namespace Office {
|
|
|
17610
17723
|
*
|
|
17611
17724
|
* `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
|
|
17612
17725
|
*
|
|
17613
|
-
* `attachments`: An array of JSON objects that are either file or item attachments.
|
|
17726
|
+
* `attachments`: An array of JSON objects that are either file or Exchange item attachments.
|
|
17614
17727
|
*
|
|
17615
|
-
* `attachments.type`: Indicates the type of attachment. Must be `
|
|
17728
|
+
* `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
|
|
17729
|
+
* `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
|
|
17616
17730
|
*
|
|
17617
17731
|
* `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
|
|
17618
17732
|
*
|
|
@@ -17657,9 +17771,10 @@ declare namespace Office {
|
|
|
17657
17771
|
*
|
|
17658
17772
|
* `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
|
|
17659
17773
|
*
|
|
17660
|
-
* `attachments`: An array of JSON objects that are either file or item attachments.
|
|
17774
|
+
* `attachments`: An array of JSON objects that are either file or Exchange item attachments.
|
|
17661
17775
|
*
|
|
17662
|
-
* `attachments.type`: Indicates the type of attachment. Must be `
|
|
17776
|
+
* `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
|
|
17777
|
+
* `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
|
|
17663
17778
|
*
|
|
17664
17779
|
* `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
|
|
17665
17780
|
*
|
|
@@ -17708,9 +17823,10 @@ declare namespace Office {
|
|
|
17708
17823
|
*
|
|
17709
17824
|
* `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
|
|
17710
17825
|
*
|
|
17711
|
-
* `attachments`: An array of JSON objects that are either file or item attachments.
|
|
17826
|
+
* `attachments`: An array of JSON objects that are either file or Exchange item attachments.
|
|
17712
17827
|
*
|
|
17713
|
-
* `attachments.type`: Indicates the type of attachment. Must be `
|
|
17828
|
+
* `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
|
|
17829
|
+
* `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
|
|
17714
17830
|
*
|
|
17715
17831
|
* `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
|
|
17716
17832
|
*
|
|
@@ -18062,12 +18178,12 @@ declare namespace Office {
|
|
|
18062
18178
|
* Then, gets an object that provides the properties and methods of the loaded item.
|
|
18063
18179
|
*
|
|
18064
18180
|
* @remarks
|
|
18065
|
-
* [Api set: Mailbox
|
|
18181
|
+
* [Api set: Mailbox 1.15]
|
|
18066
18182
|
*
|
|
18067
18183
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18068
18184
|
*
|
|
18069
18185
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
18070
|
-
*
|
|
18186
|
+
*
|
|
18071
18187
|
* **Important**:
|
|
18072
18188
|
*
|
|
18073
18189
|
* - This method only applies to messages.
|
|
@@ -18083,14 +18199,12 @@ declare namespace Office {
|
|
|
18083
18199
|
*
|
|
18084
18200
|
* - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
|
|
18085
18201
|
*
|
|
18086
|
-
* @param itemId - The EWS ID of a
|
|
18202
|
+
* @param itemId - The EWS ID of a mail item.
|
|
18087
18203
|
* @param options - An object literal that contains the `asyncContext` property.
|
|
18088
18204
|
* In this property, provide any object you wish to access in the callback function.
|
|
18089
18205
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18090
18206
|
* `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
|
|
18091
|
-
* in the `asyncResult.value` property. This object provides the properties of the
|
|
18092
|
-
*
|
|
18093
|
-
* @beta
|
|
18207
|
+
* in the `asyncResult.value` property. This object provides the properties of the item that's currently loaded.
|
|
18094
18208
|
*/
|
|
18095
18209
|
loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
|
|
18096
18210
|
/**
|
|
@@ -18098,12 +18212,12 @@ declare namespace Office {
|
|
|
18098
18212
|
* Then, gets an object that provides the properties and methods of the loaded item.
|
|
18099
18213
|
*
|
|
18100
18214
|
* @remarks
|
|
18101
|
-
* [Api set: Mailbox
|
|
18215
|
+
* [Api set: Mailbox 1.15]
|
|
18102
18216
|
*
|
|
18103
18217
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18104
18218
|
*
|
|
18105
18219
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
18106
|
-
*
|
|
18220
|
+
*
|
|
18107
18221
|
* **Important**:
|
|
18108
18222
|
*
|
|
18109
18223
|
* - This method only applies to messages.
|
|
@@ -18119,12 +18233,10 @@ declare namespace Office {
|
|
|
18119
18233
|
*
|
|
18120
18234
|
* - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
|
|
18121
18235
|
*
|
|
18122
|
-
* @param itemId - The EWS ID of a
|
|
18236
|
+
* @param itemId - The EWS ID of a mail item.
|
|
18123
18237
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18124
18238
|
* `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
|
|
18125
|
-
* in the `asyncResult.value` property. This object provides the properties of the
|
|
18126
|
-
*
|
|
18127
|
-
* @beta
|
|
18239
|
+
* in the `asyncResult.value` property. This object provides the properties of the item that's currently loaded.
|
|
18128
18240
|
*/
|
|
18129
18241
|
loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
|
|
18130
18242
|
/**
|
|
@@ -19082,6 +19194,10 @@ declare namespace Office {
|
|
|
19082
19194
|
*
|
|
19083
19195
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19084
19196
|
*
|
|
19197
|
+
* **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
19198
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
19199
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
19200
|
+
*
|
|
19085
19201
|
* **Errors**:
|
|
19086
19202
|
*
|
|
19087
19203
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog and the `discardItem` property isn't defined or is set to `false`.
|
|
@@ -19114,6 +19230,10 @@ declare namespace Office {
|
|
|
19114
19230
|
*
|
|
19115
19231
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19116
19232
|
*
|
|
19233
|
+
* **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
19234
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
19235
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
19236
|
+
*
|
|
19117
19237
|
* **Errors**:
|
|
19118
19238
|
*
|
|
19119
19239
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
|
|
@@ -19986,6 +20106,74 @@ declare namespace Office {
|
|
|
19986
20106
|
* which is an `Office.AsyncResult` object. The EWS message ID is returned in the `asyncResult.value` property.
|
|
19987
20107
|
*/
|
|
19988
20108
|
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
20109
|
+
/**
|
|
20110
|
+
* Sends the message being composed.
|
|
20111
|
+
*
|
|
20112
|
+
* @remarks
|
|
20113
|
+
* [Api set: Mailbox 1.15]
|
|
20114
|
+
*
|
|
20115
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
20116
|
+
*
|
|
20117
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
20118
|
+
*
|
|
20119
|
+
* **Important**:
|
|
20120
|
+
*
|
|
20121
|
+
* - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
20122
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
20123
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
20124
|
+
*
|
|
20125
|
+
* - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
|
|
20126
|
+
* This is because the `sendAsync` method is an asynchronous API and events outside the add-in's control (for example, events handled by a separately installed
|
|
20127
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events| Smart Alerts add-in}) could block the item from being sent.
|
|
20128
|
+
* Since you can't rely on the status returned in `asyncResult.status` to run certain operations, you should only call the
|
|
20129
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | event.completed }
|
|
20130
|
+
* method in the callback function. The `event.completed` call signals that the add-in has completed processing. Other than this call, other code in the callback function
|
|
20131
|
+
* isn't guaranteed to run. We recommend processing other operations before calling `sendAsync`.
|
|
20132
|
+
*
|
|
20133
|
+
* - In a task pane implementation, any code included to run when `asyncResult.status` is `Office.AsyncResultStatus.Success` isn't guaranteed to be processed.
|
|
20134
|
+
* This is because the item may have already been sent and the add-in has completed processing. We recommend processing other operations before calling `sendAsync`.
|
|
20135
|
+
*
|
|
20136
|
+
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
20137
|
+
*
|
|
20138
|
+
* @param options - An object literal that contains the `asyncContext` property. Use the `asyncContext` property to specify any object you want to access in the
|
|
20139
|
+
* callback function.
|
|
20140
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
20141
|
+
* parameter is an `Office.AsyncResult` object.
|
|
20142
|
+
*/
|
|
20143
|
+
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
20144
|
+
/**
|
|
20145
|
+
* Sends the message being composed.
|
|
20146
|
+
*
|
|
20147
|
+
* @remarks
|
|
20148
|
+
* [Api set: Mailbox 1.15]
|
|
20149
|
+
*
|
|
20150
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
20151
|
+
*
|
|
20152
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
20153
|
+
*
|
|
20154
|
+
* **Important**:
|
|
20155
|
+
*
|
|
20156
|
+
* - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
20157
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
|
|
20158
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
20159
|
+
*
|
|
20160
|
+
* - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
|
|
20161
|
+
* This is because the `sendAsync` method is an asynchronous API and events outside the add-in's control (for example, events handled by a separately installed
|
|
20162
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events| Smart Alerts add-in}) could block the item from being sent.
|
|
20163
|
+
* Since you can't rely on the status returned in `asyncResult.status` to run certain operations, you should only call the
|
|
20164
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | event.completed }
|
|
20165
|
+
* method in the callback function. The `event.completed` call signals that the add-in has completed processing. Other than this call, other code in the callback function
|
|
20166
|
+
* isn't guaranteed to run. We recommend processing other operations before calling `sendAsync`.
|
|
20167
|
+
*
|
|
20168
|
+
* - In a task pane implementation, any code included to run when `asyncResult.status` is `Office.AsyncResultStatus.Success` isn't guaranteed to be processed.
|
|
20169
|
+
* This is because the item may have already been sent and the add-in has completed processing. We recommend processing other operations before calling `sendAsync`.
|
|
20170
|
+
*
|
|
20171
|
+
* - Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after the `sendAsync` call.
|
|
20172
|
+
*
|
|
20173
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`. The `asyncResult`
|
|
20174
|
+
* parameter is an `Office.AsyncResult` object.
|
|
20175
|
+
*/
|
|
20176
|
+
sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
19989
20177
|
/**
|
|
19990
20178
|
* Asynchronously inserts data into the body or subject of a message.
|
|
19991
20179
|
*
|
|
@@ -22299,29 +22487,49 @@ declare namespace Office {
|
|
|
22299
22487
|
*/
|
|
22300
22488
|
interface ReplyFormAttachment {
|
|
22301
22489
|
/**
|
|
22302
|
-
* Indicates the type of attachment.
|
|
22490
|
+
* Indicates the type of attachment.
|
|
22491
|
+
*
|
|
22492
|
+
* @remarks
|
|
22493
|
+
*
|
|
22494
|
+
* **Important**:
|
|
22495
|
+
*
|
|
22496
|
+
* - The `base64` attachment type was introduced in Mailbox requirement set 1.15. It's only supported by the `displayReplyAllForm`, `displayReplyAllFormAsync`, `displayReplyForm`, and
|
|
22497
|
+
* `displayReplyFormAsync` methods.
|
|
22498
|
+
*
|
|
22499
|
+
* - The `cloud` attachment type isn't supported by the `displayNewMessageForm`, `displayNewMessageFormAsync`, `displayReplyAllForm`, `displayReplyAllFormAsync`,
|
|
22500
|
+
* `displayReplyForm`, and `displayReplyFormAsync` methods.
|
|
22303
22501
|
*/
|
|
22304
|
-
type:
|
|
22502
|
+
type: MailboxEnums.AttachmentType;
|
|
22305
22503
|
/**
|
|
22306
22504
|
* A string that contains the name of the attachment, up to 255 characters in length.
|
|
22307
22505
|
*/
|
|
22308
22506
|
name: string;
|
|
22309
22507
|
/**
|
|
22310
|
-
*
|
|
22508
|
+
* The URI of the location for the file. Only use if `type` is set to `file`.
|
|
22311
22509
|
*
|
|
22312
|
-
*
|
|
22510
|
+
* @remarks
|
|
22511
|
+
*
|
|
22512
|
+
* **Important**: This link must be publicly accessible without need for authentication by Exchange Online servers. However, with
|
|
22313
22513
|
* on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
|
|
22314
22514
|
*/
|
|
22315
22515
|
url?: string;
|
|
22316
22516
|
/**
|
|
22317
|
-
*
|
|
22318
|
-
*
|
|
22517
|
+
* If true, indicates that the attachment will be shown inline in the message body and shouldn't be displayed in the attachment list.
|
|
22518
|
+
* Only use if `type` is set to `file`.
|
|
22319
22519
|
*/
|
|
22320
22520
|
inLine?: boolean;
|
|
22321
22521
|
/**
|
|
22322
|
-
*
|
|
22522
|
+
* The EWS item ID of the attachment. This is a string up to 100 characters. Only use if `type` is set to `item`.
|
|
22323
22523
|
*/
|
|
22324
22524
|
itemId?: string;
|
|
22525
|
+
/**
|
|
22526
|
+
* The Base64-encoded string of the file to be attached. Only use if `type` is set to `base64`.
|
|
22527
|
+
*
|
|
22528
|
+
* @remarks
|
|
22529
|
+
*
|
|
22530
|
+
* [Api set: Mailbox 1.15]
|
|
22531
|
+
*/
|
|
22532
|
+
base64File?: string;
|
|
22325
22533
|
}
|
|
22326
22534
|
/**
|
|
22327
22535
|
* A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.
|
|
@@ -22332,7 +22540,7 @@ declare namespace Office {
|
|
|
22332
22540
|
*/
|
|
22333
22541
|
htmlBody?: string;
|
|
22334
22542
|
/**
|
|
22335
|
-
* An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are
|
|
22543
|
+
* An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are Base64-encoded files, Exchange items, or file attachments.
|
|
22336
22544
|
*/
|
|
22337
22545
|
attachments?: ReplyFormAttachment[];
|
|
22338
22546
|
/**
|
|
@@ -23310,10 +23518,10 @@ declare namespace Office {
|
|
|
23310
23518
|
allowEvent?: boolean;
|
|
23311
23519
|
/**
|
|
23312
23520
|
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
23313
|
-
* this property customizes the text of
|
|
23521
|
+
* this property customizes the text of a button in the Smart Alerts dialog. Custom text must be 20 characters or less.
|
|
23314
23522
|
*
|
|
23315
23523
|
* For an example, see the
|
|
23316
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-
|
|
23524
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-text-and-functionality-of-a-button-in-the-dialog-optional | Smart Alerts walkthrough}.
|
|
23317
23525
|
*
|
|
23318
23526
|
* @remarks
|
|
23319
23527
|
*
|
|
@@ -23322,14 +23530,29 @@ declare namespace Office {
|
|
|
23322
23530
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
23323
23531
|
*
|
|
23324
23532
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23533
|
+
*
|
|
23534
|
+
* **Important**:
|
|
23535
|
+
*
|
|
23536
|
+
* The customizable button in the Smart Alerts dialog varies depending on the Outlook client and its version.
|
|
23537
|
+
*
|
|
23538
|
+
* - 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.
|
|
23539
|
+
* 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
|
|
23540
|
+
* 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.
|
|
23541
|
+
* 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.
|
|
23542
|
+
* 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.
|
|
23543
|
+
* 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.
|
|
23544
|
+
*
|
|
23545
|
+
* - In earlier supported versions of classic Outlook on Windows (versions prior to Version 2412 (Build 18324.20000) that support
|
|
23546
|
+
* {@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}),
|
|
23547
|
+
* and Outlook on Mac (preview), the `cancelLabel` property customizes the text of the **Don't Send** button. The **Don't Send** button cancels the item being sent.
|
|
23325
23548
|
*/
|
|
23326
23549
|
cancelLabel?: string;
|
|
23327
23550
|
/**
|
|
23328
23551
|
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
23329
|
-
* this property specifies the ID of the task pane or function that runs
|
|
23552
|
+
* this property specifies the ID of the task pane or function that runs from a button in the Smart Alerts dialog.
|
|
23330
23553
|
*
|
|
23331
23554
|
* For an example, see the
|
|
23332
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-
|
|
23555
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-text-and-functionality-of-a-button-in-the-dialog-optional | Smart Alerts walkthrough}.
|
|
23333
23556
|
*
|
|
23334
23557
|
* @remarks
|
|
23335
23558
|
*
|
|
@@ -23348,13 +23571,29 @@ declare namespace Office {
|
|
|
23348
23571
|
*
|
|
23349
23572
|
* - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function command in the "controls" array.
|
|
23350
23573
|
*
|
|
23574
|
+
* The button in the Smart Alerts dialog that opens a task pane or runs a function varies depending on the Outlook client and version.
|
|
23575
|
+
* 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
|
|
23576
|
+
* 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.
|
|
23577
|
+
* In earlier supported versions of classic Outlook on Windows (versions prior to Version 2412 (Build 18324.20000) that support
|
|
23578
|
+
* {@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}),
|
|
23579
|
+
* and Outlook on Mac (preview), the **Don't Send** button opens a task pane or runs a function.
|
|
23580
|
+
*
|
|
23581
|
+
* 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,
|
|
23582
|
+
* 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.
|
|
23583
|
+
* Although no implementation changes are needed, we recommend notifying users of this updated experience.
|
|
23584
|
+
*
|
|
23585
|
+
* If you specify a command ID that doesn't exist, depending on your Outlook client, the **Take Action** or **Don't Send** button simply cancels the item being sent.
|
|
23586
|
+
*
|
|
23351
23587
|
* If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
|
|
23352
23588
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
23589
|
+
*
|
|
23590
|
+
* 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.
|
|
23591
|
+
* Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
|
|
23353
23592
|
*/
|
|
23354
23593
|
commandId?: string;
|
|
23355
23594
|
/**
|
|
23356
|
-
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to
|
|
23357
|
-
* this property specifies any JSON data passed to the add-in for processing when the
|
|
23595
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to
|
|
23596
|
+
* signal completion of an event handler and set its `allowEvent` property to `false`, this property specifies any JSON data passed to the add-in for processing when the applicable button is selected from the Smart Alerts dialog.
|
|
23358
23597
|
*
|
|
23359
23598
|
* @remarks
|
|
23360
23599
|
*
|
|
@@ -23369,12 +23608,18 @@ declare namespace Office {
|
|
|
23369
23608
|
* - In Outlook on Windows, the `any` type is supported starting in Version 2402 (Build 17308.20000). In earlier versions of Outlook on Windows, only the `string`
|
|
23370
23609
|
* type is supported.
|
|
23371
23610
|
*
|
|
23372
|
-
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
23611
|
+
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
|
|
23373
23612
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
23374
23613
|
*
|
|
23614
|
+
* - The dialog button that passes the `contextData` value to the add-in varies depending on the Outlook client and its version. For more information, see
|
|
23615
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-text-and-functionality-of-a-button-in-the-dialog-optional | Customize the text and functionality of a button in the dialog}.
|
|
23616
|
+
*
|
|
23375
23617
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
23376
23618
|
* 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
|
|
23377
23619
|
* `JSON.parse()` once you retrieve it.
|
|
23620
|
+
*
|
|
23621
|
+
* - 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.
|
|
23622
|
+
* Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
|
|
23378
23623
|
*/
|
|
23379
23624
|
contextData?: any;
|
|
23380
23625
|
/**
|
|
@@ -23400,7 +23645,7 @@ declare namespace Office {
|
|
|
23400
23645
|
*
|
|
23401
23646
|
* @remarks
|
|
23402
23647
|
*
|
|
23403
|
-
* [Api set: Mailbox
|
|
23648
|
+
* [Api set: Mailbox 1.15]
|
|
23404
23649
|
*
|
|
23405
23650
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
23406
23651
|
*
|
|
@@ -23415,8 +23660,6 @@ declare namespace Office {
|
|
|
23415
23660
|
*
|
|
23416
23661
|
* - 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.
|
|
23417
23662
|
* This ensures that the message is displayed properly in Outlook clients that don't support Markdown.
|
|
23418
|
-
*
|
|
23419
|
-
* @beta
|
|
23420
23663
|
*/
|
|
23421
23664
|
errorMessageMarkdown?: string;
|
|
23422
23665
|
/**
|
|
@@ -23504,7 +23747,7 @@ declare namespace Office {
|
|
|
23504
23747
|
*
|
|
23505
23748
|
* @remarks
|
|
23506
23749
|
*
|
|
23507
|
-
* [Api set: Mailbox
|
|
23750
|
+
* [Api set: Mailbox 1.15]
|
|
23508
23751
|
*
|
|
23509
23752
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
23510
23753
|
*
|
|
@@ -23512,11 +23755,8 @@ declare namespace Office {
|
|
|
23512
23755
|
*
|
|
23513
23756
|
* **Important**:
|
|
23514
23757
|
*
|
|
23515
|
-
* -
|
|
23516
|
-
*
|
|
23517
|
-
* {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
|
|
23518
|
-
* and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
|
|
23519
|
-
* {@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)}.
|
|
23758
|
+
* - To learn how to implement the `commandId` property in your spam-reporting add-in, see
|
|
23759
|
+
* {@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}.
|
|
23520
23760
|
*
|
|
23521
23761
|
* - The `commandId` value must match the task pane ID specified in the manifest of your add-in. In an add-in only manifest,
|
|
23522
23762
|
* 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.
|
|
@@ -23525,9 +23765,10 @@ declare namespace Office {
|
|
|
23525
23765
|
* - If you configure the `commandId` option in the `event.completed` call, a post-processing dialog isn't shown to the user
|
|
23526
23766
|
* even if the `showPostProcessingDialog` option is specified in the call.
|
|
23527
23767
|
*
|
|
23528
|
-
* -
|
|
23768
|
+
* - 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
|
|
23769
|
+
* `Office.MailboxEnums.MoveSpamItemTo.NoMove`.
|
|
23529
23770
|
*
|
|
23530
|
-
*
|
|
23771
|
+
* - 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.
|
|
23531
23772
|
*/
|
|
23532
23773
|
commandId?: string;
|
|
23533
23774
|
/**
|
|
@@ -23536,7 +23777,7 @@ declare namespace Office {
|
|
|
23536
23777
|
*
|
|
23537
23778
|
* @remarks
|
|
23538
23779
|
*
|
|
23539
|
-
* [Api set: Mailbox
|
|
23780
|
+
* [Api set: Mailbox 1.15]
|
|
23540
23781
|
*
|
|
23541
23782
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
23542
23783
|
*
|
|
@@ -23544,11 +23785,8 @@ declare namespace Office {
|
|
|
23544
23785
|
*
|
|
23545
23786
|
* **Important**:
|
|
23546
23787
|
*
|
|
23547
|
-
* -
|
|
23548
|
-
*
|
|
23549
|
-
* {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
|
|
23550
|
-
* and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
|
|
23551
|
-
* {@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)}.
|
|
23788
|
+
* - To learn how to implement the `contextData` property in your spam-reporting add-in, see
|
|
23789
|
+
* {@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}.
|
|
23552
23790
|
*
|
|
23553
23791
|
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
23554
23792
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
@@ -23556,13 +23794,14 @@ declare namespace Office {
|
|
|
23556
23794
|
* - If you configure the `commandId` and `contextData` options in the `event.completed` call, a post-processing dialog isn't shown to the user
|
|
23557
23795
|
* even if the `showPostProcessingDialog` option is specified in the call.
|
|
23558
23796
|
*
|
|
23797
|
+
* - 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
|
|
23798
|
+
* `Office.MailboxEnums.MoveSpamItemTo.NoMove`.
|
|
23799
|
+
*
|
|
23559
23800
|
* - 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.
|
|
23560
23801
|
*
|
|
23561
23802
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
23562
23803
|
* 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
|
|
23563
23804
|
* `JSON.parse()` once you retrieve it.
|
|
23564
|
-
*
|
|
23565
|
-
* @beta
|
|
23566
23805
|
*/
|
|
23567
23806
|
contextData?: any;
|
|
23568
23807
|
/**
|
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.570",
|
|
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": "09e6f53c9386c229a13aa471724b75a4e0882fa6e294704b33d5d146e6b7001e",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|