@types/office-js 1.0.325 → 1.0.326
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/README.md +1 -1
- office-js/index.d.ts +672 -110
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 19 May 2023 21:32:51 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js/index.d.ts
CHANGED
|
@@ -981,6 +981,19 @@ declare namespace Office {
|
|
|
981
981
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
982
982
|
*/
|
|
983
983
|
roamingSettings: Office.RoamingSettings;
|
|
984
|
+
/**
|
|
985
|
+
* Gets the object to check the status of the catalog of sensitivity labels in Outlook and retrieve all available
|
|
986
|
+
* sensitivity labels if the catalog is enabled.
|
|
987
|
+
*
|
|
988
|
+
* @remarks
|
|
989
|
+
*
|
|
990
|
+
* [Api set: Mailbox 1.13]
|
|
991
|
+
*
|
|
992
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
993
|
+
*
|
|
994
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
995
|
+
*/
|
|
996
|
+
sensitivityLabelsCatalog: Office.SensitivityLabelsCatalog;
|
|
984
997
|
/**
|
|
985
998
|
* Specifies whether the platform and device allows touch interaction.
|
|
986
999
|
* True if the add-in is running on a touch device, such as an iPad; false otherwise.
|
|
@@ -2379,6 +2392,26 @@ declare namespace Office {
|
|
|
2379
2392
|
* Triggers when a Resource selection happens in Project.
|
|
2380
2393
|
*/
|
|
2381
2394
|
ResourceSelectionChanged,
|
|
2395
|
+
/**
|
|
2396
|
+
* Occurs in Outlook when one or more messages are selected or deselected.
|
|
2397
|
+
* **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
|
|
2398
|
+
*
|
|
2399
|
+
* To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
2400
|
+
*
|
|
2401
|
+
* [Api set: Mailbox 1.13]
|
|
2402
|
+
*/
|
|
2403
|
+
SelectedItemsChanged,
|
|
2404
|
+
/**
|
|
2405
|
+
* Occurs in Outlook when the sensitivity label of a message or appointment changes.
|
|
2406
|
+
* **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
|
|
2407
|
+
*
|
|
2408
|
+
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
2409
|
+
* The event handler receives an argument of type
|
|
2410
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs | Office.SensitivityLabelChangedEventArgs}.
|
|
2411
|
+
*
|
|
2412
|
+
* [Api set: Mailbox 1.13]
|
|
2413
|
+
*/
|
|
2414
|
+
SensitivityLabelChanged,
|
|
2382
2415
|
/**
|
|
2383
2416
|
* A Settings.settingsChanged event was raised.
|
|
2384
2417
|
*
|
|
@@ -9610,7 +9643,7 @@ declare namespace Office {
|
|
|
9610
9643
|
*
|
|
9611
9644
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9612
9645
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9613
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9646
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
9614
9647
|
*
|
|
9615
9648
|
* Child interfaces:
|
|
9616
9649
|
*
|
|
@@ -9625,7 +9658,7 @@ declare namespace Office {
|
|
|
9625
9658
|
*
|
|
9626
9659
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9627
9660
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9628
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9661
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
9629
9662
|
*
|
|
9630
9663
|
* Parent interfaces:
|
|
9631
9664
|
*
|
|
@@ -10010,7 +10043,7 @@ declare namespace Office {
|
|
|
10010
10043
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10011
10044
|
*
|
|
10012
10045
|
* For supported events, refer to the Item object model
|
|
10013
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10046
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10014
10047
|
*
|
|
10015
10048
|
* @remarks
|
|
10016
10049
|
* [Api set: Mailbox 1.7]
|
|
@@ -10032,7 +10065,7 @@ declare namespace Office {
|
|
|
10032
10065
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10033
10066
|
*
|
|
10034
10067
|
* For supported events, refer to the Item object model
|
|
10035
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10068
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10036
10069
|
*
|
|
10037
10070
|
* @remarks
|
|
10038
10071
|
* [Api set: Mailbox 1.7]
|
|
@@ -10404,45 +10437,43 @@ declare namespace Office {
|
|
|
10404
10437
|
*/
|
|
10405
10438
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
10406
10439
|
/**
|
|
10407
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
10440
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10408
10441
|
*
|
|
10409
|
-
* For more information around using this API, see
|
|
10410
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
10411
|
-
*
|
|
10412
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
10442
|
+
* For more information around using this API, see
|
|
10443
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
10413
10444
|
*
|
|
10414
10445
|
* @remarks
|
|
10415
|
-
* [Api set: Mailbox 1.8]
|
|
10446
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10416
10447
|
*
|
|
10417
10448
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10418
10449
|
*
|
|
10419
10450
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10420
10451
|
*
|
|
10452
|
+
* *Note**: This method is not supported in Outlook on iOS or Android.
|
|
10453
|
+
*
|
|
10421
10454
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10422
10455
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10423
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10424
|
-
*
|
|
10425
|
-
* The `value` property of the result is the properties of the shared item.
|
|
10456
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10457
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10426
10458
|
*/
|
|
10427
10459
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10428
10460
|
/**
|
|
10429
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
10461
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10430
10462
|
*
|
|
10431
|
-
* For more information around using this API, see
|
|
10432
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
10433
|
-
*
|
|
10434
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
10463
|
+
* For more information around using this API, see
|
|
10464
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
10435
10465
|
*
|
|
10436
10466
|
* @remarks
|
|
10437
|
-
* [Api set: Mailbox 1.8]
|
|
10467
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10438
10468
|
*
|
|
10439
10469
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10440
10470
|
*
|
|
10441
10471
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10442
10472
|
*
|
|
10443
|
-
*
|
|
10444
|
-
*
|
|
10445
|
-
*
|
|
10473
|
+
* *Note**: This method is not supported in Outlook on iOS or Android.
|
|
10474
|
+
*
|
|
10475
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10476
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10446
10477
|
*/
|
|
10447
10478
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10448
10479
|
/**
|
|
@@ -10571,7 +10602,7 @@ declare namespace Office {
|
|
|
10571
10602
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10572
10603
|
*
|
|
10573
10604
|
* For supported events, refer to the Item object model
|
|
10574
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10605
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10575
10606
|
*
|
|
10576
10607
|
* @remarks
|
|
10577
10608
|
* [Api set: Mailbox 1.7]
|
|
@@ -10591,7 +10622,7 @@ declare namespace Office {
|
|
|
10591
10622
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10592
10623
|
*
|
|
10593
10624
|
* For supported events, refer to the Item object model
|
|
10594
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10625
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10595
10626
|
*
|
|
10596
10627
|
* @remarks
|
|
10597
10628
|
* [Api set: Mailbox 1.7]
|
|
@@ -10915,7 +10946,7 @@ declare namespace Office {
|
|
|
10915
10946
|
*
|
|
10916
10947
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
10917
10948
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
10918
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10949
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
10919
10950
|
*
|
|
10920
10951
|
* Parent interfaces:
|
|
10921
10952
|
*
|
|
@@ -11235,7 +11266,7 @@ declare namespace Office {
|
|
|
11235
11266
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11236
11267
|
*
|
|
11237
11268
|
* For supported events, refer to the Item object model
|
|
11238
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11269
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11239
11270
|
*
|
|
11240
11271
|
* @remarks
|
|
11241
11272
|
* [Api set: Mailbox 1.7]
|
|
@@ -11257,7 +11288,7 @@ declare namespace Office {
|
|
|
11257
11288
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11258
11289
|
*
|
|
11259
11290
|
* For supported events, refer to the Item object model
|
|
11260
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11291
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11261
11292
|
*
|
|
11262
11293
|
* @remarks
|
|
11263
11294
|
* [Api set: Mailbox 1.7]
|
|
@@ -11722,45 +11753,43 @@ declare namespace Office {
|
|
|
11722
11753
|
*/
|
|
11723
11754
|
getSelectedRegExMatches(): any;
|
|
11724
11755
|
/**
|
|
11725
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
11756
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11726
11757
|
*
|
|
11727
|
-
* For more information around using this API, see
|
|
11728
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
11729
|
-
*
|
|
11730
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11758
|
+
* For more information around using this API, see
|
|
11759
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
11731
11760
|
*
|
|
11732
11761
|
* @remarks
|
|
11733
|
-
* [Api set: Mailbox 1.8]
|
|
11762
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11734
11763
|
*
|
|
11735
11764
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11736
11765
|
*
|
|
11737
11766
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11738
11767
|
*
|
|
11768
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11769
|
+
*
|
|
11739
11770
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11740
11771
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11741
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
11742
|
-
*
|
|
11743
|
-
* The `value` property of the result is the properties of the shared item.
|
|
11772
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11773
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11744
11774
|
*/
|
|
11745
11775
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11746
11776
|
/**
|
|
11747
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
11748
|
-
*
|
|
11749
|
-
* For more information around using this API, see the
|
|
11750
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
11777
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11751
11778
|
*
|
|
11752
|
-
*
|
|
11779
|
+
* For more information around using this API, see
|
|
11780
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
11753
11781
|
*
|
|
11754
11782
|
* @remarks
|
|
11755
|
-
* [Api set: Mailbox 1.8]
|
|
11783
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11756
11784
|
*
|
|
11757
11785
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11758
11786
|
*
|
|
11759
11787
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11760
11788
|
*
|
|
11761
|
-
*
|
|
11762
|
-
*
|
|
11763
|
-
*
|
|
11789
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11790
|
+
*
|
|
11791
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11792
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11764
11793
|
*/
|
|
11765
11794
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11766
11795
|
/**
|
|
@@ -11793,7 +11822,7 @@ declare namespace Office {
|
|
|
11793
11822
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11794
11823
|
*
|
|
11795
11824
|
* For supported events, refer to the Item object model
|
|
11796
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11825
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11797
11826
|
*
|
|
11798
11827
|
* @remarks
|
|
11799
11828
|
* [Api set: Mailbox 1.7]
|
|
@@ -11813,7 +11842,7 @@ declare namespace Office {
|
|
|
11813
11842
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11814
11843
|
*
|
|
11815
11844
|
* For supported events, refer to the Item object model
|
|
11816
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11845
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11817
11846
|
*
|
|
11818
11847
|
* @remarks
|
|
11819
11848
|
* [Api set: Mailbox 1.7]
|
|
@@ -12243,6 +12272,85 @@ declare namespace Office {
|
|
|
12243
12272
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12244
12273
|
*/
|
|
12245
12274
|
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12275
|
+
/**
|
|
12276
|
+
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12277
|
+
*
|
|
12278
|
+
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12279
|
+
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12280
|
+
*
|
|
12281
|
+
* @remarks
|
|
12282
|
+
* [Api set: Mailbox 1.13]
|
|
12283
|
+
*
|
|
12284
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12285
|
+
*
|
|
12286
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12287
|
+
*
|
|
12288
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12289
|
+
*
|
|
12290
|
+
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12291
|
+
*
|
|
12292
|
+
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in},
|
|
12293
|
+
* the prepend-on-send feature runs first.
|
|
12294
|
+
*
|
|
12295
|
+
* - A new line is added after the prepended content.
|
|
12296
|
+
*
|
|
12297
|
+
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12298
|
+
* The content of the last run add-in appears above previously prepended content.
|
|
12299
|
+
*
|
|
12300
|
+
* - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
|
|
12301
|
+
*
|
|
12302
|
+
* **Errors**:
|
|
12303
|
+
*
|
|
12304
|
+
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12305
|
+
*
|
|
12306
|
+
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12307
|
+
*
|
|
12308
|
+
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12309
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12310
|
+
* `asyncContext`: Any object that can be accessed in the callback function.
|
|
12311
|
+
* `coercionType`: The desired format for the body. The string in the `data` parameter is converted to this format.
|
|
12312
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12313
|
+
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12314
|
+
*/
|
|
12315
|
+
prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12316
|
+
/**
|
|
12317
|
+
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12318
|
+
*
|
|
12319
|
+
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12320
|
+
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12321
|
+
*
|
|
12322
|
+
* @remarks
|
|
12323
|
+
* [Api set: Mailbox 1.13]
|
|
12324
|
+
*
|
|
12325
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12326
|
+
*
|
|
12327
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12328
|
+
*
|
|
12329
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12330
|
+
*
|
|
12331
|
+
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12332
|
+
*
|
|
12333
|
+
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in},
|
|
12334
|
+
* the prepend-on-send feature runs first.
|
|
12335
|
+
*
|
|
12336
|
+
* - A new line is added after the prepended content.
|
|
12337
|
+
*
|
|
12338
|
+
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12339
|
+
* The content of the last run add-in appears above previously prepended content.
|
|
12340
|
+
*
|
|
12341
|
+
* - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
|
|
12342
|
+
*
|
|
12343
|
+
* **Errors**:
|
|
12344
|
+
*
|
|
12345
|
+
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12346
|
+
*
|
|
12347
|
+
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12348
|
+
*
|
|
12349
|
+
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12350
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12351
|
+
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12352
|
+
*/
|
|
12353
|
+
prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12246
12354
|
/**
|
|
12247
12355
|
* Replaces the entire body with the specified text.
|
|
12248
12356
|
*
|
|
@@ -12787,6 +12895,90 @@ declare namespace Office {
|
|
|
12787
12895
|
*/
|
|
12788
12896
|
set(name: string, value: string): void;
|
|
12789
12897
|
}
|
|
12898
|
+
/**
|
|
12899
|
+
* The `DelayDeliveryTime` object enables you to manage the delayed delivery date and time of a message.
|
|
12900
|
+
*
|
|
12901
|
+
* @remarks
|
|
12902
|
+
* [Api set: Mailbox 1.13]
|
|
12903
|
+
*
|
|
12904
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12905
|
+
*
|
|
12906
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12907
|
+
*/
|
|
12908
|
+
interface DelayDeliveryTime {
|
|
12909
|
+
/**
|
|
12910
|
+
* Gets the delivery date and time of a message.
|
|
12911
|
+
*
|
|
12912
|
+
* @remarks
|
|
12913
|
+
* [Api set: Mailbox 1.13]
|
|
12914
|
+
*
|
|
12915
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12916
|
+
*
|
|
12917
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12918
|
+
*
|
|
12919
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12920
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12921
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12922
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
12923
|
+
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
12924
|
+
*/
|
|
12925
|
+
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
12926
|
+
/**
|
|
12927
|
+
* Gets the delivery date and time of a message.
|
|
12928
|
+
*
|
|
12929
|
+
* @remarks
|
|
12930
|
+
* [Api set: Mailbox 1.13]
|
|
12931
|
+
*
|
|
12932
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12933
|
+
*
|
|
12934
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12935
|
+
*
|
|
12936
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12937
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
12938
|
+
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
12939
|
+
*/
|
|
12940
|
+
getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
12941
|
+
/**
|
|
12942
|
+
* Sets the delivery date and time of a message.
|
|
12943
|
+
*
|
|
12944
|
+
* @remarks
|
|
12945
|
+
* [Api set: Mailbox 1.13]
|
|
12946
|
+
*
|
|
12947
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12948
|
+
*
|
|
12949
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12950
|
+
*
|
|
12951
|
+
* **Errors**:
|
|
12952
|
+
*
|
|
12953
|
+
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
12954
|
+
*
|
|
12955
|
+
* @param datetime - The future date and time when the message should be sent.
|
|
12956
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12957
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12958
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12959
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12960
|
+
*/
|
|
12961
|
+
setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12962
|
+
/**
|
|
12963
|
+
* Sets the delivery date and time of a message.
|
|
12964
|
+
*
|
|
12965
|
+
* @remarks
|
|
12966
|
+
* [Api set: Mailbox 1.13]
|
|
12967
|
+
*
|
|
12968
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12969
|
+
*
|
|
12970
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12971
|
+
*
|
|
12972
|
+
* **Errors**:
|
|
12973
|
+
*
|
|
12974
|
+
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
12975
|
+
*
|
|
12976
|
+
* @param datetime - The future date and time when the message should be sent.
|
|
12977
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12978
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12979
|
+
*/
|
|
12980
|
+
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12981
|
+
}
|
|
12790
12982
|
/**
|
|
12791
12983
|
* Provides diagnostic information to an Outlook add-in.
|
|
12792
12984
|
*
|
|
@@ -13389,7 +13581,7 @@ declare namespace Office {
|
|
|
13389
13581
|
* You can determine the type of the item by using the `itemType` property.
|
|
13390
13582
|
*
|
|
13391
13583
|
* To see the full member list, refer to the
|
|
13392
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13584
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13393
13585
|
*
|
|
13394
13586
|
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
13395
13587
|
*
|
|
@@ -13414,7 +13606,7 @@ declare namespace Office {
|
|
|
13414
13606
|
*
|
|
13415
13607
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13416
13608
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13417
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13609
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13418
13610
|
*
|
|
13419
13611
|
* Child interfaces:
|
|
13420
13612
|
*
|
|
@@ -13429,7 +13621,7 @@ declare namespace Office {
|
|
|
13429
13621
|
*
|
|
13430
13622
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13431
13623
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13432
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13624
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13433
13625
|
*
|
|
13434
13626
|
* Child interfaces:
|
|
13435
13627
|
*
|
|
@@ -13750,7 +13942,7 @@ declare namespace Office {
|
|
|
13750
13942
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13751
13943
|
*
|
|
13752
13944
|
* For supported events, refer to the Mailbox object model
|
|
13753
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13945
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
13754
13946
|
*
|
|
13755
13947
|
* @remarks
|
|
13756
13948
|
* [Api set: Mailbox 1.5]
|
|
@@ -13771,7 +13963,7 @@ declare namespace Office {
|
|
|
13771
13963
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13772
13964
|
*
|
|
13773
13965
|
* For supported events, refer to the Mailbox object model
|
|
13774
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13966
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
13775
13967
|
*
|
|
13776
13968
|
* @remarks
|
|
13777
13969
|
* [Api set: Mailbox 1.5]
|
|
@@ -14394,6 +14586,50 @@ declare namespace Office {
|
|
|
14394
14586
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
14395
14587
|
*/
|
|
14396
14588
|
getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
14589
|
+
/**
|
|
14590
|
+
* Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
|
|
14591
|
+
* To learn more about item multi-select, see
|
|
14592
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14593
|
+
*
|
|
14594
|
+
* @remarks
|
|
14595
|
+
* [Api set: Mailbox 1.13]
|
|
14596
|
+
*
|
|
14597
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14598
|
+
*
|
|
14599
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
14600
|
+
*
|
|
14601
|
+
* **Important**: This method only applies to messages.
|
|
14602
|
+
*
|
|
14603
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
14604
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14605
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14606
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14607
|
+
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14608
|
+
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14609
|
+
*/
|
|
14610
|
+
getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14611
|
+
/**
|
|
14612
|
+
* Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
|
|
14613
|
+
* To learn more about item multi-select, see
|
|
14614
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14615
|
+
*
|
|
14616
|
+
* @remarks
|
|
14617
|
+
* [Api set: Mailbox 1.13]
|
|
14618
|
+
*
|
|
14619
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14620
|
+
*
|
|
14621
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
14622
|
+
*
|
|
14623
|
+
* **Important**: This method only applies to messages.
|
|
14624
|
+
*
|
|
14625
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
14626
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14627
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14628
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14629
|
+
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14630
|
+
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14631
|
+
*/
|
|
14632
|
+
getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14397
14633
|
/**
|
|
14398
14634
|
* Gets a token identifying the user and the Office Add-in.
|
|
14399
14635
|
*
|
|
@@ -14479,7 +14715,7 @@ declare namespace Office {
|
|
|
14479
14715
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14480
14716
|
*
|
|
14481
14717
|
* For supported events, refer to the Mailbox object model
|
|
14482
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14718
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
14483
14719
|
*
|
|
14484
14720
|
* @remarks
|
|
14485
14721
|
* [Api set: Mailbox 1.5]
|
|
@@ -14498,7 +14734,7 @@ declare namespace Office {
|
|
|
14498
14734
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14499
14735
|
*
|
|
14500
14736
|
* For supported events, refer to the Mailbox object model
|
|
14501
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14737
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
14502
14738
|
*
|
|
14503
14739
|
* @remarks
|
|
14504
14740
|
* [Api set: Mailbox 1.5]
|
|
@@ -14690,7 +14926,7 @@ declare namespace Office {
|
|
|
14690
14926
|
*
|
|
14691
14927
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14692
14928
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14693
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14929
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
14694
14930
|
*
|
|
14695
14931
|
* Child interfaces:
|
|
14696
14932
|
*
|
|
@@ -14705,7 +14941,7 @@ declare namespace Office {
|
|
|
14705
14941
|
*
|
|
14706
14942
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14707
14943
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14708
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14944
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
14709
14945
|
*
|
|
14710
14946
|
* Parent interfaces:
|
|
14711
14947
|
*
|
|
@@ -14784,6 +15020,19 @@ declare namespace Office {
|
|
|
14784
15020
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14785
15021
|
*/
|
|
14786
15022
|
conversationId: string;
|
|
15023
|
+
/**
|
|
15024
|
+
* Gets or sets the delayed delivery date and time of a message.
|
|
15025
|
+
*
|
|
15026
|
+
* The `delayDeliveryTime` property returns a `DelayDeliveryTime` object that provides methods to manage the delivery date and time of the message.
|
|
15027
|
+
*
|
|
15028
|
+
* @remarks
|
|
15029
|
+
* [Api set: Mailbox 1.13]
|
|
15030
|
+
*
|
|
15031
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15032
|
+
*
|
|
15033
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15034
|
+
*/
|
|
15035
|
+
delayDeliveryTime: DelayDeliveryTime;
|
|
14787
15036
|
/**
|
|
14788
15037
|
* Gets the email address of the sender of a message.
|
|
14789
15038
|
*
|
|
@@ -14837,6 +15086,22 @@ declare namespace Office {
|
|
|
14837
15086
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14838
15087
|
*/
|
|
14839
15088
|
notificationMessages: NotificationMessages;
|
|
15089
|
+
/**
|
|
15090
|
+
* Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
|
|
15091
|
+
*
|
|
15092
|
+
* @remarks
|
|
15093
|
+
* [Api set: Mailbox 1.13]
|
|
15094
|
+
*
|
|
15095
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15096
|
+
*
|
|
15097
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15098
|
+
*
|
|
15099
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
15100
|
+
*
|
|
15101
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
15102
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
15103
|
+
*/
|
|
15104
|
+
sensitivityLabel: SensitivityLabel;
|
|
14840
15105
|
/**
|
|
14841
15106
|
* Gets the ID of the series that an instance belongs to.
|
|
14842
15107
|
*
|
|
@@ -15057,7 +15322,7 @@ declare namespace Office {
|
|
|
15057
15322
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15058
15323
|
*
|
|
15059
15324
|
* For supported events, refer to the Item object model
|
|
15060
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15325
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15061
15326
|
*
|
|
15062
15327
|
* @remarks
|
|
15063
15328
|
* [Api set: Mailbox 1.7]
|
|
@@ -15079,7 +15344,7 @@ declare namespace Office {
|
|
|
15079
15344
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15080
15345
|
*
|
|
15081
15346
|
* For supported events, refer to the Item object model
|
|
15082
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15347
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15083
15348
|
*
|
|
15084
15349
|
* @remarks
|
|
15085
15350
|
* [Api set: Mailbox 1.7]
|
|
@@ -15489,65 +15754,85 @@ declare namespace Office {
|
|
|
15489
15754
|
*/
|
|
15490
15755
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
15491
15756
|
/**
|
|
15492
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
15757
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15493
15758
|
*
|
|
15494
|
-
* For more information around using this API, see
|
|
15495
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
15496
|
-
*
|
|
15497
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15759
|
+
* For more information around using this API, see
|
|
15760
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
15498
15761
|
*
|
|
15499
15762
|
* @remarks
|
|
15500
|
-
* [Api set: Mailbox 1.8]
|
|
15763
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15764
|
+
*
|
|
15765
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15766
|
+
*
|
|
15767
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15768
|
+
*
|
|
15769
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15501
15770
|
*
|
|
15502
15771
|
* **Important**: In Message Compose mode, this API is not supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
15503
15772
|
*
|
|
15773
|
+
* a. **Delegate access/Shared folders**
|
|
15774
|
+
*
|
|
15504
15775
|
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15505
15776
|
*
|
|
15506
15777
|
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15507
15778
|
*
|
|
15508
15779
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15509
15780
|
*
|
|
15510
|
-
*
|
|
15511
|
-
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15781
|
+
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
15512
15782
|
*
|
|
15513
|
-
*
|
|
15783
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15514
15784
|
*
|
|
15515
|
-
* **
|
|
15785
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15786
|
+
*
|
|
15787
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15788
|
+
*
|
|
15789
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15790
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15516
15791
|
*
|
|
15517
15792
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15518
15793
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15519
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15520
|
-
*
|
|
15794
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15795
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15521
15796
|
*/
|
|
15522
15797
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15523
15798
|
/**
|
|
15524
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
15799
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15525
15800
|
*
|
|
15526
|
-
* For more information around using this API, see
|
|
15527
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
15528
|
-
*
|
|
15529
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15801
|
+
* For more information around using this API, see
|
|
15802
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
15530
15803
|
*
|
|
15531
15804
|
* @remarks
|
|
15532
|
-
* [Api set: Mailbox 1.8]
|
|
15805
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15806
|
+
*
|
|
15807
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15808
|
+
*
|
|
15809
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15810
|
+
*
|
|
15811
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15533
15812
|
*
|
|
15534
15813
|
* **Important**: In Message Compose mode, this API is not supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
15535
15814
|
*
|
|
15815
|
+
* a. **Delegate access/Shared folders**
|
|
15816
|
+
*
|
|
15536
15817
|
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15537
15818
|
*
|
|
15538
15819
|
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15539
15820
|
*
|
|
15540
15821
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15541
15822
|
*
|
|
15542
|
-
*
|
|
15543
|
-
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15823
|
+
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
15544
15824
|
*
|
|
15545
|
-
*
|
|
15825
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15546
15826
|
*
|
|
15547
|
-
* **
|
|
15827
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15548
15828
|
*
|
|
15549
|
-
*
|
|
15550
|
-
*
|
|
15829
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15830
|
+
*
|
|
15831
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15832
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15833
|
+
*
|
|
15834
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15835
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15551
15836
|
*/
|
|
15552
15837
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15553
15838
|
/**
|
|
@@ -15676,7 +15961,7 @@ declare namespace Office {
|
|
|
15676
15961
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15677
15962
|
*
|
|
15678
15963
|
* For supported events, refer to the Item object model
|
|
15679
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15964
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15680
15965
|
*
|
|
15681
15966
|
* @remarks
|
|
15682
15967
|
* [Api set: Mailbox 1.7]
|
|
@@ -15696,7 +15981,7 @@ declare namespace Office {
|
|
|
15696
15981
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15697
15982
|
*
|
|
15698
15983
|
* For supported events, refer to the Item object model
|
|
15699
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15984
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15700
15985
|
*
|
|
15701
15986
|
* @remarks
|
|
15702
15987
|
* [Api set: Mailbox 1.7]
|
|
@@ -15840,7 +16125,7 @@ declare namespace Office {
|
|
|
15840
16125
|
*
|
|
15841
16126
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15842
16127
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
15843
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16128
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
15844
16129
|
*
|
|
15845
16130
|
* Parent interfaces:
|
|
15846
16131
|
*
|
|
@@ -16211,7 +16496,7 @@ declare namespace Office {
|
|
|
16211
16496
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16212
16497
|
*
|
|
16213
16498
|
* For supported events, refer to the Item object model
|
|
16214
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16499
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16215
16500
|
*
|
|
16216
16501
|
* @remarks
|
|
16217
16502
|
* [Api set: Mailbox 1.7]
|
|
@@ -16233,7 +16518,7 @@ declare namespace Office {
|
|
|
16233
16518
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16234
16519
|
*
|
|
16235
16520
|
* For supported events, refer to the Item object model
|
|
16236
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16521
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16237
16522
|
*
|
|
16238
16523
|
* @remarks
|
|
16239
16524
|
* [Api set: Mailbox 1.7]
|
|
@@ -16741,43 +17026,43 @@ declare namespace Office {
|
|
|
16741
17026
|
*/
|
|
16742
17027
|
getSelectedRegExMatches(): any;
|
|
16743
17028
|
/**
|
|
16744
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
17029
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16745
17030
|
*
|
|
16746
|
-
* For more information around using this API, see
|
|
16747
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
16748
|
-
*
|
|
16749
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17031
|
+
* For more information around using this API, see
|
|
17032
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
16750
17033
|
*
|
|
16751
17034
|
* @remarks
|
|
16752
|
-
* [Api set: Mailbox 1.8]
|
|
17035
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16753
17036
|
*
|
|
16754
17037
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16755
17038
|
*
|
|
16756
17039
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16757
17040
|
*
|
|
17041
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17042
|
+
*
|
|
16758
17043
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16759
17044
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16760
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16761
|
-
*
|
|
17045
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17046
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16762
17047
|
*/
|
|
16763
17048
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16764
17049
|
/**
|
|
16765
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
17050
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16766
17051
|
*
|
|
16767
|
-
* For more information around using this API, see
|
|
16768
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
16769
|
-
*
|
|
16770
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17052
|
+
* For more information around using this API, see
|
|
17053
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
16771
17054
|
*
|
|
16772
17055
|
* @remarks
|
|
16773
|
-
* [Api set: Mailbox 1.8]
|
|
17056
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16774
17057
|
*
|
|
16775
17058
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16776
17059
|
*
|
|
16777
17060
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16778
17061
|
*
|
|
16779
|
-
*
|
|
16780
|
-
*
|
|
17062
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17063
|
+
*
|
|
17064
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17065
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16781
17066
|
*/
|
|
16782
17067
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16783
17068
|
/**
|
|
@@ -16810,7 +17095,7 @@ declare namespace Office {
|
|
|
16810
17095
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16811
17096
|
*
|
|
16812
17097
|
* For supported events, refer to the Item object model
|
|
16813
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17098
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16814
17099
|
*
|
|
16815
17100
|
* @remarks
|
|
16816
17101
|
* [Api set: Mailbox 1.7]
|
|
@@ -16830,7 +17115,7 @@ declare namespace Office {
|
|
|
16830
17115
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16831
17116
|
*
|
|
16832
17117
|
* For supported events, refer to the Item object model
|
|
16833
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17118
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16834
17119
|
*
|
|
16835
17120
|
* @remarks
|
|
16836
17121
|
* [Api set: Mailbox 1.7]
|
|
@@ -17921,6 +18206,283 @@ declare namespace Office {
|
|
|
17921
18206
|
*/
|
|
17922
18207
|
set(name: string, value: any): void;
|
|
17923
18208
|
}
|
|
18209
|
+
/**
|
|
18210
|
+
* Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
|
|
18211
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
|
|
18212
|
+
*
|
|
18213
|
+
* @remarks
|
|
18214
|
+
* [Api set: Mailbox 1.13]
|
|
18215
|
+
*
|
|
18216
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18217
|
+
*
|
|
18218
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18219
|
+
*
|
|
18220
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18221
|
+
*
|
|
18222
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18223
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18224
|
+
*/
|
|
18225
|
+
interface SensitivityLabel {
|
|
18226
|
+
/**
|
|
18227
|
+
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18228
|
+
*
|
|
18229
|
+
* @remarks
|
|
18230
|
+
* [Api set: Mailbox 1.13]
|
|
18231
|
+
*
|
|
18232
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18233
|
+
*
|
|
18234
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18235
|
+
*
|
|
18236
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18237
|
+
*
|
|
18238
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18239
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18240
|
+
*
|
|
18241
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18242
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18243
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18244
|
+
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18245
|
+
* `asyncResult.value` property.
|
|
18246
|
+
*/
|
|
18247
|
+
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18248
|
+
/**
|
|
18249
|
+
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18250
|
+
*
|
|
18251
|
+
* @remarks
|
|
18252
|
+
* [Api set: Mailbox 1.13]
|
|
18253
|
+
*
|
|
18254
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18255
|
+
*
|
|
18256
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18257
|
+
*
|
|
18258
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18259
|
+
*
|
|
18260
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18261
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18262
|
+
*
|
|
18263
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18264
|
+
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18265
|
+
* `asyncResult.value` property.
|
|
18266
|
+
*/
|
|
18267
|
+
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18268
|
+
/**
|
|
18269
|
+
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18270
|
+
*
|
|
18271
|
+
* @remarks
|
|
18272
|
+
* [Api set: Mailbox 1.13]
|
|
18273
|
+
*
|
|
18274
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18275
|
+
*
|
|
18276
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18277
|
+
*
|
|
18278
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18279
|
+
*
|
|
18280
|
+
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18281
|
+
*
|
|
18282
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18283
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18284
|
+
*
|
|
18285
|
+
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18286
|
+
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18287
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18288
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18289
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18290
|
+
* which is an `Office.AsyncResult` object.
|
|
18291
|
+
*/
|
|
18292
|
+
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18293
|
+
/**
|
|
18294
|
+
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18295
|
+
*
|
|
18296
|
+
* @remarks
|
|
18297
|
+
* [Api set: Mailbox 1.13]
|
|
18298
|
+
*
|
|
18299
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18300
|
+
*
|
|
18301
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18302
|
+
*
|
|
18303
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18304
|
+
*
|
|
18305
|
+
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18306
|
+
*
|
|
18307
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18308
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18309
|
+
*
|
|
18310
|
+
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18311
|
+
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18312
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18313
|
+
* which is an `Office.AsyncResult` object.
|
|
18314
|
+
*/
|
|
18315
|
+
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18316
|
+
}
|
|
18317
|
+
/**
|
|
18318
|
+
* Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the
|
|
18319
|
+
* `Office.EventType.SensitivityLabelChanged` event is raised.
|
|
18320
|
+
*
|
|
18321
|
+
* @remarks
|
|
18322
|
+
* [Api set: Mailbox 1.13]
|
|
18323
|
+
*
|
|
18324
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18325
|
+
*
|
|
18326
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18327
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18328
|
+
*/
|
|
18329
|
+
export interface SensitivityLabelChangedEventArgs {
|
|
18330
|
+
/**
|
|
18331
|
+
* The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
18332
|
+
*
|
|
18333
|
+
* @remarks
|
|
18334
|
+
* [Api set: Mailbox 1.13]
|
|
18335
|
+
*/
|
|
18336
|
+
type: "olkSensitivityLabelChanged";
|
|
18337
|
+
}
|
|
18338
|
+
/**
|
|
18339
|
+
* Represents the properties of available sensitivity labels in Outlook.
|
|
18340
|
+
*
|
|
18341
|
+
* @remarks
|
|
18342
|
+
* [Api set: Mailbox 1.13]
|
|
18343
|
+
*
|
|
18344
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18345
|
+
*
|
|
18346
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18347
|
+
*
|
|
18348
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18349
|
+
*
|
|
18350
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18351
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18352
|
+
*/
|
|
18353
|
+
interface SensitivityLabelDetails {
|
|
18354
|
+
/**
|
|
18355
|
+
* The color of the sensitivity label.
|
|
18356
|
+
*/
|
|
18357
|
+
color: string;
|
|
18358
|
+
/**
|
|
18359
|
+
* The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
|
|
18360
|
+
* Returns `null` if a label doesn't have any sublabels.
|
|
18361
|
+
*/
|
|
18362
|
+
children: SensitivityLabelDetails[];
|
|
18363
|
+
/**
|
|
18364
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
18365
|
+
*/
|
|
18366
|
+
id: string;
|
|
18367
|
+
/**
|
|
18368
|
+
* The name of the sensitivity label.
|
|
18369
|
+
*/
|
|
18370
|
+
name: string;
|
|
18371
|
+
/**
|
|
18372
|
+
* The description of the sensitivity label.
|
|
18373
|
+
*/
|
|
18374
|
+
tooltip: string;
|
|
18375
|
+
}
|
|
18376
|
+
/**
|
|
18377
|
+
* Provides methods to check the status of the catalog of {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | sensitivity labels}
|
|
18378
|
+
* in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
|
|
18379
|
+
*
|
|
18380
|
+
* @remarks
|
|
18381
|
+
* [Api set: Mailbox 1.13]
|
|
18382
|
+
*
|
|
18383
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18384
|
+
*
|
|
18385
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18386
|
+
*
|
|
18387
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18388
|
+
*
|
|
18389
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18390
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18391
|
+
*/
|
|
18392
|
+
export interface SensitivityLabelsCatalog {
|
|
18393
|
+
/**
|
|
18394
|
+
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18395
|
+
*
|
|
18396
|
+
* @remarks
|
|
18397
|
+
* [Api set: Mailbox 1.13]
|
|
18398
|
+
*
|
|
18399
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18400
|
+
*
|
|
18401
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18402
|
+
*
|
|
18403
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18404
|
+
*
|
|
18405
|
+
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18406
|
+
*
|
|
18407
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18408
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18409
|
+
*
|
|
18410
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18411
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18412
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18413
|
+
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18414
|
+
* `asyncResult.value` property.
|
|
18415
|
+
*/
|
|
18416
|
+
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18417
|
+
/**
|
|
18418
|
+
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18419
|
+
*
|
|
18420
|
+
* @remarks
|
|
18421
|
+
* [Api set: Mailbox 1.13]
|
|
18422
|
+
*
|
|
18423
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18424
|
+
*
|
|
18425
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18426
|
+
*
|
|
18427
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18428
|
+
*
|
|
18429
|
+
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18430
|
+
*
|
|
18431
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18432
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18433
|
+
*
|
|
18434
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18435
|
+
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18436
|
+
* `asyncResult.value` property.
|
|
18437
|
+
*/
|
|
18438
|
+
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18439
|
+
/**
|
|
18440
|
+
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18441
|
+
*
|
|
18442
|
+
* @remarks
|
|
18443
|
+
* [Api set: Mailbox 1.13]
|
|
18444
|
+
*
|
|
18445
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18446
|
+
*
|
|
18447
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18448
|
+
*
|
|
18449
|
+
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18450
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18451
|
+
*
|
|
18452
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18453
|
+
*
|
|
18454
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18455
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18456
|
+
*
|
|
18457
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18458
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18459
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18460
|
+
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18461
|
+
*/
|
|
18462
|
+
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18463
|
+
/**
|
|
18464
|
+
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18465
|
+
*
|
|
18466
|
+
* @remarks
|
|
18467
|
+
* [Api set: Mailbox 1.13]
|
|
18468
|
+
*
|
|
18469
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18470
|
+
*
|
|
18471
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18472
|
+
*
|
|
18473
|
+
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18474
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18475
|
+
*
|
|
18476
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18477
|
+
*
|
|
18478
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18479
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18480
|
+
*
|
|
18481
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18482
|
+
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18483
|
+
*/
|
|
18484
|
+
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18485
|
+
}
|
|
17924
18486
|
/**
|
|
17925
18487
|
* The `SeriesTime` object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times
|
|
17926
18488
|
* of meeting requests in a recurring series.
|
|
@@ -18238,13 +18800,13 @@ declare namespace Office {
|
|
|
18238
18800
|
setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18239
18801
|
}
|
|
18240
18802
|
/**
|
|
18241
|
-
* Represents the properties of an appointment or message in a shared folder.
|
|
18803
|
+
* Represents the properties of an appointment or message in a shared folder or shared mailbox.
|
|
18242
18804
|
*
|
|
18243
|
-
* For more information on how this object is used, see
|
|
18244
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
18805
|
+
* For more information on how this object is used, see
|
|
18806
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
18245
18807
|
*
|
|
18246
18808
|
* @remarks
|
|
18247
|
-
* [Api set: Mailbox 1.8]
|
|
18809
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
18248
18810
|
*
|
|
18249
18811
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18250
18812
|
*
|
|
@@ -18272,7 +18834,7 @@ declare namespace Office {
|
|
|
18272
18834
|
*/
|
|
18273
18835
|
targetMailbox: string;
|
|
18274
18836
|
/**
|
|
18275
|
-
* The permissions that the delegate has on a shared folder.
|
|
18837
|
+
* The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.
|
|
18276
18838
|
*/
|
|
18277
18839
|
delegatePermissions: MailboxEnums.DelegatePermissions;
|
|
18278
18840
|
}
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.326",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "2c3dcff7de23fbd7f636ba92a42fc86f69d57d663630bc1770793ec5a1ed7833",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|