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