@types/office-js-preview 1.0.471 → 1.0.473
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 +193 -237
- 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: Fri, 24 May 2024 21:35:52 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,20 @@ declare namespace Office {
|
|
|
4676
4689
|
*
|
|
4677
4690
|
* @remarks
|
|
4678
4691
|
*
|
|
4679
|
-
*
|
|
4692
|
+
* **Applications**: Outlook on the web and on Windows (classic and new clients)
|
|
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
4699
|
*
|
|
4685
|
-
*
|
|
4700
|
+
* **Important**:
|
|
4701
|
+
*
|
|
4702
|
+
* - In Outlook on the web and new Outlook on Windows, this API isn't supported in add-ins that implement a task pane. On these clients,
|
|
4703
|
+
* the API is only supported in add-ins that implement event-based activation or integrated spam reporting.
|
|
4704
|
+
*
|
|
4705
|
+
* - In classic Outlook on Windows, this API is supported in add-ins that implement a task pane, event-based activation, or integrated spam reporting.
|
|
4686
4706
|
*/
|
|
4687
4707
|
urls: Urls;
|
|
4688
4708
|
}
|
|
@@ -6991,8 +7011,8 @@ declare namespace Office {
|
|
|
6991
7011
|
* </tr>
|
|
6992
7012
|
* <tr>
|
|
6993
7013
|
* <td><strong>Outlook</strong></td>
|
|
6994
|
-
* <td>
|
|
6995
|
-
* <td>
|
|
7014
|
+
* <td>Supported\*</td>
|
|
7015
|
+
* <td>Supported\*</td>
|
|
6996
7016
|
* <td>Not available</td>
|
|
6997
7017
|
* <td>Not available</td>
|
|
6998
7018
|
* <td>Not available</td>
|
|
@@ -7014,6 +7034,10 @@ declare namespace Office {
|
|
|
7014
7034
|
* <td>Not available</td>
|
|
7015
7035
|
* </tr>
|
|
7016
7036
|
* </table>
|
|
7037
|
+
*
|
|
7038
|
+
* \* In Outlook, the Office theme API is supported starting in
|
|
7039
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
|
|
7040
|
+
* 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
7041
|
*/
|
|
7018
7042
|
interface OfficeTheme {
|
|
7019
7043
|
/**
|
|
@@ -8613,13 +8637,11 @@ declare namespace Office {
|
|
|
8613
8637
|
*
|
|
8614
8638
|
* @remarks
|
|
8615
8639
|
*
|
|
8616
|
-
* [Api set: Mailbox
|
|
8640
|
+
* [Api set: Mailbox 1.14]
|
|
8617
8641
|
*
|
|
8618
8642
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8619
8643
|
*
|
|
8620
8644
|
* **{@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
8645
|
*/
|
|
8624
8646
|
interface Urls {
|
|
8625
8647
|
/**
|
|
@@ -8627,7 +8649,7 @@ declare namespace Office {
|
|
|
8627
8649
|
*
|
|
8628
8650
|
* @remarks
|
|
8629
8651
|
*
|
|
8630
|
-
* [Api set: Mailbox
|
|
8652
|
+
* [Api set: Mailbox 1.14]
|
|
8631
8653
|
*
|
|
8632
8654
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8633
8655
|
*
|
|
@@ -8635,22 +8657,19 @@ declare namespace Office {
|
|
|
8635
8657
|
*
|
|
8636
8658
|
* **Important**:
|
|
8637
8659
|
*
|
|
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
|
|
8660
|
+
* - 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
8661
|
* and integrated spam reporting. To learn more about these features, see
|
|
8644
8662
|
* {@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
|
|
8663
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
8664
|
+
*
|
|
8665
|
+
* - In Outlook on the web and new Outlook on Windows, this API isn't supported in add-ins that implement a task pane. On these clients,
|
|
8666
|
+
* the API is only supported in add-ins that implement event-based activation or integrated spam reporting.
|
|
8646
8667
|
*
|
|
8647
8668
|
* - If your add-in uses the XML manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
|
|
8648
8669
|
* To learn more, see {@link https://learn.microsoft.com/javascript/api/manifest/override#override-element-for-runtime | Override element for Runtime}.
|
|
8649
8670
|
*
|
|
8650
8671
|
* - If your add-in uses the unified manifest for Microsoft 365, the URL returned matches the value of the `script` property in the
|
|
8651
|
-
* "code" object.
|
|
8652
|
-
*
|
|
8653
|
-
* @beta
|
|
8672
|
+
* "extensions.runtimes.code" object.
|
|
8654
8673
|
*/
|
|
8655
8674
|
javascriptRuntimeUrl: string;
|
|
8656
8675
|
}
|
|
@@ -8696,43 +8715,29 @@ declare namespace Office {
|
|
|
8696
8715
|
* Specifies the {@link Office.Sensitivity | sensitivity level} of an appointment.
|
|
8697
8716
|
*
|
|
8698
8717
|
* @remarks
|
|
8699
|
-
* [Api set: Mailbox
|
|
8718
|
+
* [Api set: Mailbox 1.14]
|
|
8700
8719
|
*
|
|
8701
8720
|
* **{@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
8721
|
*/
|
|
8705
8722
|
enum AppointmentSensitivityType {
|
|
8706
8723
|
/**
|
|
8707
8724
|
* The item needs no special treatment.
|
|
8708
|
-
*
|
|
8709
|
-
* @remarks
|
|
8710
|
-
* [Api set: Mailbox preview]
|
|
8711
8725
|
*/
|
|
8712
8726
|
Normal = "normal",
|
|
8713
8727
|
/**
|
|
8714
8728
|
* Treat the item as personal.
|
|
8715
8729
|
*
|
|
8716
8730
|
* **Important**: The Personal sensitivity level is only supported in Outlook on Windows.
|
|
8717
|
-
*
|
|
8718
|
-
* @remarks
|
|
8719
|
-
* [Api set: Mailbox preview]
|
|
8720
8731
|
*/
|
|
8721
8732
|
Personal = "personal",
|
|
8722
8733
|
/**
|
|
8723
8734
|
* Treat the item as private.
|
|
8724
|
-
*
|
|
8725
|
-
* @remarks
|
|
8726
|
-
* [Api set: Mailbox preview]
|
|
8727
8735
|
*/
|
|
8728
8736
|
Private = "private",
|
|
8729
8737
|
/**
|
|
8730
8738
|
* Treat the item as confidential.
|
|
8731
8739
|
*
|
|
8732
8740
|
* **Important**: The Confidential sensitivity level is only supported in Outlook on Windows.
|
|
8733
|
-
*
|
|
8734
|
-
* @remarks
|
|
8735
|
-
* [Api set: Mailbox preview]
|
|
8736
8741
|
*/
|
|
8737
8742
|
Confidential = "confidential"
|
|
8738
8743
|
}
|
|
@@ -9277,22 +9282,20 @@ declare namespace Office {
|
|
|
9277
9282
|
* Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in.
|
|
9278
9283
|
*
|
|
9279
9284
|
* 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
|
|
9285
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
9281
9286
|
*
|
|
9282
9287
|
* @remarks
|
|
9283
|
-
* [Api set: Mailbox
|
|
9288
|
+
* [Api set: Mailbox 1.14]
|
|
9284
9289
|
*
|
|
9285
9290
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
9286
9291
|
*
|
|
9287
9292
|
* **Important**: This enum can only be used to assign values to the
|
|
9288
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions
|
|
9293
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-moveitemto-member | moveItemTo}
|
|
9289
9294
|
* property of the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | event.completed}
|
|
9290
9295
|
* method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
|
|
9291
9296
|
* 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
|
|
9297
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
|
|
9293
9298
|
* Office.SpamReportingEventCompletedOptions.postProcessingAction}.
|
|
9294
|
-
*
|
|
9295
|
-
* @beta
|
|
9296
9299
|
*/
|
|
9297
9300
|
enum MoveSpamItemTo {
|
|
9298
9301
|
/**
|
|
@@ -10020,18 +10023,14 @@ declare namespace Office {
|
|
|
10020
10023
|
* {@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
10024
|
*
|
|
10022
10025
|
* @remarks
|
|
10023
|
-
* [Api set: Mailbox
|
|
10026
|
+
* [Api set: Mailbox 1.14]
|
|
10024
10027
|
*
|
|
10025
10028
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
10026
|
-
*
|
|
10027
|
-
* @beta
|
|
10028
10029
|
*/
|
|
10029
10030
|
enum SendModeOverride {
|
|
10030
10031
|
/**
|
|
10031
10032
|
* 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
10033
|
* 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
10034
|
*/
|
|
10036
10035
|
PromptUser = "promptUser"
|
|
10037
10036
|
}
|
|
@@ -10287,15 +10286,13 @@ declare namespace Office {
|
|
|
10287
10286
|
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
10288
10287
|
*
|
|
10289
10288
|
* @remarks
|
|
10290
|
-
* [Api set: Mailbox
|
|
10289
|
+
* [Api set: Mailbox 1.14]
|
|
10291
10290
|
*
|
|
10292
10291
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10293
10292
|
*
|
|
10294
10293
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10295
10294
|
*
|
|
10296
|
-
* **Important**: Outlook on the web, Outlook on
|
|
10297
|
-
*
|
|
10298
|
-
* @beta
|
|
10295
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
10299
10296
|
*/
|
|
10300
10297
|
sensitivity: Sensitivity;
|
|
10301
10298
|
/**
|
|
@@ -11765,18 +11762,15 @@ declare namespace Office {
|
|
|
11765
11762
|
* Provides the sensitivity value of the appointment.
|
|
11766
11763
|
*
|
|
11767
11764
|
* @remarks
|
|
11768
|
-
* [Api set: Mailbox
|
|
11765
|
+
* [Api set: Mailbox 1.14]
|
|
11769
11766
|
*
|
|
11770
11767
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11771
11768
|
*
|
|
11772
11769
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11773
11770
|
*
|
|
11774
|
-
* **Important**: Outlook on the web, Outlook on
|
|
11775
|
-
*
|
|
11776
|
-
* @beta
|
|
11771
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
11777
11772
|
*/
|
|
11778
11773
|
sensitivity: MailboxEnums.AppointmentSensitivityType;
|
|
11779
|
-
|
|
11780
11774
|
/**
|
|
11781
11775
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11782
11776
|
*
|
|
@@ -15773,6 +15767,8 @@ declare namespace Office {
|
|
|
15773
15767
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
15774
15768
|
*
|
|
15775
15769
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15770
|
+
*
|
|
15771
|
+
* **Important**: Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15776
15772
|
*/
|
|
15777
15773
|
interface MailboxEvent {
|
|
15778
15774
|
/**
|
|
@@ -15785,6 +15781,12 @@ declare namespace Office {
|
|
|
15785
15781
|
*
|
|
15786
15782
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15787
15783
|
*
|
|
15784
|
+
* **Important**:
|
|
15785
|
+
*
|
|
15786
|
+
* - Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15787
|
+
*
|
|
15788
|
+
* - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12.
|
|
15789
|
+
*
|
|
15788
15790
|
* @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
15791
|
*/
|
|
15790
15792
|
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;
|
|
@@ -16115,20 +16117,13 @@ declare namespace Office {
|
|
|
16115
16117
|
* Gets the message ID of the original message being replied to by the current message.
|
|
16116
16118
|
*
|
|
16117
16119
|
* @remarks
|
|
16118
|
-
* [Api set: Mailbox
|
|
16120
|
+
* [Api set: Mailbox 1.14]
|
|
16119
16121
|
*
|
|
16120
16122
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16121
16123
|
*
|
|
16122
16124
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16123
16125
|
*
|
|
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
|
|
16126
|
+
* **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
16127
|
*/
|
|
16133
16128
|
inReplyTo: string;
|
|
16134
16129
|
/**
|
|
@@ -16542,78 +16537,69 @@ declare namespace Office {
|
|
|
16542
16537
|
*
|
|
16543
16538
|
* **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
16539
|
* discard, or cancel even if no changes have occurred since the item was last saved.
|
|
16545
|
-
*
|
|
16540
|
+
*
|
|
16546
16541
|
* **Tip**: Use the
|
|
16547
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose
|
|
16542
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1) | closeAsync}
|
|
16548
16543
|
* method instead of the `close` method if you want your add-in to:
|
|
16549
|
-
*
|
|
16544
|
+
*
|
|
16550
16545
|
* - Automatically discard a message being composed without prompting the user with the save dialog.
|
|
16551
|
-
*
|
|
16546
|
+
*
|
|
16552
16547
|
* - 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
16548
|
*
|
|
16549
|
+
* - Close a reply in the Reading Pane or an existing draft from an Outlook desktop client.
|
|
16556
16550
|
*/
|
|
16557
16551
|
close(): void;
|
|
16558
16552
|
/**
|
|
16559
16553
|
* Closes the current message being composed with the option to discard unsaved changes.
|
|
16560
16554
|
* The message being composed can be a new message, reply, or an existing draft.
|
|
16561
|
-
*
|
|
16555
|
+
*
|
|
16562
16556
|
* @remarks
|
|
16563
|
-
* [Api set: Mailbox
|
|
16564
|
-
*
|
|
16557
|
+
* [Api set: Mailbox 1.14]
|
|
16558
|
+
*
|
|
16565
16559
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16566
16560
|
*
|
|
16567
16561
|
* **{@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
|
-
*
|
|
16562
|
+
*
|
|
16571
16563
|
* **Errors**:
|
|
16572
|
-
*
|
|
16564
|
+
*
|
|
16573
16565
|
* - `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
|
-
*
|
|
16566
|
+
*
|
|
16575
16567
|
* - `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
16568
|
* is set to `false`.
|
|
16577
|
-
*
|
|
16569
|
+
*
|
|
16578
16570
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16579
16571
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16580
16572
|
* `discardItem`: If `true`, the current message being composed is closed and unsaved changes are discarded. When the parameter isn't declared or is
|
|
16581
16573
|
* 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
16574
|
* 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
16575
|
* return an error. For more information on the error, see the Remarks section.
|
|
16584
|
-
*
|
|
16576
|
+
*
|
|
16585
16577
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16586
16578
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16587
|
-
*
|
|
16588
|
-
* @beta
|
|
16589
16579
|
*/
|
|
16590
16580
|
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16591
16581
|
/**
|
|
16592
16582
|
* Closes the current new message being composed.
|
|
16593
|
-
*
|
|
16583
|
+
*
|
|
16594
16584
|
* 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
16585
|
* 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
16586
|
* discard changes, or cancel the operation.
|
|
16597
16587
|
*
|
|
16598
16588
|
* @remarks
|
|
16599
|
-
* [Api set: Mailbox
|
|
16600
|
-
*
|
|
16589
|
+
* [Api set: Mailbox 1.14]
|
|
16590
|
+
*
|
|
16601
16591
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16602
16592
|
*
|
|
16603
16593
|
* **{@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
16594
|
*
|
|
16607
16595
|
* **Errors**:
|
|
16608
|
-
*
|
|
16596
|
+
*
|
|
16609
16597
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
|
|
16610
|
-
*
|
|
16598
|
+
*
|
|
16611
16599
|
* - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft.
|
|
16612
16600
|
*
|
|
16613
16601
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16614
16602
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16615
|
-
*
|
|
16616
|
-
* @beta
|
|
16617
16603
|
*/
|
|
16618
16604
|
closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16619
16605
|
/**
|
|
@@ -16818,15 +16804,12 @@ declare namespace Office {
|
|
|
16818
16804
|
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16819
16805
|
*
|
|
16820
16806
|
* @remarks
|
|
16821
|
-
* [Api set: Mailbox
|
|
16807
|
+
* [Api set: Mailbox 1.14]
|
|
16822
16808
|
*
|
|
16823
16809
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16824
16810
|
*
|
|
16825
16811
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16826
16812
|
*
|
|
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
16813
|
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16831
16814
|
* to provide context for the current message being composed.
|
|
16832
16815
|
*
|
|
@@ -16835,31 +16818,24 @@ declare namespace Office {
|
|
|
16835
16818
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16836
16819
|
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16837
16820
|
* property.
|
|
16838
|
-
*
|
|
16839
|
-
* @beta
|
|
16840
16821
|
*/
|
|
16841
16822
|
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16842
16823
|
/**
|
|
16843
16824
|
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16844
16825
|
*
|
|
16845
16826
|
* @remarks
|
|
16846
|
-
* [Api set: Mailbox
|
|
16827
|
+
* [Api set: Mailbox 1.14]
|
|
16847
16828
|
*
|
|
16848
16829
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16849
16830
|
*
|
|
16850
16831
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16851
16832
|
*
|
|
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
16833
|
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16856
16834
|
* to provide context for the current message being composed.
|
|
16857
16835
|
*
|
|
16858
16836
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16859
16837
|
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16860
16838
|
* property.
|
|
16861
|
-
*
|
|
16862
|
-
* @beta
|
|
16863
16839
|
*/
|
|
16864
16840
|
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16865
16841
|
/**
|
|
@@ -16900,7 +16876,7 @@ declare namespace Office {
|
|
|
16900
16876
|
* Gets the Exchange Web Services item class of the selected message.
|
|
16901
16877
|
*
|
|
16902
16878
|
* @remarks
|
|
16903
|
-
* [Api set: Mailbox
|
|
16879
|
+
* [Api set: Mailbox 1.14]
|
|
16904
16880
|
*
|
|
16905
16881
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16906
16882
|
*
|
|
@@ -16908,9 +16884,6 @@ declare namespace Office {
|
|
|
16908
16884
|
*
|
|
16909
16885
|
* **Important**:
|
|
16910
16886
|
*
|
|
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
16887
|
* The following table lists the default message classes.
|
|
16915
16888
|
*
|
|
16916
16889
|
* <table>
|
|
@@ -16948,15 +16921,13 @@ declare namespace Office {
|
|
|
16948
16921
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16949
16922
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16950
16923
|
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
16951
|
-
*
|
|
16952
|
-
* @beta
|
|
16953
16924
|
*/
|
|
16954
16925
|
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16955
16926
|
/**
|
|
16956
16927
|
* Gets the Exchange Web Services item class of the selected message.
|
|
16957
16928
|
*
|
|
16958
16929
|
* @remarks
|
|
16959
|
-
* [Api set: Mailbox
|
|
16930
|
+
* [Api set: Mailbox 1.14]
|
|
16960
16931
|
*
|
|
16961
16932
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16962
16933
|
*
|
|
@@ -16964,9 +16935,6 @@ declare namespace Office {
|
|
|
16964
16935
|
*
|
|
16965
16936
|
* **Important**:
|
|
16966
16937
|
*
|
|
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
16938
|
* The following table lists the default message classes.
|
|
16971
16939
|
*
|
|
16972
16940
|
* <table>
|
|
@@ -17002,8 +16970,6 @@ declare namespace Office {
|
|
|
17002
16970
|
*
|
|
17003
16971
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17004
16972
|
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
17005
|
-
*
|
|
17006
|
-
* @beta
|
|
17007
16973
|
*/
|
|
17008
16974
|
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17009
16975
|
/**
|
|
@@ -17877,7 +17843,6 @@ declare namespace Office {
|
|
|
17877
17843
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17878
17844
|
*/
|
|
17879
17845
|
to: EmailAddressDetails[];
|
|
17880
|
-
|
|
17881
17846
|
/**
|
|
17882
17847
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
17883
17848
|
*
|
|
@@ -18125,7 +18090,7 @@ declare namespace Office {
|
|
|
18125
18090
|
* Gets the current message in EML format encoded in Base64.
|
|
18126
18091
|
*
|
|
18127
18092
|
* @remarks
|
|
18128
|
-
* [Api set: Mailbox
|
|
18093
|
+
* [Api set: Mailbox 1.14]
|
|
18129
18094
|
*
|
|
18130
18095
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18131
18096
|
*
|
|
@@ -18136,15 +18101,13 @@ declare namespace Office {
|
|
|
18136
18101
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
18137
18102
|
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
18138
18103
|
* returned in the `asyncResult.error` property.
|
|
18139
|
-
*
|
|
18140
|
-
* @beta
|
|
18141
18104
|
*/
|
|
18142
18105
|
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18143
18106
|
/**
|
|
18144
18107
|
* Gets the current message in EML format encoded in Base64.
|
|
18145
18108
|
*
|
|
18146
18109
|
* @remarks
|
|
18147
|
-
* [Api set: Mailbox
|
|
18110
|
+
* [Api set: Mailbox 1.14]
|
|
18148
18111
|
*
|
|
18149
18112
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18150
18113
|
*
|
|
@@ -18153,8 +18116,6 @@ declare namespace Office {
|
|
|
18153
18116
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
18154
18117
|
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
18155
18118
|
* returned in the `asyncResult.error` property.
|
|
18156
|
-
*
|
|
18157
|
-
* @beta
|
|
18158
18119
|
*/
|
|
18159
18120
|
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18160
18121
|
/**
|
|
@@ -19006,27 +18967,21 @@ declare namespace Office {
|
|
|
19006
18967
|
* Provides the updated Office theme that raised the `Office.EventType.OfficeThemeChanged` event.
|
|
19007
18968
|
*
|
|
19008
18969
|
* @remarks
|
|
19009
|
-
* [Api set: Mailbox
|
|
19010
|
-
*
|
|
19011
|
-
* @beta
|
|
18970
|
+
* [Api set: Mailbox 1.14]
|
|
19012
18971
|
*/
|
|
19013
18972
|
export interface OfficeThemeChangedEventArgs {
|
|
19014
18973
|
/**
|
|
19015
18974
|
* Gets the updated Office theme.
|
|
19016
18975
|
*
|
|
19017
18976
|
* @remarks
|
|
19018
|
-
* [Api set: Mailbox
|
|
19019
|
-
*
|
|
19020
|
-
* @beta
|
|
18977
|
+
* [Api set: Mailbox 1.14]
|
|
19021
18978
|
*/
|
|
19022
18979
|
officeTheme: Office.OfficeTheme;
|
|
19023
18980
|
/**
|
|
19024
18981
|
* Gets the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
19025
18982
|
*
|
|
19026
18983
|
* @remarks
|
|
19027
|
-
* [Api set: Mailbox
|
|
19028
|
-
*
|
|
19029
|
-
* @beta
|
|
18984
|
+
* [Api set: Mailbox 1.14]
|
|
19030
18985
|
*/
|
|
19031
18986
|
type: "officeThemeChanged";
|
|
19032
18987
|
}
|
|
@@ -19873,46 +19828,77 @@ declare namespace Office {
|
|
|
19873
19828
|
* The identifier of the message conversation that contains the message that's currently selected.
|
|
19874
19829
|
*
|
|
19875
19830
|
* @remarks
|
|
19876
|
-
*
|
|
19877
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19831
|
+
* [Api set: Mailbox 1.14]
|
|
19878
19832
|
*
|
|
19879
|
-
* @
|
|
19833
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19834
|
+
*
|
|
19835
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19880
19836
|
*/
|
|
19881
19837
|
conversationId: string;
|
|
19882
19838
|
/**
|
|
19883
19839
|
* Returns `true` if the message that's currently selected contains an attachment.
|
|
19884
19840
|
*
|
|
19885
19841
|
* @remarks
|
|
19886
|
-
*
|
|
19887
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19842
|
+
* [Api set: Mailbox 1.14]
|
|
19888
19843
|
*
|
|
19889
|
-
* @
|
|
19844
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19845
|
+
*
|
|
19846
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19890
19847
|
*/
|
|
19891
19848
|
hasAttachment: boolean;
|
|
19892
19849
|
/**
|
|
19893
19850
|
* The internet message identifier of the message that's currently selected.
|
|
19894
19851
|
*
|
|
19895
19852
|
* @remarks
|
|
19896
|
-
*
|
|
19897
|
-
* you must install Version 2305 (Build 16501.20210) or later.
|
|
19853
|
+
* [Api set: Mailbox 1.14]
|
|
19898
19854
|
*
|
|
19899
|
-
* @
|
|
19855
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19856
|
+
*
|
|
19857
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19900
19858
|
*/
|
|
19901
19859
|
internetMessageId: string;
|
|
19902
19860
|
/**
|
|
19903
19861
|
* The Exchange Web Services (EWS) item identifier of the message that's currently selected.
|
|
19862
|
+
*
|
|
19863
|
+
* @remarks
|
|
19864
|
+
* [Api set: Mailbox 1.13]
|
|
19865
|
+
*
|
|
19866
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19867
|
+
*
|
|
19868
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19904
19869
|
*/
|
|
19905
19870
|
itemId: string;
|
|
19906
19871
|
/**
|
|
19907
19872
|
* The Outlook mode (`Read` or `Compose`) of the message that's currently selected.
|
|
19873
|
+
*
|
|
19874
|
+
* @remarks
|
|
19875
|
+
* [Api set: Mailbox 1.13]
|
|
19876
|
+
*
|
|
19877
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19878
|
+
*
|
|
19879
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19908
19880
|
*/
|
|
19909
19881
|
itemMode: string;
|
|
19910
19882
|
/**
|
|
19911
19883
|
* The type of the item that's currently selected. `Message` is the only supported type at this time.
|
|
19884
|
+
*
|
|
19885
|
+
* @remarks
|
|
19886
|
+
* [Api set: Mailbox 1.13]
|
|
19887
|
+
*
|
|
19888
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19889
|
+
*
|
|
19890
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19912
19891
|
*/
|
|
19913
19892
|
itemType: MailboxEnums.ItemType | string;
|
|
19914
19893
|
/**
|
|
19915
19894
|
* The description that appears in the subject field of the message that's currently selected.
|
|
19895
|
+
*
|
|
19896
|
+
* @remarks
|
|
19897
|
+
* [Api set: Mailbox 1.13]
|
|
19898
|
+
*
|
|
19899
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19900
|
+
*
|
|
19901
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19916
19902
|
*/
|
|
19917
19903
|
subject: string;
|
|
19918
19904
|
}
|
|
@@ -19921,26 +19907,24 @@ declare namespace Office {
|
|
|
19921
19907
|
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
19922
19908
|
*
|
|
19923
19909
|
* @remarks
|
|
19924
|
-
* [Api set: Mailbox
|
|
19910
|
+
* [Api set: Mailbox 1.14]
|
|
19925
19911
|
*
|
|
19926
19912
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19927
19913
|
*
|
|
19928
19914
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19929
|
-
*
|
|
19930
|
-
* @beta
|
|
19931
19915
|
*/
|
|
19932
19916
|
interface Sensitivity {
|
|
19933
19917
|
/**
|
|
19934
19918
|
* Gets the sensitivity level of an appointment.
|
|
19935
19919
|
*
|
|
19936
19920
|
* @remarks
|
|
19937
|
-
* [Api set: Mailbox
|
|
19921
|
+
* [Api set: Mailbox 1.14]
|
|
19938
19922
|
*
|
|
19939
19923
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19940
19924
|
*
|
|
19941
19925
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19942
19926
|
*
|
|
19943
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19927
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19944
19928
|
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19945
19929
|
* is returned in the `asyncResult.value` property.
|
|
19946
19930
|
*
|
|
@@ -19948,41 +19932,37 @@ declare namespace Office {
|
|
|
19948
19932
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19949
19933
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19950
19934
|
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19951
|
-
*
|
|
19952
|
-
* @beta
|
|
19953
19935
|
*/
|
|
19954
19936
|
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19955
19937
|
/**
|
|
19956
19938
|
* Gets the sensitivity level of an appointment.
|
|
19957
19939
|
*
|
|
19958
19940
|
* @remarks
|
|
19959
|
-
* [Api set: Mailbox
|
|
19941
|
+
* [Api set: Mailbox 1.14]
|
|
19960
19942
|
*
|
|
19961
19943
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19962
19944
|
*
|
|
19963
19945
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19964
19946
|
*
|
|
19965
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19947
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19966
19948
|
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19967
19949
|
* is returned in the `asyncResult.value` property.
|
|
19968
19950
|
*
|
|
19969
19951
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19970
19952
|
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19971
|
-
*
|
|
19972
|
-
* @beta
|
|
19973
19953
|
*/
|
|
19974
19954
|
getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19975
19955
|
/**
|
|
19976
19956
|
* Sets the sensitivity level of an appointment.
|
|
19977
19957
|
*
|
|
19978
19958
|
* @remarks
|
|
19979
|
-
* [Api set: Mailbox
|
|
19959
|
+
* [Api set: Mailbox 1.14]
|
|
19980
19960
|
*
|
|
19981
19961
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
19982
19962
|
*
|
|
19983
19963
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19984
19964
|
*
|
|
19985
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19965
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19986
19966
|
*
|
|
19987
19967
|
* **Errors**:
|
|
19988
19968
|
*
|
|
@@ -19993,21 +19973,19 @@ declare namespace Office {
|
|
|
19993
19973
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19994
19974
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19995
19975
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
19996
|
-
*
|
|
19997
|
-
* @beta
|
|
19998
19976
|
*/
|
|
19999
19977
|
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
20000
19978
|
/**
|
|
20001
19979
|
* Sets the sensitivity level of an appointment.
|
|
20002
19980
|
*
|
|
20003
19981
|
* @remarks
|
|
20004
|
-
* [Api set: Mailbox
|
|
19982
|
+
* [Api set: Mailbox 1.14]
|
|
20005
19983
|
*
|
|
20006
19984
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
20007
19985
|
*
|
|
20008
19986
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20009
19987
|
*
|
|
20010
|
-
* **Important**: Outlook on the web, Outlook on
|
|
19988
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
20011
19989
|
*
|
|
20012
19990
|
* **Errors**:
|
|
20013
19991
|
*
|
|
@@ -20016,8 +19994,6 @@ declare namespace Office {
|
|
|
20016
19994
|
* @param sensitivity - The sensitivity level as an enum or string.
|
|
20017
19995
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
20018
19996
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
20019
|
-
*
|
|
20020
|
-
* @beta
|
|
20021
19997
|
*/
|
|
20022
19998
|
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
20023
19999
|
}
|
|
@@ -20656,10 +20632,18 @@ declare namespace Office {
|
|
|
20656
20632
|
/**
|
|
20657
20633
|
* Specifies the behavior of a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in}
|
|
20658
20634
|
* when it completes processing an `OnMessageSend` or `OnAppointmentSend` event.
|
|
20635
|
+
*
|
|
20636
|
+
* @remarks
|
|
20637
|
+
*
|
|
20638
|
+
* [Api set: Mailbox 1.12]
|
|
20639
|
+
*
|
|
20640
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20641
|
+
*
|
|
20642
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20659
20643
|
*/
|
|
20660
20644
|
interface SmartAlertsEventCompletedOptions {
|
|
20661
20645
|
/**
|
|
20662
|
-
* When you use the {@link
|
|
20646
|
+
* 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
20647
|
* this value indicates if the handled event should continue execution or be canceled.
|
|
20664
20648
|
* 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
20649
|
* For a complete sample, see the
|
|
@@ -20675,33 +20659,31 @@ declare namespace Office {
|
|
|
20675
20659
|
*/
|
|
20676
20660
|
allowEvent?: boolean;
|
|
20677
20661
|
/**
|
|
20678
|
-
* When you use the {@link
|
|
20662
|
+
* 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
20663
|
* 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
20664
|
*
|
|
20681
20665
|
* 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
|
|
20666
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20683
20667
|
*
|
|
20684
20668
|
* @remarks
|
|
20685
20669
|
*
|
|
20686
|
-
* [Api set: Mailbox
|
|
20670
|
+
* [Api set: Mailbox 1.14]
|
|
20687
20671
|
*
|
|
20688
20672
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20689
20673
|
*
|
|
20690
20674
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20691
|
-
*
|
|
20692
|
-
* @beta
|
|
20693
20675
|
*/
|
|
20694
20676
|
cancelLabel?: string;
|
|
20695
20677
|
/**
|
|
20696
|
-
* When you use the {@link
|
|
20678
|
+
* 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
20679
|
* 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
20680
|
*
|
|
20699
20681
|
* 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
|
|
20682
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20701
20683
|
*
|
|
20702
20684
|
* @remarks
|
|
20703
20685
|
*
|
|
20704
|
-
* [Api set: Mailbox
|
|
20686
|
+
* [Api set: Mailbox 1.14]
|
|
20705
20687
|
*
|
|
20706
20688
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20707
20689
|
*
|
|
@@ -20718,17 +20700,15 @@ declare namespace Office {
|
|
|
20718
20700
|
*
|
|
20719
20701
|
* If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
20720
20702
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
20721
|
-
*
|
|
20722
|
-
* @beta
|
|
20723
20703
|
*/
|
|
20724
20704
|
commandId?: string;
|
|
20725
20705
|
/**
|
|
20726
|
-
* When you use the {@link
|
|
20706
|
+
* 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
20707
|
* 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
20708
|
*
|
|
20729
20709
|
* @remarks
|
|
20730
20710
|
*
|
|
20731
|
-
* [Api set: Mailbox
|
|
20711
|
+
* [Api set: Mailbox 1.14]
|
|
20732
20712
|
*
|
|
20733
20713
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20734
20714
|
*
|
|
@@ -20745,12 +20725,10 @@ declare namespace Office {
|
|
|
20745
20725
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
20746
20726
|
* 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
20727
|
* `JSON.parse()` once you retrieve it.
|
|
20748
|
-
*
|
|
20749
|
-
* @beta
|
|
20750
20728
|
*/
|
|
20751
20729
|
contextData?: any;
|
|
20752
20730
|
/**
|
|
20753
|
-
* When you use the {@link
|
|
20731
|
+
* 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
20732
|
* to `false`, this property sets the error message displayed to the user. For an example, see the
|
|
20755
20733
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
20756
20734
|
*
|
|
@@ -20764,17 +20742,17 @@ declare namespace Office {
|
|
|
20764
20742
|
*/
|
|
20765
20743
|
errorMessage?: string;
|
|
20766
20744
|
/**
|
|
20767
|
-
* When you use the {@link
|
|
20745
|
+
* 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
20746
|
* and set its `allowEvent` property to `false`, this property overrides the
|
|
20769
20747
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
|
|
20770
20748
|
* specified in the manifest at runtime.
|
|
20771
20749
|
*
|
|
20772
20750
|
* 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
|
|
20751
|
+
* {@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
20752
|
*
|
|
20775
20753
|
* @remarks
|
|
20776
20754
|
*
|
|
20777
|
-
* [Api set: Mailbox
|
|
20755
|
+
* [Api set: Mailbox 1.14]
|
|
20778
20756
|
*
|
|
20779
20757
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20780
20758
|
*
|
|
@@ -20782,8 +20760,6 @@ declare namespace Office {
|
|
|
20782
20760
|
*
|
|
20783
20761
|
* **Important**: Currently, `sendModeOverride` can only be set to the
|
|
20784
20762
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#prompt-user | prompt user} option.
|
|
20785
|
-
*
|
|
20786
|
-
* @beta
|
|
20787
20763
|
*/
|
|
20788
20764
|
sendModeOverride?: MailboxEnums.SendModeOverride | string;
|
|
20789
20765
|
}
|
|
@@ -20791,76 +20767,66 @@ declare namespace Office {
|
|
|
20791
20767
|
* Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
|
|
20792
20768
|
*
|
|
20793
20769
|
* @remarks
|
|
20794
|
-
* [Api set: Mailbox
|
|
20795
|
-
*
|
|
20796
|
-
* @beta
|
|
20770
|
+
* [Api set: Mailbox 1.14]
|
|
20797
20771
|
*/
|
|
20798
20772
|
export interface SpamReportingEventArgs {
|
|
20799
20773
|
/**
|
|
20800
20774
|
* The text provided by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20801
20775
|
*
|
|
20802
20776
|
* @remarks
|
|
20803
|
-
* [Api set: Mailbox
|
|
20777
|
+
* [Api set: Mailbox 1.14]
|
|
20804
20778
|
*
|
|
20805
20779
|
* 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
|
|
20780
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/preprocessingdialog#child-elements | FreeTextLabel}
|
|
20807
20781
|
* element in the manifest of your add-in.
|
|
20808
20782
|
*
|
|
20809
20783
|
* 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
|
|
20784
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20813
20785
|
*/
|
|
20814
20786
|
freeText: string;
|
|
20815
20787
|
/**
|
|
20816
20788
|
* Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20817
20789
|
*
|
|
20818
20790
|
* @remarks
|
|
20819
|
-
* [Api set: Mailbox
|
|
20791
|
+
* [Api set: Mailbox 1.14]
|
|
20820
20792
|
*
|
|
20821
20793
|
* 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
|
|
20794
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/reportingoptions | ReportingOptions}
|
|
20823
20795
|
* element of your add-in's manifest.
|
|
20824
20796
|
*
|
|
20825
20797
|
* 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
|
|
20798
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20829
20799
|
*/
|
|
20830
20800
|
options: boolean[];
|
|
20831
20801
|
/**
|
|
20832
20802
|
* The type of event that was raised. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
20833
20803
|
*
|
|
20834
20804
|
* @remarks
|
|
20835
|
-
* [Api set: Mailbox
|
|
20836
|
-
*
|
|
20837
|
-
* @beta
|
|
20805
|
+
* [Api set: Mailbox 1.14]
|
|
20838
20806
|
*/
|
|
20839
20807
|
type: "SpamReporting";
|
|
20840
20808
|
}
|
|
20841
20809
|
/**
|
|
20842
20810
|
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting add-in}
|
|
20843
20811
|
* after it completes processing a
|
|
20844
|
-
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype
|
|
20812
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | SpamReporting} event.
|
|
20845
20813
|
*
|
|
20846
20814
|
* @remarks
|
|
20847
20815
|
*
|
|
20848
|
-
* [Api set: Mailbox
|
|
20816
|
+
* [Api set: Mailbox 1.14]
|
|
20849
20817
|
*
|
|
20850
20818
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
20851
20819
|
*
|
|
20852
20820
|
* **{@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
20821
|
*/
|
|
20856
20822
|
interface SpamReportingEventCompletedOptions {
|
|
20857
20823
|
/**
|
|
20858
|
-
* When you use the {@link
|
|
20824
|
+
* 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
20825
|
* this property specifies the Outlook mailbox folder to which the message will be moved.
|
|
20860
20826
|
*
|
|
20861
20827
|
* @remarks
|
|
20862
20828
|
*
|
|
20863
|
-
* [Api set: Mailbox
|
|
20829
|
+
* [Api set: Mailbox 1.14]
|
|
20864
20830
|
*
|
|
20865
20831
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20866
20832
|
*
|
|
@@ -20871,19 +20837,17 @@ declare namespace Office {
|
|
|
20871
20837
|
* - If the specified folder doesn't exist yet, it will be created before the message is moved.
|
|
20872
20838
|
*
|
|
20873
20839
|
* - 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`,
|
|
20840
|
+
* 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
20841
|
* the `folderName` property is ignored.
|
|
20876
|
-
*
|
|
20877
|
-
* @beta
|
|
20878
20842
|
*/
|
|
20879
20843
|
folderName?: string;
|
|
20880
20844
|
/**
|
|
20881
|
-
* When you use the {@link
|
|
20845
|
+
* 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
20846
|
* this property specifies whether the message is moved to a different folder in the mailbox.
|
|
20883
20847
|
*
|
|
20884
20848
|
* @remarks
|
|
20885
20849
|
*
|
|
20886
|
-
* [Api set: Mailbox
|
|
20850
|
+
* [Api set: Mailbox 1.14]
|
|
20887
20851
|
*
|
|
20888
20852
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20889
20853
|
*
|
|
@@ -20898,28 +20862,24 @@ declare namespace Office {
|
|
|
20898
20862
|
* - If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
20899
20863
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
20900
20864
|
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
20901
|
-
*
|
|
20902
|
-
* @beta
|
|
20903
20865
|
*/
|
|
20904
20866
|
moveItemTo?: MailboxEnums.MoveSpamItemTo;
|
|
20905
20867
|
/**
|
|
20906
20868
|
* 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
|
|
20869
|
+
* 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
20870
|
* the reported message remains in its current mailbox folder.
|
|
20909
20871
|
*
|
|
20910
20872
|
* @remarks
|
|
20911
20873
|
*
|
|
20912
|
-
* [Api set: Mailbox
|
|
20874
|
+
* [Api set: Mailbox 1.14]
|
|
20913
20875
|
*
|
|
20914
20876
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20915
20877
|
*
|
|
20916
20878
|
* **{@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
20879
|
*/
|
|
20920
20880
|
onErrorDeleteItem?: boolean;
|
|
20921
20881
|
/**
|
|
20922
|
-
* When you use the {@link
|
|
20882
|
+
* 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
20883
|
* this property specifies whether the message is moved to a different folder in the mailbox. The following post-processing actions are available.
|
|
20924
20884
|
*
|
|
20925
20885
|
* - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
|
|
@@ -20932,7 +20892,7 @@ declare namespace Office {
|
|
|
20932
20892
|
*
|
|
20933
20893
|
* @remarks
|
|
20934
20894
|
*
|
|
20935
|
-
* [Api set: Mailbox
|
|
20895
|
+
* [Api set: Mailbox 1.14]
|
|
20936
20896
|
*
|
|
20937
20897
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20938
20898
|
*
|
|
@@ -20948,18 +20908,16 @@ declare namespace Office {
|
|
|
20948
20908
|
* - If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
20949
20909
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
20950
20910
|
* `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
|
|
20951
|
-
*
|
|
20952
|
-
* @beta
|
|
20953
20911
|
*/
|
|
20954
20912
|
postProcessingAction?: string;
|
|
20955
20913
|
/**
|
|
20956
|
-
* When you use the {@link
|
|
20914
|
+
* 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
20915
|
* 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
20916
|
* If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
|
|
20959
20917
|
*
|
|
20960
20918
|
* @remarks
|
|
20961
20919
|
*
|
|
20962
|
-
* [Api set: Mailbox
|
|
20920
|
+
* [Api set: Mailbox 1.14]
|
|
20963
20921
|
*
|
|
20964
20922
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20965
20923
|
*
|
|
@@ -20969,9 +20927,7 @@ declare namespace Office {
|
|
|
20969
20927
|
* reported message. This applies even if `showPostProcessingDialog` is configured. However, depending on how you configured the `moveItemTo` property in the
|
|
20970
20928
|
* `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
20929
|
* 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
|
|
20930
|
+
* {@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
20931
|
*/
|
|
20976
20932
|
showPostProcessingDialog?: object;
|
|
20977
20933
|
}
|
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.473",
|
|
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": "735c05c8355d969fb6738be33a9b7e0849571425739d1b85ab499fa260bb6cc6",
|
|
49
49
|
"typeScriptVersion": "4.7",
|
|
50
50
|
"nonNpm": true
|
|
51
51
|
}
|