@types/office-js-preview 1.0.470 → 1.0.472
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +185 -239
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Mon, 20 May 2024 17:35:30 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -566,7 +566,8 @@ declare namespace Office {
|
|
|
566
566
|
ActiveViewChanged,
|
|
567
567
|
/**
|
|
568
568
|
* Occurs when any date or time of the selected appointment or series is changed in Outlook.
|
|
569
|
-
*
|
|
569
|
+
*
|
|
570
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
570
571
|
*
|
|
571
572
|
* To add an event handler for the `AppointmentTimeChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
572
573
|
* The event handler receives an argument of type
|
|
@@ -576,7 +577,9 @@ declare namespace Office {
|
|
|
576
577
|
*/
|
|
577
578
|
AppointmentTimeChanged,
|
|
578
579
|
/**
|
|
579
|
-
* Occurs when an attachment is added to or removed from an item.
|
|
580
|
+
* Occurs when an attachment is added to or removed from an item.
|
|
581
|
+
*
|
|
582
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
580
583
|
*
|
|
581
584
|
* To add an event handler for the `AttachmentsChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
582
585
|
* The event handler receives an argument of type
|
|
@@ -616,7 +619,9 @@ declare namespace Office {
|
|
|
616
619
|
*/
|
|
617
620
|
DocumentSelectionChanged,
|
|
618
621
|
/**
|
|
619
|
-
* Occurs when the appointment location is changed in Outlook.
|
|
622
|
+
* Occurs when the appointment location is changed in Outlook.
|
|
623
|
+
*
|
|
624
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
620
625
|
*
|
|
621
626
|
* To add an event handler for the `EnhancedLocationsChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
622
627
|
* The event handler receives an argument of type
|
|
@@ -630,7 +635,7 @@ declare namespace Office {
|
|
|
630
635
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.notificationmessagedetails#actions | custom action}.
|
|
631
636
|
* Currently, "Dismiss" is the only supported action that fires this event.
|
|
632
637
|
*
|
|
633
|
-
* **Important**: This event can only be handled in a task pane.
|
|
638
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
634
639
|
*
|
|
635
640
|
* To add an event handler for the `InfobarClicked` event, use the `addHandlerAsync` method of the `Item` object.
|
|
636
641
|
* The event handler receives an argument of type
|
|
@@ -641,7 +646,8 @@ declare namespace Office {
|
|
|
641
646
|
InfobarClicked,
|
|
642
647
|
/**
|
|
643
648
|
* Occurs when a different Outlook item is selected for viewing while the task pane is pinned.
|
|
644
|
-
*
|
|
649
|
+
*
|
|
650
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
645
651
|
*
|
|
646
652
|
* To add an event handler for the `ItemChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
647
653
|
*
|
|
@@ -661,20 +667,26 @@ declare namespace Office {
|
|
|
661
667
|
*/
|
|
662
668
|
NodeReplaced,
|
|
663
669
|
/**
|
|
664
|
-
* Occurs when the OfficeTheme is changed in Outlook.
|
|
670
|
+
* Occurs when the OfficeTheme is changed in Outlook.
|
|
665
671
|
*
|
|
666
672
|
* To add an event handler for the `OfficeThemeChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
667
673
|
* The event handler receives an argument of type
|
|
668
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.officethemechangedeventargs
|
|
674
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.officethemechangedeventargs | Office.OfficeThemeChangedEventArgs}.
|
|
669
675
|
*
|
|
670
|
-
*
|
|
676
|
+
* **Important**:
|
|
671
677
|
*
|
|
672
|
-
*
|
|
678
|
+
* - The `OfficeThemeChanged` event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
679
|
+
*
|
|
680
|
+
* - The `OfficeThemeChanged` event isn't supported in add-ins that implement
|
|
681
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
682
|
+
*
|
|
683
|
+
* [Api set: Mailbox 1.14]
|
|
673
684
|
*/
|
|
674
685
|
OfficeThemeChanged,
|
|
675
686
|
/**
|
|
676
687
|
* Occurs when the recipient list of the selected item or the appointment location is changed in Outlook.
|
|
677
|
-
*
|
|
688
|
+
*
|
|
689
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
678
690
|
*
|
|
679
691
|
* To add an event handler for the `RecipientsChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
680
692
|
* The event handler receives an argument of type
|
|
@@ -685,7 +697,8 @@ declare namespace Office {
|
|
|
685
697
|
RecipientsChanged,
|
|
686
698
|
/**
|
|
687
699
|
* Occurs when the recurrence pattern of the selected series is changed in Outlook.
|
|
688
|
-
*
|
|
700
|
+
*
|
|
701
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
689
702
|
*
|
|
690
703
|
* To add an event handler for the `RecurrenceChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
691
704
|
* The event handler receives an argument of type
|
|
@@ -700,8 +713,9 @@ declare namespace Office {
|
|
|
700
713
|
ResourceSelectionChanged,
|
|
701
714
|
/**
|
|
702
715
|
* Occurs in Outlook when one or more messages are selected or deselected.
|
|
703
|
-
*
|
|
704
|
-
*
|
|
716
|
+
*
|
|
717
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
718
|
+
*
|
|
705
719
|
* To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
706
720
|
*
|
|
707
721
|
* [Api set: Mailbox 1.13]
|
|
@@ -709,7 +723,8 @@ declare namespace Office {
|
|
|
709
723
|
SelectedItemsChanged,
|
|
710
724
|
/**
|
|
711
725
|
* Occurs in Outlook when the sensitivity label of a message or appointment changes.
|
|
712
|
-
*
|
|
726
|
+
*
|
|
727
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
713
728
|
*
|
|
714
729
|
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
715
730
|
* The event handler receives an argument of type
|
|
@@ -724,11 +739,9 @@ declare namespace Office {
|
|
|
724
739
|
SettingsChanged,
|
|
725
740
|
/**
|
|
726
741
|
* Occurs in Outlook when an unsolicited message is reported. The event handler receives an argument of type
|
|
727
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventargs
|
|
742
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventargs | Office.SpamReportingEventArgs}.
|
|
728
743
|
*
|
|
729
|
-
* [Api set: Mailbox
|
|
730
|
-
*
|
|
731
|
-
* @beta
|
|
744
|
+
* [Api set: Mailbox 1.14]
|
|
732
745
|
*/
|
|
733
746
|
SpamReporting,
|
|
734
747
|
/**
|
|
@@ -4676,13 +4689,13 @@ declare namespace Office {
|
|
|
4676
4689
|
*
|
|
4677
4690
|
* @remarks
|
|
4678
4691
|
*
|
|
4679
|
-
*
|
|
4692
|
+
* **Applications**: Outlook
|
|
4693
|
+
*
|
|
4694
|
+
* [Api set: Mailbox 1.14]
|
|
4680
4695
|
*
|
|
4681
4696
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
4682
4697
|
*
|
|
4683
4698
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
4684
|
-
*
|
|
4685
|
-
* @beta
|
|
4686
4699
|
*/
|
|
4687
4700
|
urls: Urls;
|
|
4688
4701
|
}
|
|
@@ -5344,7 +5357,7 @@ declare namespace Office {
|
|
|
5344
5357
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5345
5358
|
* In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
|
|
5346
5359
|
* @param options An object literal that contains the `asyncContext` property. Assign any object you wish to access in the callback function to the `asyncContext` property.
|
|
5347
|
-
* @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult object.
|
|
5360
|
+
* @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult` object.
|
|
5348
5361
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
|
|
5349
5362
|
*/
|
|
5350
5363
|
requestPermissionsAsync(permissions: Office.DevicePermissionType[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
@@ -5382,7 +5395,7 @@ declare namespace Office {
|
|
|
5382
5395
|
*
|
|
5383
5396
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5384
5397
|
* In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
|
|
5385
|
-
* @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult object.
|
|
5398
|
+
* @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult` object.
|
|
5386
5399
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
|
|
5387
5400
|
*/
|
|
5388
5401
|
requestPermissionsAsync(permissions: Office.DevicePermissionType[], callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
@@ -6991,8 +7004,8 @@ declare namespace Office {
|
|
|
6991
7004
|
* </tr>
|
|
6992
7005
|
* <tr>
|
|
6993
7006
|
* <td><strong>Outlook</strong></td>
|
|
6994
|
-
* <td>
|
|
6995
|
-
* <td>
|
|
7007
|
+
* <td>Supported\*</td>
|
|
7008
|
+
* <td>Supported\*</td>
|
|
6996
7009
|
* <td>Not available</td>
|
|
6997
7010
|
* <td>Not available</td>
|
|
6998
7011
|
* <td>Not available</td>
|
|
@@ -7014,6 +7027,10 @@ declare namespace Office {
|
|
|
7014
7027
|
* <td>Not available</td>
|
|
7015
7028
|
* </tr>
|
|
7016
7029
|
* </table>
|
|
7030
|
+
*
|
|
7031
|
+
* \* In Outlook, the Office theme API is supported starting in
|
|
7032
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
|
|
7033
|
+
* It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
7017
7034
|
*/
|
|
7018
7035
|
interface OfficeTheme {
|
|
7019
7036
|
/**
|
|
@@ -8613,13 +8630,11 @@ declare namespace Office {
|
|
|
8613
8630
|
*
|
|
8614
8631
|
* @remarks
|
|
8615
8632
|
*
|
|
8616
|
-
* [Api set: Mailbox
|
|
8633
|
+
* [Api set: Mailbox 1.14]
|
|
8617
8634
|
*
|
|
8618
8635
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8619
8636
|
*
|
|
8620
8637
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8621
|
-
*
|
|
8622
|
-
* @beta
|
|
8623
8638
|
*/
|
|
8624
8639
|
interface Urls {
|
|
8625
8640
|
/**
|
|
@@ -8627,7 +8642,7 @@ declare namespace Office {
|
|
|
8627
8642
|
*
|
|
8628
8643
|
* @remarks
|
|
8629
8644
|
*
|
|
8630
|
-
* [Api set: Mailbox
|
|
8645
|
+
* [Api set: Mailbox 1.14]
|
|
8631
8646
|
*
|
|
8632
8647
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8633
8648
|
*
|
|
@@ -8635,22 +8650,16 @@ declare namespace Office {
|
|
|
8635
8650
|
*
|
|
8636
8651
|
* **Important**:
|
|
8637
8652
|
*
|
|
8638
|
-
* -
|
|
8639
|
-
* Then, join the {@link https://insider.microsoft365.com/join/windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access
|
|
8640
|
-
* Office beta builds.
|
|
8641
|
-
*
|
|
8642
|
-
* - The URL returned points to the location of the JavaScript file that Outlook on Windows uses to handle event-based activation
|
|
8653
|
+
* - The URL that's returned points to the location of the JavaScript file that classic Outlook on Windows uses to handle event-based activation
|
|
8643
8654
|
* and integrated spam reporting. To learn more about these features, see
|
|
8644
8655
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Configure your Outlook add-in for event-based activation} and
|
|
8645
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in
|
|
8656
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
8646
8657
|
*
|
|
8647
8658
|
* - If your add-in uses the XML manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
|
|
8648
8659
|
* To learn more, see {@link https://learn.microsoft.com/javascript/api/manifest/override#override-element-for-runtime | Override element for Runtime}.
|
|
8649
8660
|
*
|
|
8650
8661
|
* - If your add-in uses the unified manifest for Microsoft 365, the URL returned matches the value of the `script` property in the
|
|
8651
8662
|
* "code" object.
|
|
8652
|
-
*
|
|
8653
|
-
* @beta
|
|
8654
8663
|
*/
|
|
8655
8664
|
javascriptRuntimeUrl: string;
|
|
8656
8665
|
}
|
|
@@ -8696,43 +8705,29 @@ declare namespace Office {
|
|
|
8696
8705
|
* Specifies the {@link Office.Sensitivity | sensitivity level} of an appointment.
|
|
8697
8706
|
*
|
|
8698
8707
|
* @remarks
|
|
8699
|
-
* [Api set: Mailbox
|
|
8708
|
+
* [Api set: Mailbox 1.14]
|
|
8700
8709
|
*
|
|
8701
8710
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8702
|
-
*
|
|
8703
|
-
* @beta
|
|
8704
8711
|
*/
|
|
8705
8712
|
enum AppointmentSensitivityType {
|
|
8706
8713
|
/**
|
|
8707
8714
|
* The item needs no special treatment.
|
|
8708
|
-
*
|
|
8709
|
-
* @remarks
|
|
8710
|
-
* [Api set: Mailbox preview]
|
|
8711
8715
|
*/
|
|
8712
8716
|
Normal = "normal",
|
|
8713
8717
|
/**
|
|
8714
8718
|
* Treat the item as personal.
|
|
8715
8719
|
*
|
|
8716
8720
|
* **Important**: The Personal sensitivity level is only supported in Outlook on Windows.
|
|
8717
|
-
*
|
|
8718
|
-
* @remarks
|
|
8719
|
-
* [Api set: Mailbox preview]
|
|
8720
8721
|
*/
|
|
8721
8722
|
Personal = "personal",
|
|
8722
8723
|
/**
|
|
8723
8724
|
* Treat the item as private.
|
|
8724
|
-
*
|
|
8725
|
-
* @remarks
|
|
8726
|
-
* [Api set: Mailbox preview]
|
|
8727
8725
|
*/
|
|
8728
8726
|
Private = "private",
|
|
8729
8727
|
/**
|
|
8730
8728
|
* Treat the item as confidential.
|
|
8731
8729
|
*
|
|
8732
8730
|
* **Important**: The Confidential sensitivity level is only supported in Outlook on Windows.
|
|
8733
|
-
*
|
|
8734
|
-
* @remarks
|
|
8735
|
-
* [Api set: Mailbox preview]
|
|
8736
8731
|
*/
|
|
8737
8732
|
Confidential = "confidential"
|
|
8738
8733
|
}
|
|
@@ -9277,22 +9272,20 @@ declare namespace Office {
|
|
|
9277
9272
|
* Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in.
|
|
9278
9273
|
*
|
|
9279
9274
|
* To learn more about the integrated spam-reporting feature, see
|
|
9280
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in
|
|
9275
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
9281
9276
|
*
|
|
9282
9277
|
* @remarks
|
|
9283
|
-
* [Api set: Mailbox
|
|
9278
|
+
* [Api set: Mailbox 1.14]
|
|
9284
9279
|
*
|
|
9285
9280
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
9286
9281
|
*
|
|
9287
9282
|
* **Important**: This enum can only be used to assign values to the
|
|
9288
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions
|
|
9283
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-moveitemto-member | moveItemTo}
|
|
9289
9284
|
* property of the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | event.completed}
|
|
9290
9285
|
* method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
|
|
9291
9286
|
* you must assign it different string values. For a list of supported string values, see
|
|
9292
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions
|
|
9287
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
|
|
9293
9288
|
* Office.SpamReportingEventCompletedOptions.postProcessingAction}.
|
|
9294
|
-
*
|
|
9295
|
-
* @beta
|
|
9296
9289
|
*/
|
|
9297
9290
|
enum MoveSpamItemTo {
|
|
9298
9291
|
/**
|
|
@@ -10020,18 +10013,14 @@ declare namespace Office {
|
|
|
10020
10013
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts}.
|
|
10021
10014
|
*
|
|
10022
10015
|
* @remarks
|
|
10023
|
-
* [Api set: Mailbox
|
|
10016
|
+
* [Api set: Mailbox 1.14]
|
|
10024
10017
|
*
|
|
10025
10018
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
10026
|
-
*
|
|
10027
|
-
* @beta
|
|
10028
10019
|
*/
|
|
10029
10020
|
enum SendModeOverride {
|
|
10030
10021
|
/**
|
|
10031
10022
|
* Provides the **Send Anyway** option in a Smart Alerts dialog when the mail item doesn't meet the conditions of the event-based add-in.
|
|
10032
10023
|
* To learn more, see the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#prompt-user | **prompt user** send mode option}.
|
|
10033
|
-
*
|
|
10034
|
-
* @beta
|
|
10035
10024
|
*/
|
|
10036
10025
|
PromptUser = "promptUser"
|
|
10037
10026
|
}
|
|
@@ -10287,15 +10276,13 @@ declare namespace Office {
|
|
|
10287
10276
|
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
10288
10277
|
*
|
|
10289
10278
|
* @remarks
|
|
10290
|
-
* [Api set: Mailbox
|
|
10279
|
+
* [Api set: Mailbox 1.14]
|
|
10291
10280
|
*
|
|
10292
10281
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10293
10282
|
*
|
|
10294
10283
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10295
10284
|
*
|
|
10296
|
-
* **Important**: Outlook on the web, Outlook on
|
|
10297
|
-
*
|
|
10298
|
-
* @beta
|
|
10285
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
10299
10286
|
*/
|
|
10300
10287
|
sensitivity: Sensitivity;
|
|
10301
10288
|
/**
|
|
@@ -11765,18 +11752,15 @@ declare namespace Office {
|
|
|
11765
11752
|
* Provides the sensitivity value of the appointment.
|
|
11766
11753
|
*
|
|
11767
11754
|
* @remarks
|
|
11768
|
-
* [Api set: Mailbox
|
|
11755
|
+
* [Api set: Mailbox 1.14]
|
|
11769
11756
|
*
|
|
11770
11757
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11771
11758
|
*
|
|
11772
11759
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11773
11760
|
*
|
|
11774
|
-
* **Important**: Outlook on the web, Outlook on
|
|
11775
|
-
*
|
|
11776
|
-
* @beta
|
|
11761
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
11777
11762
|
*/
|
|
11778
11763
|
sensitivity: MailboxEnums.AppointmentSensitivityType;
|
|
11779
|
-
|
|
11780
11764
|
/**
|
|
11781
11765
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11782
11766
|
*
|
|
@@ -15773,6 +15757,8 @@ declare namespace Office {
|
|
|
15773
15757
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
15774
15758
|
*
|
|
15775
15759
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15760
|
+
*
|
|
15761
|
+
* **Important**: Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15776
15762
|
*/
|
|
15777
15763
|
interface MailboxEvent {
|
|
15778
15764
|
/**
|
|
@@ -15785,6 +15771,12 @@ declare namespace Office {
|
|
|
15785
15771
|
*
|
|
15786
15772
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15787
15773
|
*
|
|
15774
|
+
* **Important**:
|
|
15775
|
+
*
|
|
15776
|
+
* - Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15777
|
+
*
|
|
15778
|
+
* - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12.
|
|
15779
|
+
*
|
|
15788
15780
|
* @param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event.
|
|
15789
15781
|
*/
|
|
15790
15782
|
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;
|
|
@@ -16115,20 +16107,13 @@ declare namespace Office {
|
|
|
16115
16107
|
* Gets the message ID of the original message being replied to by the current message.
|
|
16116
16108
|
*
|
|
16117
16109
|
* @remarks
|
|
16118
|
-
* [Api set: Mailbox
|
|
16110
|
+
* [Api set: Mailbox 1.14]
|
|
16119
16111
|
*
|
|
16120
16112
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16121
16113
|
*
|
|
16122
16114
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16123
16115
|
*
|
|
16124
|
-
* **Important**:
|
|
16125
|
-
*
|
|
16126
|
-
* - To preview the `inReplyTo` property, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
|
|
16127
|
-
* {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
|
|
16128
|
-
*
|
|
16129
|
-
* - In Outlook on Windows, the `inReplyTo` value is maintained on all replies regardless of changes made by the user, such as changing the subject in a reply.
|
|
16130
|
-
*
|
|
16131
|
-
* @beta
|
|
16116
|
+
* **Important**: In Outlook on Windows, the `inReplyTo` value is maintained on all replies regardless of changes made by the user, such as changing the subject in a reply.
|
|
16132
16117
|
*/
|
|
16133
16118
|
inReplyTo: string;
|
|
16134
16119
|
/**
|
|
@@ -16542,78 +16527,69 @@ declare namespace Office {
|
|
|
16542
16527
|
*
|
|
16543
16528
|
* **Important**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
|
|
16544
16529
|
* discard, or cancel even if no changes have occurred since the item was last saved.
|
|
16545
|
-
*
|
|
16530
|
+
*
|
|
16546
16531
|
* **Tip**: Use the
|
|
16547
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose
|
|
16532
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1) | closeAsync}
|
|
16548
16533
|
* method instead of the `close` method if you want your add-in to:
|
|
16549
|
-
*
|
|
16534
|
+
*
|
|
16550
16535
|
* - Automatically discard a message being composed without prompting the user with the save dialog.
|
|
16551
|
-
*
|
|
16536
|
+
*
|
|
16552
16537
|
* - Determine when a user cancels the save item dialog on a message being composed.
|
|
16553
|
-
*
|
|
16554
|
-
* - Close a reply in the Reading Pane or an existing draft from an Outlook desktop client.
|
|
16555
16538
|
*
|
|
16539
|
+
* - Close a reply in the Reading Pane or an existing draft from an Outlook desktop client.
|
|
16556
16540
|
*/
|
|
16557
16541
|
close(): void;
|
|
16558
16542
|
/**
|
|
16559
16543
|
* Closes the current message being composed with the option to discard unsaved changes.
|
|
16560
16544
|
* The message being composed can be a new message, reply, or an existing draft.
|
|
16561
|
-
*
|
|
16545
|
+
*
|
|
16562
16546
|
* @remarks
|
|
16563
|
-
* [Api set: Mailbox
|
|
16564
|
-
*
|
|
16547
|
+
* [Api set: Mailbox 1.14]
|
|
16548
|
+
*
|
|
16565
16549
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16566
16550
|
*
|
|
16567
16551
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16568
|
-
*
|
|
16569
|
-
* **Important**: The `closeAsync` method is in preview. It's only supported in Outlook on Windows at this time.
|
|
16570
|
-
*
|
|
16552
|
+
*
|
|
16571
16553
|
* **Errors**:
|
|
16572
|
-
*
|
|
16554
|
+
*
|
|
16573
16555
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog and the `discardItem` property isn't defined or is set to `false`.
|
|
16574
|
-
*
|
|
16556
|
+
*
|
|
16575
16557
|
* - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft and the `discardItem` property isn't defined or
|
|
16576
16558
|
* is set to `false`.
|
|
16577
|
-
*
|
|
16559
|
+
*
|
|
16578
16560
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16579
16561
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16580
16562
|
* `discardItem`: If `true`, the current message being composed is closed and unsaved changes are discarded. When the parameter isn't declared or is
|
|
16581
16563
|
* set to `false`, a save dialog appears prompting the user to save a draft, discard changes, or cancel the operation. This behavior occurs for new messages and replies
|
|
16582
16564
|
* popped out from the Reading Pane. If you want to close a reply in the Reading Pane or an existing draft, you must set `discardItem` to `true`. Otherwise, the call will
|
|
16583
16565
|
* return an error. For more information on the error, see the Remarks section.
|
|
16584
|
-
*
|
|
16566
|
+
*
|
|
16585
16567
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16586
16568
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16587
|
-
*
|
|
16588
|
-
* @beta
|
|
16589
16569
|
*/
|
|
16590
16570
|
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16591
16571
|
/**
|
|
16592
16572
|
* Closes the current new message being composed.
|
|
16593
|
-
*
|
|
16573
|
+
*
|
|
16594
16574
|
* The behavior on a new message being composed depends on whether the message contains any unsaved changes. If no changes have been made, the message is
|
|
16595
16575
|
* closed without a save dialog. On the other hand, if the message contains unsaved changes, a save dialog appears prompting the user to save a draft,
|
|
16596
16576
|
* discard changes, or cancel the operation.
|
|
16597
16577
|
*
|
|
16598
16578
|
* @remarks
|
|
16599
|
-
* [Api set: Mailbox
|
|
16600
|
-
*
|
|
16579
|
+
* [Api set: Mailbox 1.14]
|
|
16580
|
+
*
|
|
16601
16581
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16602
16582
|
*
|
|
16603
16583
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16604
|
-
*
|
|
16605
|
-
* **Important**: The `closeAsync` method is in preview. It's only supported in Outlook on Windows at this time.
|
|
16606
16584
|
*
|
|
16607
16585
|
* **Errors**:
|
|
16608
|
-
*
|
|
16586
|
+
*
|
|
16609
16587
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
|
|
16610
|
-
*
|
|
16588
|
+
*
|
|
16611
16589
|
* - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft.
|
|
16612
16590
|
*
|
|
16613
16591
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16614
16592
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16615
|
-
*
|
|
16616
|
-
* @beta
|
|
16617
16593
|
*/
|
|
16618
16594
|
closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16619
16595
|
/**
|
|
@@ -16818,15 +16794,12 @@ declare namespace Office {
|
|
|
16818
16794
|
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16819
16795
|
*
|
|
16820
16796
|
* @remarks
|
|
16821
|
-
* [Api set: Mailbox
|
|
16797
|
+
* [Api set: Mailbox 1.14]
|
|
16822
16798
|
*
|
|
16823
16799
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16824
16800
|
*
|
|
16825
16801
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16826
16802
|
*
|
|
16827
|
-
* **Important**: To preview the `getConversationIndexAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
|
|
16828
|
-
* {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
|
|
16829
|
-
*
|
|
16830
16803
|
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16831
16804
|
* to provide context for the current message being composed.
|
|
16832
16805
|
*
|
|
@@ -16835,31 +16808,24 @@ declare namespace Office {
|
|
|
16835
16808
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16836
16809
|
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16837
16810
|
* property.
|
|
16838
|
-
*
|
|
16839
|
-
* @beta
|
|
16840
16811
|
*/
|
|
16841
16812
|
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16842
16813
|
/**
|
|
16843
16814
|
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16844
16815
|
*
|
|
16845
16816
|
* @remarks
|
|
16846
|
-
* [Api set: Mailbox
|
|
16817
|
+
* [Api set: Mailbox 1.14]
|
|
16847
16818
|
*
|
|
16848
16819
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16849
16820
|
*
|
|
16850
16821
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16851
16822
|
*
|
|
16852
|
-
* **Important**: To preview the `getConversationIndexAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
|
|
16853
|
-
* {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
|
|
16854
|
-
*
|
|
16855
16823
|
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16856
16824
|
* to provide context for the current message being composed.
|
|
16857
16825
|
*
|
|
16858
16826
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16859
16827
|
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16860
16828
|
* property.
|
|
16861
|
-
*
|
|
16862
|
-
* @beta
|
|
16863
16829
|
*/
|
|
16864
16830
|
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16865
16831
|
/**
|
|
@@ -16900,7 +16866,7 @@ declare namespace Office {
|
|
|
16900
16866
|
* Gets the Exchange Web Services item class of the selected message.
|
|
16901
16867
|
*
|
|
16902
16868
|
* @remarks
|
|
16903
|
-
* [Api set: Mailbox
|
|
16869
|
+
* [Api set: Mailbox 1.14]
|
|
16904
16870
|
*
|
|
16905
16871
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16906
16872
|
*
|
|
@@ -16908,9 +16874,6 @@ declare namespace Office {
|
|
|
16908
16874
|
*
|
|
16909
16875
|
* **Important**:
|
|
16910
16876
|
*
|
|
16911
|
-
* To preview the `getItemClassAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
|
|
16912
|
-
* {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
|
|
16913
|
-
*
|
|
16914
16877
|
* The following table lists the default message classes.
|
|
16915
16878
|
*
|
|
16916
16879
|
* <table>
|
|
@@ -16948,15 +16911,13 @@ declare namespace Office {
|
|
|
16948
16911
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16949
16912
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16950
16913
|
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
16951
|
-
*
|
|
16952
|
-
* @beta
|
|
16953
16914
|
*/
|
|
16954
16915
|
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16955
16916
|
/**
|
|
16956
16917
|
* Gets the Exchange Web Services item class of the selected message.
|
|
16957
16918
|
*
|
|
16958
16919
|
* @remarks
|
|
16959
|
-
* [Api set: Mailbox
|
|
16920
|
+
* [Api set: Mailbox 1.14]
|
|
16960
16921
|
*
|
|
16961
16922
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16962
16923
|
*
|
|
@@ -16964,9 +16925,6 @@ declare namespace Office {
|
|
|
16964
16925
|
*
|
|
16965
16926
|
* **Important**:
|
|
16966
16927
|
*
|
|
16967
|
-
* To preview the `getItemClassAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
|
|
16968
|
-
* {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
|
|
16969
|
-
*
|
|
16970
16928
|
* The following table lists the default message classes.
|
|
16971
16929
|
*
|
|
16972
16930
|
* <table>
|
|
@@ -17002,8 +16960,6 @@ declare namespace Office {
|
|
|
17002
16960
|
*
|
|
17003
16961
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17004
16962
|
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
17005
|
-
*
|
|
17006
|
-
* @beta
|
|
17007
16963
|
*/
|
|
17008
16964
|
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17009
16965
|
/**
|
|
@@ -17877,7 +17833,6 @@ declare namespace Office {
|
|
|
17877
17833
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17878
17834
|
*/
|
|
17879
17835
|
to: EmailAddressDetails[];
|
|
17880
|
-
|
|
17881
17836
|
/**
|
|
17882
17837
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
17883
17838
|
*
|
|
@@ -18125,7 +18080,7 @@ declare namespace Office {
|
|
|
18125
18080
|
* Gets the current message in EML format encoded in Base64.
|
|
18126
18081
|
*
|
|
18127
18082
|
* @remarks
|
|
18128
|
-
* [Api set: Mailbox
|
|
18083
|
+
* [Api set: Mailbox 1.14]
|
|
18129
18084
|
*
|
|
18130
18085
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18131
18086
|
*
|
|
@@ -18136,15 +18091,13 @@ declare namespace Office {
|
|
|
18136
18091
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
18137
18092
|
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
18138
18093
|
* returned in the `asyncResult.error` property.
|
|
18139
|
-
*
|
|
18140
|
-
* @beta
|
|
18141
18094
|
*/
|
|
18142
18095
|
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18143
18096
|
/**
|
|
18144
18097
|
* Gets the current message in EML format encoded in Base64.
|
|
18145
18098
|
*
|
|
18146
18099
|
* @remarks
|
|
18147
|
-
* [Api set: Mailbox
|
|
18100
|
+
* [Api set: Mailbox 1.14]
|
|
18148
18101
|
*
|
|
18149
18102
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18150
18103
|
*
|
|
@@ -18153,8 +18106,6 @@ declare namespace Office {
|
|
|
18153
18106
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
18154
18107
|
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
18155
18108
|
* returned in the `asyncResult.error` property.
|
|
18156
|
-
*
|
|
18157
|
-
* @beta
|
|
18158
18109
|
*/
|
|
18159
18110
|
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18160
18111
|
/**
|
|
@@ -19006,27 +18957,21 @@ declare namespace Office {
|
|
|
19006
18957
|
* Provides the updated Office theme that raised the `Office.EventType.OfficeThemeChanged` event.
|
|
19007
18958
|
*
|
|
19008
18959
|
* @remarks
|
|
19009
|
-
* [Api set: Mailbox
|
|
19010
|
-
*
|
|
19011
|
-
* @beta
|
|
18960
|
+
* [Api set: Mailbox 1.14]
|
|
19012
18961
|
*/
|
|
19013
18962
|
export interface OfficeThemeChangedEventArgs {
|
|
19014
18963
|
/**
|
|
19015
18964
|
* Gets the updated Office theme.
|
|
19016
18965
|
*
|
|
19017
18966
|
* @remarks
|
|
19018
|
-
* [Api set: Mailbox
|
|
19019
|
-
*
|
|
19020
|
-
* @beta
|
|
18967
|
+
* [Api set: Mailbox 1.14]
|
|
19021
18968
|
*/
|
|
19022
18969
|
officeTheme: Office.OfficeTheme;
|
|
19023
18970
|
/**
|
|
19024
18971
|
* Gets the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
19025
18972
|
*
|
|
19026
18973
|
* @remarks
|
|
19027
|
-
* [Api set: Mailbox
|
|
19028
|
-
*
|
|
19029
|
-
* @beta
|
|
18974
|
+
* [Api set: Mailbox 1.14]
|
|
19030
18975
|
*/
|
|
19031
18976
|
type: "officeThemeChanged";
|
|
19032
18977
|
}
|
|
@@ -19873,46 +19818,77 @@ declare namespace Office {
|
|
|
19873
19818
|
* The identifier of the message conversation that contains the message that's currently selected.
|
|
19874
19819
|
*
|
|
19875
19820
|
* @remarks
|
|
19876
|
-
*
|
|
19877
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19821
|
+
* [Api set: Mailbox 1.14]
|
|
19878
19822
|
*
|
|
19879
|
-
* @
|
|
19823
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19824
|
+
*
|
|
19825
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19880
19826
|
*/
|
|
19881
19827
|
conversationId: string;
|
|
19882
19828
|
/**
|
|
19883
19829
|
* Returns `true` if the message that's currently selected contains an attachment.
|
|
19884
19830
|
*
|
|
19885
19831
|
* @remarks
|
|
19886
|
-
*
|
|
19887
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19832
|
+
* [Api set: Mailbox 1.14]
|
|
19888
19833
|
*
|
|
19889
|
-
* @
|
|
19834
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19835
|
+
*
|
|
19836
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19890
19837
|
*/
|
|
19891
19838
|
hasAttachment: boolean;
|
|
19892
19839
|
/**
|
|
19893
19840
|
* The internet message identifier of the message that's currently selected.
|
|
19894
19841
|
*
|
|
19895
19842
|
* @remarks
|
|
19896
|
-
*
|
|
19897
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19843
|
+
* [Api set: Mailbox 1.14]
|
|
19898
19844
|
*
|
|
19899
|
-
* @
|
|
19845
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19846
|
+
*
|
|
19847
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19900
19848
|
*/
|
|
19901
19849
|
internetMessageId: string;
|
|
19902
19850
|
/**
|
|
19903
19851
|
* The Exchange Web Services (EWS) item identifier of the message that's currently selected.
|
|
19852
|
+
*
|
|
19853
|
+
* @remarks
|
|
19854
|
+
* [Api set: Mailbox 1.13]
|
|
19855
|
+
*
|
|
19856
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19857
|
+
*
|
|
19858
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19904
19859
|
*/
|
|
19905
19860
|
itemId: string;
|
|
19906
19861
|
/**
|
|
19907
19862
|
* The Outlook mode (`Read` or `Compose`) of the message that's currently selected.
|
|
19863
|
+
*
|
|
19864
|
+
* @remarks
|
|
19865
|
+
* [Api set: Mailbox 1.13]
|
|
19866
|
+
*
|
|
19867
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19868
|
+
*
|
|
19869
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19908
19870
|
*/
|
|
19909
19871
|
itemMode: string;
|
|
19910
19872
|
/**
|
|
19911
19873
|
* The type of the item that's currently selected. `Message` is the only supported type at this time.
|
|
19874
|
+
*
|
|
19875
|
+
* @remarks
|
|
19876
|
+
* [Api set: Mailbox 1.13]
|
|
19877
|
+
*
|
|
19878
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19879
|
+
*
|
|
19880
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19912
19881
|
*/
|
|
19913
19882
|
itemType: MailboxEnums.ItemType | string;
|
|
19914
19883
|
/**
|
|
19915
19884
|
* The description that appears in the subject field of the message that's currently selected.
|
|
19885
|
+
*
|
|
19886
|
+
* @remarks
|
|
19887
|
+
* [Api set: Mailbox 1.13]
|
|
19888
|
+
*
|
|
19889
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19890
|
+
*
|
|
19891
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19916
19892
|
*/
|
|
19917
19893
|
subject: string;
|
|
19918
19894
|
}
|
|
@@ -19921,26 +19897,24 @@ declare namespace Office {
|
|
|
19921
19897
|
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
19922
19898
|
*
|
|
19923
19899
|
* @remarks
|
|
19924
|
-
* [Api set: Mailbox
|
|
19900
|
+
* [Api set: Mailbox 1.14]
|
|
19925
19901
|
*
|
|
19926
19902
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19927
19903
|
*
|
|
19928
19904
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19929
|
-
*
|
|
19930
|
-
* @beta
|
|
19931
19905
|
*/
|
|
19932
19906
|
interface Sensitivity {
|
|
19933
19907
|
/**
|
|
19934
19908
|
* Gets the sensitivity level of an appointment.
|
|
19935
19909
|
*
|
|
19936
19910
|
* @remarks
|
|
19937
|
-
* [Api set: Mailbox
|
|
19911
|
+
* [Api set: Mailbox 1.14]
|
|
19938
19912
|
*
|
|
19939
19913
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19940
19914
|
*
|
|
19941
19915
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19942
19916
|
*
|
|
19943
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19917
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19944
19918
|
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19945
19919
|
* is returned in the `asyncResult.value` property.
|
|
19946
19920
|
*
|
|
@@ -19948,41 +19922,37 @@ declare namespace Office {
|
|
|
19948
19922
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19949
19923
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19950
19924
|
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19951
|
-
*
|
|
19952
|
-
* @beta
|
|
19953
19925
|
*/
|
|
19954
19926
|
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19955
19927
|
/**
|
|
19956
19928
|
* Gets the sensitivity level of an appointment.
|
|
19957
19929
|
*
|
|
19958
19930
|
* @remarks
|
|
19959
|
-
* [Api set: Mailbox
|
|
19931
|
+
* [Api set: Mailbox 1.14]
|
|
19960
19932
|
*
|
|
19961
19933
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19962
19934
|
*
|
|
19963
19935
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19964
19936
|
*
|
|
19965
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19937
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19966
19938
|
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19967
19939
|
* is returned in the `asyncResult.value` property.
|
|
19968
19940
|
*
|
|
19969
19941
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19970
19942
|
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19971
|
-
*
|
|
19972
|
-
* @beta
|
|
19973
19943
|
*/
|
|
19974
19944
|
getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19975
19945
|
/**
|
|
19976
19946
|
* Sets the sensitivity level of an appointment.
|
|
19977
19947
|
*
|
|
19978
19948
|
* @remarks
|
|
19979
|
-
* [Api set: Mailbox
|
|
19949
|
+
* [Api set: Mailbox 1.14]
|
|
19980
19950
|
*
|
|
19981
19951
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
19982
19952
|
*
|
|
19983
19953
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19984
19954
|
*
|
|
19985
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19955
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19986
19956
|
*
|
|
19987
19957
|
* **Errors**:
|
|
19988
19958
|
*
|
|
@@ -19993,21 +19963,19 @@ declare namespace Office {
|
|
|
19993
19963
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19994
19964
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19995
19965
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
19996
|
-
*
|
|
19997
|
-
* @beta
|
|
19998
19966
|
*/
|
|
19999
19967
|
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
20000
19968
|
/**
|
|
20001
19969
|
* Sets the sensitivity level of an appointment.
|
|
20002
19970
|
*
|
|
20003
19971
|
* @remarks
|
|
20004
|
-
* [Api set: Mailbox
|
|
19972
|
+
* [Api set: Mailbox 1.14]
|
|
20005
19973
|
*
|
|
20006
19974
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
20007
19975
|
*
|
|
20008
19976
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20009
19977
|
*
|
|
20010
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19978
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
20011
19979
|
*
|
|
20012
19980
|
* **Errors**:
|
|
20013
19981
|
*
|
|
@@ -20016,8 +19984,6 @@ declare namespace Office {
|
|
|
20016
19984
|
* @param sensitivity - The sensitivity level as an enum or string.
|
|
20017
19985
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
20018
19986
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
20019
|
-
*
|
|
20020
|
-
* @beta
|
|
20021
19987
|
*/
|
|
20022
19988
|
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
20023
19989
|
}
|
|
@@ -20656,10 +20622,18 @@ declare namespace Office {
|
|
|
20656
20622
|
/**
|
|
20657
20623
|
* Specifies the behavior of a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in}
|
|
20658
20624
|
* when it completes processing an `OnMessageSend` or `OnAppointmentSend` event.
|
|
20625
|
+
*
|
|
20626
|
+
* @remarks
|
|
20627
|
+
*
|
|
20628
|
+
* [Api set: Mailbox 1.12]
|
|
20629
|
+
*
|
|
20630
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20631
|
+
*
|
|
20632
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20659
20633
|
*/
|
|
20660
20634
|
interface SmartAlertsEventCompletedOptions {
|
|
20661
20635
|
/**
|
|
20662
|
-
* When you use the {@link
|
|
20636
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler,
|
|
20663
20637
|
* this value indicates if the handled event should continue execution or be canceled.
|
|
20664
20638
|
* For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the sending of an item.
|
|
20665
20639
|
* For a complete sample, see the
|
|
@@ -20675,33 +20649,31 @@ declare namespace Office {
|
|
|
20675
20649
|
*/
|
|
20676
20650
|
allowEvent?: boolean;
|
|
20677
20651
|
/**
|
|
20678
|
-
* When you use the {@link
|
|
20652
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
20679
20653
|
* this property customizes the text of the **Don't Send** button in the Smart Alerts dialog. Custom text must be 20 characters or less.
|
|
20680
20654
|
*
|
|
20681
20655
|
* For an example, see the
|
|
20682
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional
|
|
20656
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20683
20657
|
*
|
|
20684
20658
|
* @remarks
|
|
20685
20659
|
*
|
|
20686
|
-
* [Api set: Mailbox
|
|
20660
|
+
* [Api set: Mailbox 1.14]
|
|
20687
20661
|
*
|
|
20688
20662
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20689
20663
|
*
|
|
20690
20664
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20691
|
-
*
|
|
20692
|
-
* @beta
|
|
20693
20665
|
*/
|
|
20694
20666
|
cancelLabel?: string;
|
|
20695
20667
|
/**
|
|
20696
|
-
* When you use the {@link
|
|
20668
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
20697
20669
|
* this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
|
|
20698
20670
|
*
|
|
20699
20671
|
* For an example, see the
|
|
20700
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional
|
|
20672
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20701
20673
|
*
|
|
20702
20674
|
* @remarks
|
|
20703
20675
|
*
|
|
20704
|
-
* [Api set: Mailbox
|
|
20676
|
+
* [Api set: Mailbox 1.14]
|
|
20705
20677
|
*
|
|
20706
20678
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20707
20679
|
*
|
|
@@ -20718,17 +20690,15 @@ declare namespace Office {
|
|
|
20718
20690
|
*
|
|
20719
20691
|
* If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
20720
20692
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
20721
|
-
*
|
|
20722
|
-
* @beta
|
|
20723
20693
|
*/
|
|
20724
20694
|
commandId?: string;
|
|
20725
20695
|
/**
|
|
20726
|
-
* When you use the {@link
|
|
20696
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
20727
20697
|
* this property specifies any JSON data passed to the add-in for processing when the **Don't Send** button is selected from the Smart Alerts dialog.
|
|
20728
20698
|
*
|
|
20729
20699
|
* @remarks
|
|
20730
20700
|
*
|
|
20731
|
-
* [Api set: Mailbox
|
|
20701
|
+
* [Api set: Mailbox 1.14]
|
|
20732
20702
|
*
|
|
20733
20703
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20734
20704
|
*
|
|
@@ -20745,12 +20715,10 @@ declare namespace Office {
|
|
|
20745
20715
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
20746
20716
|
* of your task pane. If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using
|
|
20747
20717
|
* `JSON.parse()` once you retrieve it.
|
|
20748
|
-
*
|
|
20749
|
-
* @beta
|
|
20750
20718
|
*/
|
|
20751
20719
|
contextData?: any;
|
|
20752
20720
|
/**
|
|
20753
|
-
* When you use the {@link
|
|
20721
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property
|
|
20754
20722
|
* to `false`, this property sets the error message displayed to the user. For an example, see the
|
|
20755
20723
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
20756
20724
|
*
|
|
@@ -20764,17 +20732,17 @@ declare namespace Office {
|
|
|
20764
20732
|
*/
|
|
20765
20733
|
errorMessage?: string;
|
|
20766
20734
|
/**
|
|
20767
|
-
* When you use the {@link
|
|
20735
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler
|
|
20768
20736
|
* and set its `allowEvent` property to `false`, this property overrides the
|
|
20769
20737
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
|
|
20770
20738
|
* specified in the manifest at runtime.
|
|
20771
20739
|
*
|
|
20772
20740
|
* For an example, see the
|
|
20773
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#override-the-send-mode-option-at-runtime-optional
|
|
20741
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#override-the-send-mode-option-at-runtime-optional | Smart Alerts walkthrough}.
|
|
20774
20742
|
*
|
|
20775
20743
|
* @remarks
|
|
20776
20744
|
*
|
|
20777
|
-
* [Api set: Mailbox
|
|
20745
|
+
* [Api set: Mailbox 1.14]
|
|
20778
20746
|
*
|
|
20779
20747
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20780
20748
|
*
|
|
@@ -20782,8 +20750,6 @@ declare namespace Office {
|
|
|
20782
20750
|
*
|
|
20783
20751
|
* **Important**: Currently, `sendModeOverride` can only be set to the
|
|
20784
20752
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#prompt-user | prompt user} option.
|
|
20785
|
-
*
|
|
20786
|
-
* @beta
|
|
20787
20753
|
*/
|
|
20788
20754
|
sendModeOverride?: MailboxEnums.SendModeOverride | string;
|
|
20789
20755
|
}
|
|
@@ -20791,76 +20757,66 @@ declare namespace Office {
|
|
|
20791
20757
|
* Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
|
|
20792
20758
|
*
|
|
20793
20759
|
* @remarks
|
|
20794
|
-
* [Api set: Mailbox
|
|
20795
|
-
*
|
|
20796
|
-
* @beta
|
|
20760
|
+
* [Api set: Mailbox 1.14]
|
|
20797
20761
|
*/
|
|
20798
20762
|
export interface SpamReportingEventArgs {
|
|
20799
20763
|
/**
|
|
20800
20764
|
* The text provided by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20801
20765
|
*
|
|
20802
20766
|
* @remarks
|
|
20803
|
-
* [Api set: Mailbox
|
|
20767
|
+
* [Api set: Mailbox 1.14]
|
|
20804
20768
|
*
|
|
20805
20769
|
* To add an optional text box to the preprocessing dialog of your spam-reporting add-in, you must configure the
|
|
20806
|
-
* {@link https://learn.microsoft.com/javascript/api/manifest/preprocessingdialog
|
|
20770
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/preprocessingdialog#child-elements | FreeTextLabel}
|
|
20807
20771
|
* element in the manifest of your add-in.
|
|
20808
20772
|
*
|
|
20809
20773
|
* To learn more about how to develop a spam-reporting add-in, see
|
|
20810
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in
|
|
20811
|
-
*
|
|
20812
|
-
* @beta
|
|
20774
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20813
20775
|
*/
|
|
20814
20776
|
freeText: string;
|
|
20815
20777
|
/**
|
|
20816
20778
|
* Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20817
20779
|
*
|
|
20818
20780
|
* @remarks
|
|
20819
|
-
* [Api set: Mailbox
|
|
20781
|
+
* [Api set: Mailbox 1.14]
|
|
20820
20782
|
*
|
|
20821
20783
|
* The order of the booleans in the array corresponds to the order of the reporting options specified in the
|
|
20822
|
-
* {@link https://learn.microsoft.com/javascript/api/manifest/reportingoptions
|
|
20784
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/reportingoptions | ReportingOptions}
|
|
20823
20785
|
* element of your add-in's manifest.
|
|
20824
20786
|
*
|
|
20825
20787
|
* To learn more about how to develop a spam-reporting add-in, see
|
|
20826
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in
|
|
20827
|
-
*
|
|
20828
|
-
* @beta
|
|
20788
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20829
20789
|
*/
|
|
20830
20790
|
options: boolean[];
|
|
20831
20791
|
/**
|
|
20832
20792
|
* The type of event that was raised. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
20833
20793
|
*
|
|
20834
20794
|
* @remarks
|
|
20835
|
-
* [Api set: Mailbox
|
|
20836
|
-
*
|
|
20837
|
-
* @beta
|
|
20795
|
+
* [Api set: Mailbox 1.14]
|
|
20838
20796
|
*/
|
|
20839
20797
|
type: "SpamReporting";
|
|
20840
20798
|
}
|
|
20841
20799
|
/**
|
|
20842
20800
|
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting add-in}
|
|
20843
20801
|
* after it completes processing a
|
|
20844
|
-
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype
|
|
20802
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | SpamReporting} event.
|
|
20845
20803
|
*
|
|
20846
20804
|
* @remarks
|
|
20847
20805
|
*
|
|
20848
|
-
* [Api set: Mailbox
|
|
20806
|
+
* [Api set: Mailbox 1.14]
|
|
20849
20807
|
*
|
|
20850
20808
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
20851
20809
|
*
|
|
20852
20810
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20853
|
-
*
|
|
20854
|
-
* @beta
|
|
20855
20811
|
*/
|
|
20856
20812
|
interface SpamReportingEventCompletedOptions {
|
|
20857
20813
|
/**
|
|
20858
|
-
* When you use the {@link
|
|
20814
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
20859
20815
|
* this property specifies the Outlook mailbox folder to which the message will be moved.
|
|
20860
20816
|
*
|
|
20861
20817
|
* @remarks
|
|
20862
20818
|
*
|
|
20863
|
-
* [Api set: Mailbox
|
|
20819
|
+
* [Api set: Mailbox 1.14]
|
|
20864
20820
|
*
|
|
20865
20821
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20866
20822
|
*
|
|
@@ -20871,19 +20827,17 @@ declare namespace Office {
|
|
|
20871
20827
|
* - If the specified folder doesn't exist yet, it will be created before the message is moved.
|
|
20872
20828
|
*
|
|
20873
20829
|
* - If the `postProcessingAction` property is set to `moveToCustomFolder`, the `folderName` property must be specified.
|
|
20874
|
-
* Otherwise, the reported message is moved to the Junk Email folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
|
|
20830
|
+
* Otherwise, the reported message is moved to the **Junk Email** folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
|
|
20875
20831
|
* the `folderName` property is ignored.
|
|
20876
|
-
*
|
|
20877
|
-
* @beta
|
|
20878
20832
|
*/
|
|
20879
20833
|
folderName?: string;
|
|
20880
20834
|
/**
|
|
20881
|
-
* When you use the {@link
|
|
20835
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
20882
20836
|
* this property specifies whether the message is moved to a different folder in the mailbox.
|
|
20883
20837
|
*
|
|
20884
20838
|
* @remarks
|
|
20885
20839
|
*
|
|
20886
|
-
* [Api set: Mailbox
|
|
20840
|
+
* [Api set: Mailbox 1.14]
|
|
20887
20841
|
*
|
|
20888
20842
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20889
20843
|
*
|
|
@@ -20898,28 +20852,24 @@ declare namespace Office {
|
|
|
20898
20852
|
* - If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
20899
20853
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
20900
20854
|
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
20901
|
-
*
|
|
20902
|
-
* @beta
|
|
20903
20855
|
*/
|
|
20904
20856
|
moveItemTo?: MailboxEnums.MoveSpamItemTo;
|
|
20905
20857
|
/**
|
|
20906
20858
|
* When set to `true`, deletes a reported message if an error occurs while the message is processed.
|
|
20907
|
-
* If this property is set to `false` or isn't specified in the {@link
|
|
20859
|
+
* If this property is set to `false` or isn't specified in the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method},
|
|
20908
20860
|
* the reported message remains in its current mailbox folder.
|
|
20909
20861
|
*
|
|
20910
20862
|
* @remarks
|
|
20911
20863
|
*
|
|
20912
|
-
* [Api set: Mailbox
|
|
20864
|
+
* [Api set: Mailbox 1.14]
|
|
20913
20865
|
*
|
|
20914
20866
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20915
20867
|
*
|
|
20916
20868
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20917
|
-
*
|
|
20918
|
-
* @beta
|
|
20919
20869
|
*/
|
|
20920
20870
|
onErrorDeleteItem?: boolean;
|
|
20921
20871
|
/**
|
|
20922
|
-
* When you use the {@link
|
|
20872
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
20923
20873
|
* this property specifies whether the message is moved to a different folder in the mailbox. The following post-processing actions are available.
|
|
20924
20874
|
*
|
|
20925
20875
|
* - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
|
|
@@ -20932,7 +20882,7 @@ declare namespace Office {
|
|
|
20932
20882
|
*
|
|
20933
20883
|
* @remarks
|
|
20934
20884
|
*
|
|
20935
|
-
* [Api set: Mailbox
|
|
20885
|
+
* [Api set: Mailbox 1.14]
|
|
20936
20886
|
*
|
|
20937
20887
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20938
20888
|
*
|
|
@@ -20948,18 +20898,16 @@ declare namespace Office {
|
|
|
20948
20898
|
* - If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
20949
20899
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
20950
20900
|
* `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
|
|
20951
|
-
*
|
|
20952
|
-
* @beta
|
|
20953
20901
|
*/
|
|
20954
20902
|
postProcessingAction?: string;
|
|
20955
20903
|
/**
|
|
20956
|
-
* When you use the {@link
|
|
20904
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
20957
20905
|
* this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property must contain a title and a description.
|
|
20958
20906
|
* If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
|
|
20959
20907
|
*
|
|
20960
20908
|
* @remarks
|
|
20961
20909
|
*
|
|
20962
|
-
* [Api set: Mailbox
|
|
20910
|
+
* [Api set: Mailbox 1.14]
|
|
20963
20911
|
*
|
|
20964
20912
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20965
20913
|
*
|
|
@@ -20969,9 +20917,7 @@ declare namespace Office {
|
|
|
20969
20917
|
* reported message. This applies even if `showPostProcessingDialog` is configured. However, depending on how you configured the `moveItemTo` property in the
|
|
20970
20918
|
* `event.completed` call, a notification is shown to signal when the reported message is deleted or moved to another folder in the mailbox. To learn more, see
|
|
20971
20919
|
* the "Review feature behavior and limitations" section of
|
|
20972
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#review-feature-behavior-and-limitations | Implement an integrated spam-reporting add-in
|
|
20973
|
-
*
|
|
20974
|
-
* @beta
|
|
20920
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#review-feature-behavior-and-limitations | Implement an integrated spam-reporting add-in}.
|
|
20975
20921
|
*/
|
|
20976
20922
|
showPostProcessingDialog?: object;
|
|
20977
20923
|
}
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.472",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "2ddec6bd89648c1df0eabaf13eb77b0f6ef6534cf0cad2d4381fea0dd63fa848",
|
|
49
49
|
"typeScriptVersion": "4.7",
|
|
50
50
|
"nonNpm": true
|
|
51
51
|
}
|