@types/office-js 1.0.325 → 1.0.327
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 +680 -114
- 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: Tue, 30 May 2023 21:32:43 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.
|
|
@@ -1528,11 +1541,15 @@ declare namespace Office {
|
|
|
1528
1541
|
* @remarks
|
|
1529
1542
|
*
|
|
1530
1543
|
* **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1531
|
-
*
|
|
1544
|
+
*
|
|
1532
1545
|
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1533
|
-
*
|
|
1534
|
-
* **Important**: In Outlook, this API isn't supported
|
|
1535
|
-
*
|
|
1546
|
+
*
|
|
1547
|
+
* **Important**: In Outlook, this API isn't supported in the following scenarios.
|
|
1548
|
+
*
|
|
1549
|
+
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1550
|
+
*
|
|
1551
|
+
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
|
|
1552
|
+
*
|
|
1536
1553
|
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
|
|
1537
1554
|
* To retrieve an access token in older builds, use
|
|
1538
1555
|
* {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
|
|
@@ -2379,6 +2396,26 @@ declare namespace Office {
|
|
|
2379
2396
|
* Triggers when a Resource selection happens in Project.
|
|
2380
2397
|
*/
|
|
2381
2398
|
ResourceSelectionChanged,
|
|
2399
|
+
/**
|
|
2400
|
+
* Occurs in Outlook when one or more messages are selected or deselected.
|
|
2401
|
+
* **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
|
|
2402
|
+
*
|
|
2403
|
+
* To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
2404
|
+
*
|
|
2405
|
+
* [Api set: Mailbox 1.13]
|
|
2406
|
+
*/
|
|
2407
|
+
SelectedItemsChanged,
|
|
2408
|
+
/**
|
|
2409
|
+
* Occurs in Outlook when the sensitivity label of a message or appointment changes.
|
|
2410
|
+
* **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
|
|
2411
|
+
*
|
|
2412
|
+
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
2413
|
+
* The event handler receives an argument of type
|
|
2414
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs | Office.SensitivityLabelChangedEventArgs}.
|
|
2415
|
+
*
|
|
2416
|
+
* [Api set: Mailbox 1.13]
|
|
2417
|
+
*/
|
|
2418
|
+
SensitivityLabelChanged,
|
|
2382
2419
|
/**
|
|
2383
2420
|
* A Settings.settingsChanged event was raised.
|
|
2384
2421
|
*
|
|
@@ -9610,7 +9647,7 @@ declare namespace Office {
|
|
|
9610
9647
|
*
|
|
9611
9648
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9612
9649
|
* 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.
|
|
9650
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
9614
9651
|
*
|
|
9615
9652
|
* Child interfaces:
|
|
9616
9653
|
*
|
|
@@ -9625,7 +9662,7 @@ declare namespace Office {
|
|
|
9625
9662
|
*
|
|
9626
9663
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9627
9664
|
* 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.
|
|
9665
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
9629
9666
|
*
|
|
9630
9667
|
* Parent interfaces:
|
|
9631
9668
|
*
|
|
@@ -10010,7 +10047,7 @@ declare namespace Office {
|
|
|
10010
10047
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10011
10048
|
*
|
|
10012
10049
|
* For supported events, refer to the Item object model
|
|
10013
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10050
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10014
10051
|
*
|
|
10015
10052
|
* @remarks
|
|
10016
10053
|
* [Api set: Mailbox 1.7]
|
|
@@ -10032,7 +10069,7 @@ declare namespace Office {
|
|
|
10032
10069
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10033
10070
|
*
|
|
10034
10071
|
* For supported events, refer to the Item object model
|
|
10035
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10072
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10036
10073
|
*
|
|
10037
10074
|
* @remarks
|
|
10038
10075
|
* [Api set: Mailbox 1.7]
|
|
@@ -10404,45 +10441,43 @@ declare namespace Office {
|
|
|
10404
10441
|
*/
|
|
10405
10442
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
10406
10443
|
/**
|
|
10407
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
10408
|
-
*
|
|
10409
|
-
* For more information around using this API, see the
|
|
10410
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
10444
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10411
10445
|
*
|
|
10412
|
-
*
|
|
10446
|
+
* For more information around using this API, see
|
|
10447
|
+
* {@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
10448
|
*
|
|
10414
10449
|
* @remarks
|
|
10415
|
-
* [Api set: Mailbox 1.8]
|
|
10450
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10416
10451
|
*
|
|
10417
10452
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10418
10453
|
*
|
|
10419
10454
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10420
10455
|
*
|
|
10456
|
+
* *Note**: This method is not supported in Outlook on iOS or Android.
|
|
10457
|
+
*
|
|
10421
10458
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10422
10459
|
* `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.
|
|
10460
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10461
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10426
10462
|
*/
|
|
10427
10463
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10428
10464
|
/**
|
|
10429
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
10430
|
-
*
|
|
10431
|
-
* For more information around using this API, see the
|
|
10432
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
10465
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10433
10466
|
*
|
|
10434
|
-
*
|
|
10467
|
+
* For more information around using this API, see
|
|
10468
|
+
* {@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
10469
|
*
|
|
10436
10470
|
* @remarks
|
|
10437
|
-
* [Api set: Mailbox 1.8]
|
|
10471
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10438
10472
|
*
|
|
10439
10473
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10440
10474
|
*
|
|
10441
10475
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10442
10476
|
*
|
|
10443
|
-
*
|
|
10444
|
-
*
|
|
10445
|
-
*
|
|
10477
|
+
* *Note**: This method is not supported in Outlook on iOS or Android.
|
|
10478
|
+
*
|
|
10479
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10480
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10446
10481
|
*/
|
|
10447
10482
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10448
10483
|
/**
|
|
@@ -10571,7 +10606,7 @@ declare namespace Office {
|
|
|
10571
10606
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10572
10607
|
*
|
|
10573
10608
|
* For supported events, refer to the Item object model
|
|
10574
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10609
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10575
10610
|
*
|
|
10576
10611
|
* @remarks
|
|
10577
10612
|
* [Api set: Mailbox 1.7]
|
|
@@ -10591,7 +10626,7 @@ declare namespace Office {
|
|
|
10591
10626
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10592
10627
|
*
|
|
10593
10628
|
* For supported events, refer to the Item object model
|
|
10594
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10629
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
10595
10630
|
*
|
|
10596
10631
|
* @remarks
|
|
10597
10632
|
* [Api set: Mailbox 1.7]
|
|
@@ -10915,7 +10950,7 @@ declare namespace Office {
|
|
|
10915
10950
|
*
|
|
10916
10951
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
10917
10952
|
* 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.
|
|
10953
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
10919
10954
|
*
|
|
10920
10955
|
* Parent interfaces:
|
|
10921
10956
|
*
|
|
@@ -11235,7 +11270,7 @@ declare namespace Office {
|
|
|
11235
11270
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11236
11271
|
*
|
|
11237
11272
|
* For supported events, refer to the Item object model
|
|
11238
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11273
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11239
11274
|
*
|
|
11240
11275
|
* @remarks
|
|
11241
11276
|
* [Api set: Mailbox 1.7]
|
|
@@ -11257,7 +11292,7 @@ declare namespace Office {
|
|
|
11257
11292
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11258
11293
|
*
|
|
11259
11294
|
* For supported events, refer to the Item object model
|
|
11260
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11295
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11261
11296
|
*
|
|
11262
11297
|
* @remarks
|
|
11263
11298
|
* [Api set: Mailbox 1.7]
|
|
@@ -11722,45 +11757,43 @@ declare namespace Office {
|
|
|
11722
11757
|
*/
|
|
11723
11758
|
getSelectedRegExMatches(): any;
|
|
11724
11759
|
/**
|
|
11725
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
11760
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11726
11761
|
*
|
|
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.
|
|
11762
|
+
* For more information around using this API, see
|
|
11763
|
+
* {@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
11764
|
*
|
|
11732
11765
|
* @remarks
|
|
11733
|
-
* [Api set: Mailbox 1.8]
|
|
11766
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11734
11767
|
*
|
|
11735
11768
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11736
11769
|
*
|
|
11737
11770
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11738
11771
|
*
|
|
11772
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11773
|
+
*
|
|
11739
11774
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11740
11775
|
* `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.
|
|
11776
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11777
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11744
11778
|
*/
|
|
11745
11779
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11746
11780
|
/**
|
|
11747
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
11781
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11748
11782
|
*
|
|
11749
|
-
* For more information around using this API, see
|
|
11750
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
11751
|
-
*
|
|
11752
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11783
|
+
* For more information around using this API, see
|
|
11784
|
+
* {@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
11785
|
*
|
|
11754
11786
|
* @remarks
|
|
11755
|
-
* [Api set: Mailbox 1.8]
|
|
11787
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11756
11788
|
*
|
|
11757
11789
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11758
11790
|
*
|
|
11759
11791
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11760
11792
|
*
|
|
11761
|
-
*
|
|
11762
|
-
*
|
|
11763
|
-
*
|
|
11793
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11794
|
+
*
|
|
11795
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11796
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11764
11797
|
*/
|
|
11765
11798
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11766
11799
|
/**
|
|
@@ -11793,7 +11826,7 @@ declare namespace Office {
|
|
|
11793
11826
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11794
11827
|
*
|
|
11795
11828
|
* For supported events, refer to the Item object model
|
|
11796
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11829
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11797
11830
|
*
|
|
11798
11831
|
* @remarks
|
|
11799
11832
|
* [Api set: Mailbox 1.7]
|
|
@@ -11813,7 +11846,7 @@ declare namespace Office {
|
|
|
11813
11846
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11814
11847
|
*
|
|
11815
11848
|
* For supported events, refer to the Item object model
|
|
11816
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11849
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
11817
11850
|
*
|
|
11818
11851
|
* @remarks
|
|
11819
11852
|
* [Api set: Mailbox 1.7]
|
|
@@ -12243,6 +12276,85 @@ declare namespace Office {
|
|
|
12243
12276
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12244
12277
|
*/
|
|
12245
12278
|
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12279
|
+
/**
|
|
12280
|
+
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12281
|
+
*
|
|
12282
|
+
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12283
|
+
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12284
|
+
*
|
|
12285
|
+
* @remarks
|
|
12286
|
+
* [Api set: Mailbox 1.13]
|
|
12287
|
+
*
|
|
12288
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12289
|
+
*
|
|
12290
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12291
|
+
*
|
|
12292
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12293
|
+
*
|
|
12294
|
+
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12295
|
+
*
|
|
12296
|
+
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in},
|
|
12297
|
+
* the prepend-on-send feature runs first.
|
|
12298
|
+
*
|
|
12299
|
+
* - A new line is added after the prepended content.
|
|
12300
|
+
*
|
|
12301
|
+
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12302
|
+
* The content of the last run add-in appears above previously prepended content.
|
|
12303
|
+
*
|
|
12304
|
+
* - 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.
|
|
12305
|
+
*
|
|
12306
|
+
* **Errors**:
|
|
12307
|
+
*
|
|
12308
|
+
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12309
|
+
*
|
|
12310
|
+
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12311
|
+
*
|
|
12312
|
+
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12313
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12314
|
+
* `asyncContext`: Any object that can be accessed in the callback function.
|
|
12315
|
+
* `coercionType`: The desired format for the body. The string in the `data` parameter is converted to this format.
|
|
12316
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12317
|
+
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12318
|
+
*/
|
|
12319
|
+
prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12320
|
+
/**
|
|
12321
|
+
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12322
|
+
*
|
|
12323
|
+
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12324
|
+
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12325
|
+
*
|
|
12326
|
+
* @remarks
|
|
12327
|
+
* [Api set: Mailbox 1.13]
|
|
12328
|
+
*
|
|
12329
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12330
|
+
*
|
|
12331
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12332
|
+
*
|
|
12333
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12334
|
+
*
|
|
12335
|
+
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12336
|
+
*
|
|
12337
|
+
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in},
|
|
12338
|
+
* the prepend-on-send feature runs first.
|
|
12339
|
+
*
|
|
12340
|
+
* - A new line is added after the prepended content.
|
|
12341
|
+
*
|
|
12342
|
+
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12343
|
+
* The content of the last run add-in appears above previously prepended content.
|
|
12344
|
+
*
|
|
12345
|
+
* - 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.
|
|
12346
|
+
*
|
|
12347
|
+
* **Errors**:
|
|
12348
|
+
*
|
|
12349
|
+
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12350
|
+
*
|
|
12351
|
+
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12352
|
+
*
|
|
12353
|
+
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12354
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12355
|
+
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12356
|
+
*/
|
|
12357
|
+
prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12246
12358
|
/**
|
|
12247
12359
|
* Replaces the entire body with the specified text.
|
|
12248
12360
|
*
|
|
@@ -12787,6 +12899,90 @@ declare namespace Office {
|
|
|
12787
12899
|
*/
|
|
12788
12900
|
set(name: string, value: string): void;
|
|
12789
12901
|
}
|
|
12902
|
+
/**
|
|
12903
|
+
* The `DelayDeliveryTime` object enables you to manage the delayed delivery date and time of a message.
|
|
12904
|
+
*
|
|
12905
|
+
* @remarks
|
|
12906
|
+
* [Api set: Mailbox 1.13]
|
|
12907
|
+
*
|
|
12908
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12909
|
+
*
|
|
12910
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12911
|
+
*/
|
|
12912
|
+
interface DelayDeliveryTime {
|
|
12913
|
+
/**
|
|
12914
|
+
* Gets the delivery date and time of a message.
|
|
12915
|
+
*
|
|
12916
|
+
* @remarks
|
|
12917
|
+
* [Api set: Mailbox 1.13]
|
|
12918
|
+
*
|
|
12919
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12920
|
+
*
|
|
12921
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12922
|
+
*
|
|
12923
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12924
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12925
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12926
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
12927
|
+
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
12928
|
+
*/
|
|
12929
|
+
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
12930
|
+
/**
|
|
12931
|
+
* Gets the delivery date and time of a message.
|
|
12932
|
+
*
|
|
12933
|
+
* @remarks
|
|
12934
|
+
* [Api set: Mailbox 1.13]
|
|
12935
|
+
*
|
|
12936
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12937
|
+
*
|
|
12938
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12939
|
+
*
|
|
12940
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12941
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
12942
|
+
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
12943
|
+
*/
|
|
12944
|
+
getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
12945
|
+
/**
|
|
12946
|
+
* Sets the delivery date and time of a message.
|
|
12947
|
+
*
|
|
12948
|
+
* @remarks
|
|
12949
|
+
* [Api set: Mailbox 1.13]
|
|
12950
|
+
*
|
|
12951
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12952
|
+
*
|
|
12953
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12954
|
+
*
|
|
12955
|
+
* **Errors**:
|
|
12956
|
+
*
|
|
12957
|
+
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
12958
|
+
*
|
|
12959
|
+
* @param datetime - The future date and time when the message should be sent.
|
|
12960
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
12961
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12962
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12963
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12964
|
+
*/
|
|
12965
|
+
setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12966
|
+
/**
|
|
12967
|
+
* Sets the delivery date and time of a message.
|
|
12968
|
+
*
|
|
12969
|
+
* @remarks
|
|
12970
|
+
* [Api set: Mailbox 1.13]
|
|
12971
|
+
*
|
|
12972
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12973
|
+
*
|
|
12974
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12975
|
+
*
|
|
12976
|
+
* **Errors**:
|
|
12977
|
+
*
|
|
12978
|
+
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
12979
|
+
*
|
|
12980
|
+
* @param datetime - The future date and time when the message should be sent.
|
|
12981
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12982
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12983
|
+
*/
|
|
12984
|
+
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12985
|
+
}
|
|
12790
12986
|
/**
|
|
12791
12987
|
* Provides diagnostic information to an Outlook add-in.
|
|
12792
12988
|
*
|
|
@@ -13389,7 +13585,7 @@ declare namespace Office {
|
|
|
13389
13585
|
* You can determine the type of the item by using the `itemType` property.
|
|
13390
13586
|
*
|
|
13391
13587
|
* To see the full member list, refer to the
|
|
13392
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13588
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13393
13589
|
*
|
|
13394
13590
|
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
13395
13591
|
*
|
|
@@ -13414,7 +13610,7 @@ declare namespace Office {
|
|
|
13414
13610
|
*
|
|
13415
13611
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13416
13612
|
* 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.
|
|
13613
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13418
13614
|
*
|
|
13419
13615
|
* Child interfaces:
|
|
13420
13616
|
*
|
|
@@ -13429,7 +13625,7 @@ declare namespace Office {
|
|
|
13429
13625
|
*
|
|
13430
13626
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13431
13627
|
* 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.
|
|
13628
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
13433
13629
|
*
|
|
13434
13630
|
* Child interfaces:
|
|
13435
13631
|
*
|
|
@@ -13750,7 +13946,7 @@ declare namespace Office {
|
|
|
13750
13946
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13751
13947
|
*
|
|
13752
13948
|
* For supported events, refer to the Mailbox object model
|
|
13753
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13949
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
13754
13950
|
*
|
|
13755
13951
|
* @remarks
|
|
13756
13952
|
* [Api set: Mailbox 1.5]
|
|
@@ -13771,7 +13967,7 @@ declare namespace Office {
|
|
|
13771
13967
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13772
13968
|
*
|
|
13773
13969
|
* For supported events, refer to the Mailbox object model
|
|
13774
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13970
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
13775
13971
|
*
|
|
13776
13972
|
* @remarks
|
|
13777
13973
|
* [Api set: Mailbox 1.5]
|
|
@@ -14394,6 +14590,50 @@ declare namespace Office {
|
|
|
14394
14590
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
14395
14591
|
*/
|
|
14396
14592
|
getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
14593
|
+
/**
|
|
14594
|
+
* 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.
|
|
14595
|
+
* To learn more about item multi-select, see
|
|
14596
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14597
|
+
*
|
|
14598
|
+
* @remarks
|
|
14599
|
+
* [Api set: Mailbox 1.13]
|
|
14600
|
+
*
|
|
14601
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14602
|
+
*
|
|
14603
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
14604
|
+
*
|
|
14605
|
+
* **Important**: This method only applies to messages.
|
|
14606
|
+
*
|
|
14607
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
14608
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14609
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14610
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14611
|
+
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14612
|
+
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14613
|
+
*/
|
|
14614
|
+
getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14615
|
+
/**
|
|
14616
|
+
* 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.
|
|
14617
|
+
* To learn more about item multi-select, see
|
|
14618
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14619
|
+
*
|
|
14620
|
+
* @remarks
|
|
14621
|
+
* [Api set: Mailbox 1.13]
|
|
14622
|
+
*
|
|
14623
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14624
|
+
*
|
|
14625
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
14626
|
+
*
|
|
14627
|
+
* **Important**: This method only applies to messages.
|
|
14628
|
+
*
|
|
14629
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
14630
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14631
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14632
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14633
|
+
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14634
|
+
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14635
|
+
*/
|
|
14636
|
+
getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14397
14637
|
/**
|
|
14398
14638
|
* Gets a token identifying the user and the Office Add-in.
|
|
14399
14639
|
*
|
|
@@ -14479,7 +14719,7 @@ declare namespace Office {
|
|
|
14479
14719
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14480
14720
|
*
|
|
14481
14721
|
* For supported events, refer to the Mailbox object model
|
|
14482
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14722
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
14483
14723
|
*
|
|
14484
14724
|
* @remarks
|
|
14485
14725
|
* [Api set: Mailbox 1.5]
|
|
@@ -14498,7 +14738,7 @@ declare namespace Office {
|
|
|
14498
14738
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14499
14739
|
*
|
|
14500
14740
|
* For supported events, refer to the Mailbox object model
|
|
14501
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14741
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox#events | events section}.
|
|
14502
14742
|
*
|
|
14503
14743
|
* @remarks
|
|
14504
14744
|
* [Api set: Mailbox 1.5]
|
|
@@ -14690,7 +14930,7 @@ declare namespace Office {
|
|
|
14690
14930
|
*
|
|
14691
14931
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14692
14932
|
* 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.
|
|
14933
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
14694
14934
|
*
|
|
14695
14935
|
* Child interfaces:
|
|
14696
14936
|
*
|
|
@@ -14705,7 +14945,7 @@ declare namespace Office {
|
|
|
14705
14945
|
*
|
|
14706
14946
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14707
14947
|
* 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.
|
|
14948
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
14709
14949
|
*
|
|
14710
14950
|
* Parent interfaces:
|
|
14711
14951
|
*
|
|
@@ -14784,6 +15024,19 @@ declare namespace Office {
|
|
|
14784
15024
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14785
15025
|
*/
|
|
14786
15026
|
conversationId: string;
|
|
15027
|
+
/**
|
|
15028
|
+
* Gets or sets the delayed delivery date and time of a message.
|
|
15029
|
+
*
|
|
15030
|
+
* The `delayDeliveryTime` property returns a `DelayDeliveryTime` object that provides methods to manage the delivery date and time of the message.
|
|
15031
|
+
*
|
|
15032
|
+
* @remarks
|
|
15033
|
+
* [Api set: Mailbox 1.13]
|
|
15034
|
+
*
|
|
15035
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15036
|
+
*
|
|
15037
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15038
|
+
*/
|
|
15039
|
+
delayDeliveryTime: DelayDeliveryTime;
|
|
14787
15040
|
/**
|
|
14788
15041
|
* Gets the email address of the sender of a message.
|
|
14789
15042
|
*
|
|
@@ -14837,6 +15090,22 @@ declare namespace Office {
|
|
|
14837
15090
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14838
15091
|
*/
|
|
14839
15092
|
notificationMessages: NotificationMessages;
|
|
15093
|
+
/**
|
|
15094
|
+
* Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
|
|
15095
|
+
*
|
|
15096
|
+
* @remarks
|
|
15097
|
+
* [Api set: Mailbox 1.13]
|
|
15098
|
+
*
|
|
15099
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15100
|
+
*
|
|
15101
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15102
|
+
*
|
|
15103
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
15104
|
+
*
|
|
15105
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
15106
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
15107
|
+
*/
|
|
15108
|
+
sensitivityLabel: SensitivityLabel;
|
|
14840
15109
|
/**
|
|
14841
15110
|
* Gets the ID of the series that an instance belongs to.
|
|
14842
15111
|
*
|
|
@@ -15057,7 +15326,7 @@ declare namespace Office {
|
|
|
15057
15326
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15058
15327
|
*
|
|
15059
15328
|
* For supported events, refer to the Item object model
|
|
15060
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15329
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15061
15330
|
*
|
|
15062
15331
|
* @remarks
|
|
15063
15332
|
* [Api set: Mailbox 1.7]
|
|
@@ -15079,7 +15348,7 @@ declare namespace Office {
|
|
|
15079
15348
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15080
15349
|
*
|
|
15081
15350
|
* For supported events, refer to the Item object model
|
|
15082
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15351
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15083
15352
|
*
|
|
15084
15353
|
* @remarks
|
|
15085
15354
|
* [Api set: Mailbox 1.7]
|
|
@@ -15489,65 +15758,85 @@ declare namespace Office {
|
|
|
15489
15758
|
*/
|
|
15490
15759
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
15491
15760
|
/**
|
|
15492
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
15493
|
-
*
|
|
15494
|
-
* For more information around using this API, see the
|
|
15495
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
15761
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15496
15762
|
*
|
|
15497
|
-
*
|
|
15763
|
+
* For more information around using this API, see
|
|
15764
|
+
* {@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
15765
|
*
|
|
15499
15766
|
* @remarks
|
|
15500
|
-
* [Api set: Mailbox 1.8]
|
|
15767
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15768
|
+
*
|
|
15769
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15770
|
+
*
|
|
15771
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15772
|
+
*
|
|
15773
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15501
15774
|
*
|
|
15502
15775
|
* **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
15776
|
*
|
|
15777
|
+
* a. **Delegate access/Shared folders**
|
|
15778
|
+
*
|
|
15504
15779
|
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15505
15780
|
*
|
|
15506
15781
|
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15507
15782
|
*
|
|
15508
15783
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15509
15784
|
*
|
|
15510
|
-
*
|
|
15511
|
-
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15785
|
+
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
15512
15786
|
*
|
|
15513
|
-
*
|
|
15787
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15514
15788
|
*
|
|
15515
|
-
* **
|
|
15789
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15790
|
+
*
|
|
15791
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15792
|
+
*
|
|
15793
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15794
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15516
15795
|
*
|
|
15517
15796
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15518
15797
|
* `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
|
-
*
|
|
15798
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15799
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15521
15800
|
*/
|
|
15522
15801
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15523
15802
|
/**
|
|
15524
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
15803
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15525
15804
|
*
|
|
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.
|
|
15805
|
+
* For more information around using this API, see
|
|
15806
|
+
* {@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
15807
|
*
|
|
15531
15808
|
* @remarks
|
|
15532
|
-
* [Api set: Mailbox 1.8]
|
|
15809
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15810
|
+
*
|
|
15811
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15812
|
+
*
|
|
15813
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15814
|
+
*
|
|
15815
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15533
15816
|
*
|
|
15534
15817
|
* **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
15818
|
*
|
|
15819
|
+
* a. **Delegate access/Shared folders**
|
|
15820
|
+
*
|
|
15536
15821
|
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15537
15822
|
*
|
|
15538
15823
|
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15539
15824
|
*
|
|
15540
15825
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15541
15826
|
*
|
|
15542
|
-
*
|
|
15543
|
-
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15827
|
+
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
15544
15828
|
*
|
|
15545
|
-
*
|
|
15829
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15546
15830
|
*
|
|
15547
|
-
* **
|
|
15831
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15548
15832
|
*
|
|
15549
|
-
*
|
|
15550
|
-
*
|
|
15833
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15834
|
+
*
|
|
15835
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15836
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15837
|
+
*
|
|
15838
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15839
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15551
15840
|
*/
|
|
15552
15841
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15553
15842
|
/**
|
|
@@ -15676,7 +15965,7 @@ declare namespace Office {
|
|
|
15676
15965
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15677
15966
|
*
|
|
15678
15967
|
* For supported events, refer to the Item object model
|
|
15679
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15968
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15680
15969
|
*
|
|
15681
15970
|
* @remarks
|
|
15682
15971
|
* [Api set: Mailbox 1.7]
|
|
@@ -15696,7 +15985,7 @@ declare namespace Office {
|
|
|
15696
15985
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15697
15986
|
*
|
|
15698
15987
|
* For supported events, refer to the Item object model
|
|
15699
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15988
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
15700
15989
|
*
|
|
15701
15990
|
* @remarks
|
|
15702
15991
|
* [Api set: Mailbox 1.7]
|
|
@@ -15840,7 +16129,7 @@ declare namespace Office {
|
|
|
15840
16129
|
*
|
|
15841
16130
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15842
16131
|
* 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.
|
|
16132
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item | Object Model} page.
|
|
15844
16133
|
*
|
|
15845
16134
|
* Parent interfaces:
|
|
15846
16135
|
*
|
|
@@ -16211,7 +16500,7 @@ declare namespace Office {
|
|
|
16211
16500
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16212
16501
|
*
|
|
16213
16502
|
* For supported events, refer to the Item object model
|
|
16214
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16503
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16215
16504
|
*
|
|
16216
16505
|
* @remarks
|
|
16217
16506
|
* [Api set: Mailbox 1.7]
|
|
@@ -16233,7 +16522,7 @@ declare namespace Office {
|
|
|
16233
16522
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16234
16523
|
*
|
|
16235
16524
|
* For supported events, refer to the Item object model
|
|
16236
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16525
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16237
16526
|
*
|
|
16238
16527
|
* @remarks
|
|
16239
16528
|
* [Api set: Mailbox 1.7]
|
|
@@ -16741,43 +17030,43 @@ declare namespace Office {
|
|
|
16741
17030
|
*/
|
|
16742
17031
|
getSelectedRegExMatches(): any;
|
|
16743
17032
|
/**
|
|
16744
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
16745
|
-
*
|
|
16746
|
-
* For more information around using this API, see the
|
|
16747
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
17033
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16748
17034
|
*
|
|
16749
|
-
*
|
|
17035
|
+
* For more information around using this API, see
|
|
17036
|
+
* {@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
17037
|
*
|
|
16751
17038
|
* @remarks
|
|
16752
|
-
* [Api set: Mailbox 1.8]
|
|
17039
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16753
17040
|
*
|
|
16754
17041
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16755
17042
|
*
|
|
16756
17043
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16757
17044
|
*
|
|
17045
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17046
|
+
*
|
|
16758
17047
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16759
17048
|
* `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
|
-
*
|
|
17049
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17050
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16762
17051
|
*/
|
|
16763
17052
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16764
17053
|
/**
|
|
16765
|
-
* Gets the properties of an appointment or message in a shared folder.
|
|
17054
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16766
17055
|
*
|
|
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.
|
|
17056
|
+
* For more information around using this API, see
|
|
17057
|
+
* {@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
17058
|
*
|
|
16772
17059
|
* @remarks
|
|
16773
|
-
* [Api set: Mailbox 1.8]
|
|
17060
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16774
17061
|
*
|
|
16775
17062
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16776
17063
|
*
|
|
16777
17064
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16778
17065
|
*
|
|
16779
|
-
*
|
|
16780
|
-
*
|
|
17066
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17067
|
+
*
|
|
17068
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17069
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16781
17070
|
*/
|
|
16782
17071
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16783
17072
|
/**
|
|
@@ -16810,7 +17099,7 @@ declare namespace Office {
|
|
|
16810
17099
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16811
17100
|
*
|
|
16812
17101
|
* For supported events, refer to the Item object model
|
|
16813
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17102
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16814
17103
|
*
|
|
16815
17104
|
* @remarks
|
|
16816
17105
|
* [Api set: Mailbox 1.7]
|
|
@@ -16830,7 +17119,7 @@ declare namespace Office {
|
|
|
16830
17119
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16831
17120
|
*
|
|
16832
17121
|
* For supported events, refer to the Item object model
|
|
16833
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17122
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.13/office.context.mailbox.item#events | events section}.
|
|
16834
17123
|
*
|
|
16835
17124
|
* @remarks
|
|
16836
17125
|
* [Api set: Mailbox 1.7]
|
|
@@ -17921,6 +18210,283 @@ declare namespace Office {
|
|
|
17921
18210
|
*/
|
|
17922
18211
|
set(name: string, value: any): void;
|
|
17923
18212
|
}
|
|
18213
|
+
/**
|
|
18214
|
+
* Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
|
|
18215
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
|
|
18216
|
+
*
|
|
18217
|
+
* @remarks
|
|
18218
|
+
* [Api set: Mailbox 1.13]
|
|
18219
|
+
*
|
|
18220
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18221
|
+
*
|
|
18222
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18223
|
+
*
|
|
18224
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18225
|
+
*
|
|
18226
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18227
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18228
|
+
*/
|
|
18229
|
+
interface SensitivityLabel {
|
|
18230
|
+
/**
|
|
18231
|
+
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18232
|
+
*
|
|
18233
|
+
* @remarks
|
|
18234
|
+
* [Api set: Mailbox 1.13]
|
|
18235
|
+
*
|
|
18236
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18237
|
+
*
|
|
18238
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18239
|
+
*
|
|
18240
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18241
|
+
*
|
|
18242
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18243
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18244
|
+
*
|
|
18245
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18246
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18247
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18248
|
+
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18249
|
+
* `asyncResult.value` property.
|
|
18250
|
+
*/
|
|
18251
|
+
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18252
|
+
/**
|
|
18253
|
+
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18254
|
+
*
|
|
18255
|
+
* @remarks
|
|
18256
|
+
* [Api set: Mailbox 1.13]
|
|
18257
|
+
*
|
|
18258
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18259
|
+
*
|
|
18260
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18261
|
+
*
|
|
18262
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18263
|
+
*
|
|
18264
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18265
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18266
|
+
*
|
|
18267
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18268
|
+
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18269
|
+
* `asyncResult.value` property.
|
|
18270
|
+
*/
|
|
18271
|
+
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18272
|
+
/**
|
|
18273
|
+
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18274
|
+
*
|
|
18275
|
+
* @remarks
|
|
18276
|
+
* [Api set: Mailbox 1.13]
|
|
18277
|
+
*
|
|
18278
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18279
|
+
*
|
|
18280
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18281
|
+
*
|
|
18282
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18283
|
+
*
|
|
18284
|
+
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18285
|
+
*
|
|
18286
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18287
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18288
|
+
*
|
|
18289
|
+
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18290
|
+
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18291
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18292
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18293
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18294
|
+
* which is an `Office.AsyncResult` object.
|
|
18295
|
+
*/
|
|
18296
|
+
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18297
|
+
/**
|
|
18298
|
+
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18299
|
+
*
|
|
18300
|
+
* @remarks
|
|
18301
|
+
* [Api set: Mailbox 1.13]
|
|
18302
|
+
*
|
|
18303
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18304
|
+
*
|
|
18305
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18306
|
+
*
|
|
18307
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18308
|
+
*
|
|
18309
|
+
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18310
|
+
*
|
|
18311
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18312
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18313
|
+
*
|
|
18314
|
+
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18315
|
+
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18316
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18317
|
+
* which is an `Office.AsyncResult` object.
|
|
18318
|
+
*/
|
|
18319
|
+
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18320
|
+
}
|
|
18321
|
+
/**
|
|
18322
|
+
* Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the
|
|
18323
|
+
* `Office.EventType.SensitivityLabelChanged` event is raised.
|
|
18324
|
+
*
|
|
18325
|
+
* @remarks
|
|
18326
|
+
* [Api set: Mailbox 1.13]
|
|
18327
|
+
*
|
|
18328
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18329
|
+
*
|
|
18330
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18331
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18332
|
+
*/
|
|
18333
|
+
export interface SensitivityLabelChangedEventArgs {
|
|
18334
|
+
/**
|
|
18335
|
+
* The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
18336
|
+
*
|
|
18337
|
+
* @remarks
|
|
18338
|
+
* [Api set: Mailbox 1.13]
|
|
18339
|
+
*/
|
|
18340
|
+
type: "olkSensitivityLabelChanged";
|
|
18341
|
+
}
|
|
18342
|
+
/**
|
|
18343
|
+
* Represents the properties of available sensitivity labels in Outlook.
|
|
18344
|
+
*
|
|
18345
|
+
* @remarks
|
|
18346
|
+
* [Api set: Mailbox 1.13]
|
|
18347
|
+
*
|
|
18348
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18349
|
+
*
|
|
18350
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18351
|
+
*
|
|
18352
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18353
|
+
*
|
|
18354
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18355
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18356
|
+
*/
|
|
18357
|
+
interface SensitivityLabelDetails {
|
|
18358
|
+
/**
|
|
18359
|
+
* The color of the sensitivity label.
|
|
18360
|
+
*/
|
|
18361
|
+
color: string;
|
|
18362
|
+
/**
|
|
18363
|
+
* The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
|
|
18364
|
+
* Returns `null` if a label doesn't have any sublabels.
|
|
18365
|
+
*/
|
|
18366
|
+
children: SensitivityLabelDetails[];
|
|
18367
|
+
/**
|
|
18368
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
18369
|
+
*/
|
|
18370
|
+
id: string;
|
|
18371
|
+
/**
|
|
18372
|
+
* The name of the sensitivity label.
|
|
18373
|
+
*/
|
|
18374
|
+
name: string;
|
|
18375
|
+
/**
|
|
18376
|
+
* The description of the sensitivity label.
|
|
18377
|
+
*/
|
|
18378
|
+
tooltip: string;
|
|
18379
|
+
}
|
|
18380
|
+
/**
|
|
18381
|
+
* Provides methods to check the status of the catalog of {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | sensitivity labels}
|
|
18382
|
+
* in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
|
|
18383
|
+
*
|
|
18384
|
+
* @remarks
|
|
18385
|
+
* [Api set: Mailbox 1.13]
|
|
18386
|
+
*
|
|
18387
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18388
|
+
*
|
|
18389
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18390
|
+
*
|
|
18391
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18392
|
+
*
|
|
18393
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18394
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18395
|
+
*/
|
|
18396
|
+
export interface SensitivityLabelsCatalog {
|
|
18397
|
+
/**
|
|
18398
|
+
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18399
|
+
*
|
|
18400
|
+
* @remarks
|
|
18401
|
+
* [Api set: Mailbox 1.13]
|
|
18402
|
+
*
|
|
18403
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18404
|
+
*
|
|
18405
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18406
|
+
*
|
|
18407
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18408
|
+
*
|
|
18409
|
+
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18410
|
+
*
|
|
18411
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18412
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18413
|
+
*
|
|
18414
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18415
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18416
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18417
|
+
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18418
|
+
* `asyncResult.value` property.
|
|
18419
|
+
*/
|
|
18420
|
+
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18421
|
+
/**
|
|
18422
|
+
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18423
|
+
*
|
|
18424
|
+
* @remarks
|
|
18425
|
+
* [Api set: Mailbox 1.13]
|
|
18426
|
+
*
|
|
18427
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18428
|
+
*
|
|
18429
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18430
|
+
*
|
|
18431
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18432
|
+
*
|
|
18433
|
+
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18434
|
+
*
|
|
18435
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18436
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18437
|
+
*
|
|
18438
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18439
|
+
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18440
|
+
* `asyncResult.value` property.
|
|
18441
|
+
*/
|
|
18442
|
+
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18443
|
+
/**
|
|
18444
|
+
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18445
|
+
*
|
|
18446
|
+
* @remarks
|
|
18447
|
+
* [Api set: Mailbox 1.13]
|
|
18448
|
+
*
|
|
18449
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18450
|
+
*
|
|
18451
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18452
|
+
*
|
|
18453
|
+
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18454
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18455
|
+
*
|
|
18456
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18457
|
+
*
|
|
18458
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18459
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18460
|
+
*
|
|
18461
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
18462
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18463
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18464
|
+
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18465
|
+
*/
|
|
18466
|
+
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18467
|
+
/**
|
|
18468
|
+
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18469
|
+
*
|
|
18470
|
+
* @remarks
|
|
18471
|
+
* [Api set: Mailbox 1.13]
|
|
18472
|
+
*
|
|
18473
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18474
|
+
*
|
|
18475
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18476
|
+
*
|
|
18477
|
+
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18478
|
+
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18479
|
+
*
|
|
18480
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18481
|
+
*
|
|
18482
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18483
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18484
|
+
*
|
|
18485
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18486
|
+
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18487
|
+
*/
|
|
18488
|
+
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18489
|
+
}
|
|
17924
18490
|
/**
|
|
17925
18491
|
* 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
18492
|
* of meeting requests in a recurring series.
|
|
@@ -18238,13 +18804,13 @@ declare namespace Office {
|
|
|
18238
18804
|
setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18239
18805
|
}
|
|
18240
18806
|
/**
|
|
18241
|
-
* Represents the properties of an appointment or message in a shared folder.
|
|
18807
|
+
* Represents the properties of an appointment or message in a shared folder or shared mailbox.
|
|
18242
18808
|
*
|
|
18243
|
-
* For more information on how this object is used, see
|
|
18244
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access |
|
|
18809
|
+
* For more information on how this object is used, see
|
|
18810
|
+
* {@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
18811
|
*
|
|
18246
18812
|
* @remarks
|
|
18247
|
-
* [Api set: Mailbox 1.8]
|
|
18813
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
18248
18814
|
*
|
|
18249
18815
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18250
18816
|
*
|
|
@@ -18272,7 +18838,7 @@ declare namespace Office {
|
|
|
18272
18838
|
*/
|
|
18273
18839
|
targetMailbox: string;
|
|
18274
18840
|
/**
|
|
18275
|
-
* The permissions that the delegate has on a shared folder.
|
|
18841
|
+
* The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.
|
|
18276
18842
|
*/
|
|
18277
18843
|
delegatePermissions: MailboxEnums.DelegatePermissions;
|
|
18278
18844
|
}
|
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.327",
|
|
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": "89c2e43b323d6a4373c8b67d432ee5f89547a2f4a02178f079c818a1f58eeb95",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|