@types/office-js 1.0.388 → 1.0.390
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +979 -78
- office-js/package.json +2 -2
office-js/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
|
|
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
|
*
|
|
@@ -660,9 +666,27 @@ declare namespace Office {
|
|
|
660
666
|
* Triggers when a `customXmlPart` node is replaced.
|
|
661
667
|
*/
|
|
662
668
|
NodeReplaced,
|
|
669
|
+
/**
|
|
670
|
+
* Occurs when the OfficeTheme is changed in Outlook.
|
|
671
|
+
*
|
|
672
|
+
* To add an event handler for the `OfficeThemeChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
673
|
+
* The event handler receives an argument of type
|
|
674
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.officethemechangedeventargs | Office.OfficeThemeChangedEventArgs}.
|
|
675
|
+
*
|
|
676
|
+
* **Important**:
|
|
677
|
+
*
|
|
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]
|
|
684
|
+
*/
|
|
685
|
+
OfficeThemeChanged,
|
|
663
686
|
/**
|
|
664
687
|
* Occurs when the recipient list of the selected item or the appointment location is changed in Outlook.
|
|
665
|
-
*
|
|
688
|
+
*
|
|
689
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
666
690
|
*
|
|
667
691
|
* To add an event handler for the `RecipientsChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
668
692
|
* The event handler receives an argument of type
|
|
@@ -673,7 +697,8 @@ declare namespace Office {
|
|
|
673
697
|
RecipientsChanged,
|
|
674
698
|
/**
|
|
675
699
|
* Occurs when the recurrence pattern of the selected series is changed in Outlook.
|
|
676
|
-
*
|
|
700
|
+
*
|
|
701
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
677
702
|
*
|
|
678
703
|
* To add an event handler for the `RecurrenceChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
679
704
|
* The event handler receives an argument of type
|
|
@@ -688,21 +713,23 @@ declare namespace Office {
|
|
|
688
713
|
ResourceSelectionChanged,
|
|
689
714
|
/**
|
|
690
715
|
* Occurs in Outlook when one or more messages are selected or deselected.
|
|
691
|
-
*
|
|
692
|
-
*
|
|
716
|
+
*
|
|
717
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
718
|
+
*
|
|
693
719
|
* To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
694
|
-
*
|
|
720
|
+
*
|
|
695
721
|
* [Api set: Mailbox 1.13]
|
|
696
722
|
*/
|
|
697
723
|
SelectedItemsChanged,
|
|
698
724
|
/**
|
|
699
725
|
* Occurs in Outlook when the sensitivity label of a message or appointment changes.
|
|
700
|
-
*
|
|
701
|
-
*
|
|
726
|
+
*
|
|
727
|
+
* **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
|
|
728
|
+
*
|
|
702
729
|
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
703
730
|
* The event handler receives an argument of type
|
|
704
731
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs | Office.SensitivityLabelChangedEventArgs}.
|
|
705
|
-
*
|
|
732
|
+
*
|
|
706
733
|
* [Api set: Mailbox 1.13]
|
|
707
734
|
*/
|
|
708
735
|
SensitivityLabelChanged,
|
|
@@ -710,6 +737,13 @@ declare namespace Office {
|
|
|
710
737
|
* A `Settings.settingsChanged` event was raised in Excel, PowerPoint, or Word.
|
|
711
738
|
*/
|
|
712
739
|
SettingsChanged,
|
|
740
|
+
/**
|
|
741
|
+
* Occurs in Outlook when an unsolicited message is reported. The event handler receives an argument of type
|
|
742
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventargs | Office.SpamReportingEventArgs}.
|
|
743
|
+
*
|
|
744
|
+
* [Api set: Mailbox 1.14]
|
|
745
|
+
*/
|
|
746
|
+
SpamReporting,
|
|
713
747
|
/**
|
|
714
748
|
* Triggers when a Task selection happens in Project.
|
|
715
749
|
*/
|
|
@@ -4640,6 +4674,20 @@ declare namespace Office {
|
|
|
4640
4674
|
* Provides objects and methods that you can use to create and manipulate UI components, such as dialog boxes.
|
|
4641
4675
|
*/
|
|
4642
4676
|
ui: UI;
|
|
4677
|
+
/**
|
|
4678
|
+
* Gets the object to retrieve the runtime URLs of an add-in.
|
|
4679
|
+
*
|
|
4680
|
+
* @remarks
|
|
4681
|
+
*
|
|
4682
|
+
* **Applications**: Outlook
|
|
4683
|
+
*
|
|
4684
|
+
* [Api set: Mailbox 1.14]
|
|
4685
|
+
*
|
|
4686
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
4687
|
+
*
|
|
4688
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
4689
|
+
*/
|
|
4690
|
+
urls: Urls;
|
|
4643
4691
|
}
|
|
4644
4692
|
/**
|
|
4645
4693
|
* Provides information about the environment in which the add-in is running.
|
|
@@ -5299,7 +5347,7 @@ declare namespace Office {
|
|
|
5299
5347
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5300
5348
|
* In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
|
|
5301
5349
|
* @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.
|
|
5302
|
-
* @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.
|
|
5350
|
+
* @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.
|
|
5303
5351
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
|
|
5304
5352
|
*/
|
|
5305
5353
|
requestPermissionsAsync(permissions: Office.DevicePermissionType[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
@@ -5337,7 +5385,7 @@ declare namespace Office {
|
|
|
5337
5385
|
*
|
|
5338
5386
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5339
5387
|
* In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
|
|
5340
|
-
* @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.
|
|
5388
|
+
* @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.
|
|
5341
5389
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
|
|
5342
5390
|
*/
|
|
5343
5391
|
requestPermissionsAsync(permissions: Office.DevicePermissionType[], callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
@@ -6946,8 +6994,8 @@ declare namespace Office {
|
|
|
6946
6994
|
* </tr>
|
|
6947
6995
|
* <tr>
|
|
6948
6996
|
* <td><strong>Outlook</strong></td>
|
|
6949
|
-
* <td>
|
|
6950
|
-
* <td>
|
|
6997
|
+
* <td>Supported\*</td>
|
|
6998
|
+
* <td>Supported\*</td>
|
|
6951
6999
|
* <td>Not available</td>
|
|
6952
7000
|
* <td>Not available</td>
|
|
6953
7001
|
* <td>Not available</td>
|
|
@@ -6969,6 +7017,10 @@ declare namespace Office {
|
|
|
6969
7017
|
* <td>Not available</td>
|
|
6970
7018
|
* </tr>
|
|
6971
7019
|
* </table>
|
|
7020
|
+
*
|
|
7021
|
+
* \* In Outlook, the Office theme API is supported starting in
|
|
7022
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
|
|
7023
|
+
* It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
6972
7024
|
*/
|
|
6973
7025
|
interface OfficeTheme {
|
|
6974
7026
|
/**
|
|
@@ -8563,6 +8615,44 @@ declare namespace Office {
|
|
|
8563
8615
|
*/
|
|
8564
8616
|
openBrowserWindow(url: string): void;
|
|
8565
8617
|
}
|
|
8618
|
+
/**
|
|
8619
|
+
* Provides the URLs of the runtime environments used by an add-in.
|
|
8620
|
+
*
|
|
8621
|
+
* @remarks
|
|
8622
|
+
*
|
|
8623
|
+
* [Api set: Mailbox 1.14]
|
|
8624
|
+
*
|
|
8625
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8626
|
+
*
|
|
8627
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8628
|
+
*/
|
|
8629
|
+
interface Urls {
|
|
8630
|
+
/**
|
|
8631
|
+
* Gets the URL of the JavaScript runtime of an add-in.
|
|
8632
|
+
*
|
|
8633
|
+
* @remarks
|
|
8634
|
+
*
|
|
8635
|
+
* [Api set: Mailbox 1.14]
|
|
8636
|
+
*
|
|
8637
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
8638
|
+
*
|
|
8639
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8640
|
+
*
|
|
8641
|
+
* **Important**:
|
|
8642
|
+
*
|
|
8643
|
+
* - The URL that's returned points to the location of the JavaScript file that classic Outlook on Windows uses to handle event-based activation
|
|
8644
|
+
* and integrated spam reporting. To learn more about these features, see
|
|
8645
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Configure your Outlook add-in for event-based activation} and
|
|
8646
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
8647
|
+
*
|
|
8648
|
+
* - If your add-in uses the XML manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
|
|
8649
|
+
* To learn more, see {@link https://learn.microsoft.com/javascript/api/manifest/override#override-element-for-runtime | Override element for Runtime}.
|
|
8650
|
+
*
|
|
8651
|
+
* - If your add-in uses the unified manifest for Microsoft 365, the URL returned matches the value of the `script` property in the
|
|
8652
|
+
* "code" object.
|
|
8653
|
+
*/
|
|
8654
|
+
javascriptRuntimeUrl: string;
|
|
8655
|
+
}
|
|
8566
8656
|
/**
|
|
8567
8657
|
* Message used in the `onVisibilityModeChanged` invocation.
|
|
8568
8658
|
*/
|
|
@@ -8601,6 +8691,36 @@ declare namespace Office {
|
|
|
8601
8691
|
*/
|
|
8602
8692
|
ShowTaskPane = "showTaskPane"
|
|
8603
8693
|
}
|
|
8694
|
+
/**
|
|
8695
|
+
* Specifies the {@link Office.Sensitivity | sensitivity level} of an appointment.
|
|
8696
|
+
*
|
|
8697
|
+
* @remarks
|
|
8698
|
+
* [Api set: Mailbox 1.14]
|
|
8699
|
+
*
|
|
8700
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8701
|
+
*/
|
|
8702
|
+
enum AppointmentSensitivityType {
|
|
8703
|
+
/**
|
|
8704
|
+
* The item needs no special treatment.
|
|
8705
|
+
*/
|
|
8706
|
+
Normal = "normal",
|
|
8707
|
+
/**
|
|
8708
|
+
* Treat the item as personal.
|
|
8709
|
+
*
|
|
8710
|
+
* **Important**: The Personal sensitivity level is only supported in Outlook on Windows.
|
|
8711
|
+
*/
|
|
8712
|
+
Personal = "personal",
|
|
8713
|
+
/**
|
|
8714
|
+
* Treat the item as private.
|
|
8715
|
+
*/
|
|
8716
|
+
Private = "private",
|
|
8717
|
+
/**
|
|
8718
|
+
* Treat the item as confidential.
|
|
8719
|
+
*
|
|
8720
|
+
* **Important**: The Confidential sensitivity level is only supported in Outlook on Windows.
|
|
8721
|
+
*/
|
|
8722
|
+
Confidential = "confidential"
|
|
8723
|
+
}
|
|
8604
8724
|
/**
|
|
8605
8725
|
* Specifies the formatting that applies to an attachment's content.
|
|
8606
8726
|
*
|
|
@@ -9139,6 +9259,43 @@ declare namespace Office {
|
|
|
9139
9259
|
*/
|
|
9140
9260
|
Dec = "dec"
|
|
9141
9261
|
}
|
|
9262
|
+
/**
|
|
9263
|
+
* Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in.
|
|
9264
|
+
*
|
|
9265
|
+
* To learn more about the integrated spam-reporting feature, see
|
|
9266
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
9267
|
+
*
|
|
9268
|
+
* @remarks
|
|
9269
|
+
* [Api set: Mailbox 1.14]
|
|
9270
|
+
*
|
|
9271
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
9272
|
+
*
|
|
9273
|
+
* **Important**: This enum can only be used to assign values to the
|
|
9274
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-moveitemto-member | moveItemTo}
|
|
9275
|
+
* property of the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | event.completed}
|
|
9276
|
+
* method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
|
|
9277
|
+
* you must assign it different string values. For a list of supported string values, see
|
|
9278
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
|
|
9279
|
+
* Office.SpamReportingEventCompletedOptions.postProcessingAction}.
|
|
9280
|
+
*/
|
|
9281
|
+
enum MoveSpamItemTo {
|
|
9282
|
+
/**
|
|
9283
|
+
* Specifies that a reported message is moved to a custom folder in the mailbox.
|
|
9284
|
+
*/
|
|
9285
|
+
CustomFolder = "customFolder",
|
|
9286
|
+
/**
|
|
9287
|
+
* Specifies that a reported message is moved to the **Deleted Items** folder of the mailbox.
|
|
9288
|
+
*/
|
|
9289
|
+
DeletedItemsFolder = "deletedItemsFolder",
|
|
9290
|
+
/**
|
|
9291
|
+
* Specifies that a reported message is moved to the **Junk Email** folder of the mailbox.
|
|
9292
|
+
*/
|
|
9293
|
+
JunkFolder = "junkFolder",
|
|
9294
|
+
/**
|
|
9295
|
+
* Specifies that a reported message remains in its current folder in the mailbox.
|
|
9296
|
+
*/
|
|
9297
|
+
NoMove = "noMove"
|
|
9298
|
+
}
|
|
9142
9299
|
/**
|
|
9143
9300
|
* Represents the current view of Outlook on the web.
|
|
9144
9301
|
*/
|
|
@@ -9839,6 +9996,25 @@ declare namespace Office {
|
|
|
9839
9996
|
*/
|
|
9840
9997
|
Beta = "beta"
|
|
9841
9998
|
}
|
|
9999
|
+
/**
|
|
10000
|
+
* Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
|
|
10001
|
+
* that overrides the option set in the manifest at runtime.
|
|
10002
|
+
*
|
|
10003
|
+
* For information on how to implement a Smart Alerts add-in, see
|
|
10004
|
+
* {@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}.
|
|
10005
|
+
*
|
|
10006
|
+
* @remarks
|
|
10007
|
+
* [Api set: Mailbox 1.14]
|
|
10008
|
+
*
|
|
10009
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
10010
|
+
*/
|
|
10011
|
+
enum SendModeOverride {
|
|
10012
|
+
/**
|
|
10013
|
+
* 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.
|
|
10014
|
+
* 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}.
|
|
10015
|
+
*/
|
|
10016
|
+
PromptUser = "promptUser"
|
|
10017
|
+
}
|
|
9842
10018
|
/**
|
|
9843
10019
|
* Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details).
|
|
9844
10020
|
*
|
|
@@ -9902,7 +10078,7 @@ declare namespace Office {
|
|
|
9902
10078
|
*
|
|
9903
10079
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9904
10080
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9905
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10081
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
9906
10082
|
*
|
|
9907
10083
|
* Child interfaces:
|
|
9908
10084
|
*
|
|
@@ -9917,7 +10093,7 @@ declare namespace Office {
|
|
|
9917
10093
|
*
|
|
9918
10094
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9919
10095
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9920
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10096
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
9921
10097
|
*
|
|
9922
10098
|
* Parent interfaces:
|
|
9923
10099
|
*
|
|
@@ -10072,6 +10248,21 @@ declare namespace Office {
|
|
|
10072
10248
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10073
10249
|
*/
|
|
10074
10250
|
requiredAttendees: Recipients;
|
|
10251
|
+
/**
|
|
10252
|
+
* Gets or sets the {@link Office.Sensitivity | sensitivity level} of an appointment.
|
|
10253
|
+
* For information about sensitivity levels, see
|
|
10254
|
+
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
10255
|
+
*
|
|
10256
|
+
* @remarks
|
|
10257
|
+
* [Api set: Mailbox 1.14]
|
|
10258
|
+
*
|
|
10259
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10260
|
+
*
|
|
10261
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10262
|
+
*
|
|
10263
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
10264
|
+
*/
|
|
10265
|
+
sensitivity: Sensitivity;
|
|
10075
10266
|
/**
|
|
10076
10267
|
* Gets the ID of the series that an instance belongs to.
|
|
10077
10268
|
*
|
|
@@ -10302,7 +10493,7 @@ declare namespace Office {
|
|
|
10302
10493
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10303
10494
|
*
|
|
10304
10495
|
* For supported events, refer to the Item object model
|
|
10305
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10496
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
10306
10497
|
*
|
|
10307
10498
|
* @remarks
|
|
10308
10499
|
* [Api set: Mailbox 1.7]
|
|
@@ -10324,7 +10515,7 @@ declare namespace Office {
|
|
|
10324
10515
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
10325
10516
|
*
|
|
10326
10517
|
* For supported events, refer to the Item object model
|
|
10327
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10518
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
10328
10519
|
*
|
|
10329
10520
|
* @remarks
|
|
10330
10521
|
* [Api set: Mailbox 1.7]
|
|
@@ -10861,7 +11052,7 @@ declare namespace Office {
|
|
|
10861
11052
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10862
11053
|
*
|
|
10863
11054
|
* For supported events, refer to the Item object model
|
|
10864
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11055
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
10865
11056
|
*
|
|
10866
11057
|
* @remarks
|
|
10867
11058
|
* [Api set: Mailbox 1.7]
|
|
@@ -10881,7 +11072,7 @@ declare namespace Office {
|
|
|
10881
11072
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10882
11073
|
*
|
|
10883
11074
|
* For supported events, refer to the Item object model
|
|
10884
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11075
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
10885
11076
|
*
|
|
10886
11077
|
* @remarks
|
|
10887
11078
|
* [Api set: Mailbox 1.7]
|
|
@@ -11206,7 +11397,7 @@ declare namespace Office {
|
|
|
11206
11397
|
*
|
|
11207
11398
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
11208
11399
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
11209
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11400
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
11210
11401
|
*
|
|
11211
11402
|
* Parent interfaces:
|
|
11212
11403
|
*
|
|
@@ -11504,12 +11695,24 @@ declare namespace Office {
|
|
|
11504
11695
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11505
11696
|
*/
|
|
11506
11697
|
subject: string;
|
|
11507
|
-
|
|
11698
|
+
/**
|
|
11699
|
+
* Provides the sensitivity value of the appointment.
|
|
11700
|
+
*
|
|
11701
|
+
* @remarks
|
|
11702
|
+
* [Api set: Mailbox 1.14]
|
|
11703
|
+
*
|
|
11704
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11705
|
+
*
|
|
11706
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11707
|
+
*
|
|
11708
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
11709
|
+
*/
|
|
11710
|
+
sensitivity: MailboxEnums.AppointmentSensitivityType;
|
|
11508
11711
|
/**
|
|
11509
11712
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11510
11713
|
*
|
|
11511
11714
|
* For supported events, refer to the Item object model
|
|
11512
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11715
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
11513
11716
|
*
|
|
11514
11717
|
* @remarks
|
|
11515
11718
|
* [Api set: Mailbox 1.7]
|
|
@@ -11531,7 +11734,7 @@ declare namespace Office {
|
|
|
11531
11734
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11532
11735
|
*
|
|
11533
11736
|
* For supported events, refer to the Item object model
|
|
11534
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11737
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
11535
11738
|
*
|
|
11536
11739
|
* @remarks
|
|
11537
11740
|
* [Api set: Mailbox 1.7]
|
|
@@ -12143,7 +12346,7 @@ declare namespace Office {
|
|
|
12143
12346
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
12144
12347
|
*
|
|
12145
12348
|
* For supported events, refer to the Item object model
|
|
12146
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
12349
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
12147
12350
|
*
|
|
12148
12351
|
* @remarks
|
|
12149
12352
|
* [Api set: Mailbox 1.7]
|
|
@@ -12163,7 +12366,7 @@ declare namespace Office {
|
|
|
12163
12366
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
12164
12367
|
*
|
|
12165
12368
|
* For supported events, refer to the Item object model
|
|
12166
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
12369
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
12167
12370
|
*
|
|
12168
12371
|
* @remarks
|
|
12169
12372
|
* [Api set: Mailbox 1.7]
|
|
@@ -14077,7 +14280,7 @@ declare namespace Office {
|
|
|
14077
14280
|
* You can determine the type of the item by using the `itemType` property.
|
|
14078
14281
|
*
|
|
14079
14282
|
* To see the full member list, refer to the
|
|
14080
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14283
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
14081
14284
|
*
|
|
14082
14285
|
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
14083
14286
|
*
|
|
@@ -14102,7 +14305,7 @@ declare namespace Office {
|
|
|
14102
14305
|
*
|
|
14103
14306
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14104
14307
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14105
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14308
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
14106
14309
|
*
|
|
14107
14310
|
* Child interfaces:
|
|
14108
14311
|
*
|
|
@@ -14117,7 +14320,7 @@ declare namespace Office {
|
|
|
14117
14320
|
*
|
|
14118
14321
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14119
14322
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14120
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14323
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
14121
14324
|
*
|
|
14122
14325
|
* Child interfaces:
|
|
14123
14326
|
*
|
|
@@ -14442,7 +14645,7 @@ declare namespace Office {
|
|
|
14442
14645
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
14443
14646
|
*
|
|
14444
14647
|
* For supported events, refer to the Mailbox object model
|
|
14445
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14648
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox#events | events section}.
|
|
14446
14649
|
*
|
|
14447
14650
|
* @remarks
|
|
14448
14651
|
* [Api set: Mailbox 1.5]
|
|
@@ -14463,7 +14666,7 @@ declare namespace Office {
|
|
|
14463
14666
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
14464
14667
|
*
|
|
14465
14668
|
* For supported events, refer to the Mailbox object model
|
|
14466
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14669
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox#events | events section}.
|
|
14467
14670
|
*
|
|
14468
14671
|
* @remarks
|
|
14469
14672
|
* [Api set: Mailbox 1.5]
|
|
@@ -15260,7 +15463,7 @@ declare namespace Office {
|
|
|
15260
15463
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15261
15464
|
*
|
|
15262
15465
|
* For supported events, refer to the Mailbox object model
|
|
15263
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15466
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox#events | events section}.
|
|
15264
15467
|
*
|
|
15265
15468
|
* @remarks
|
|
15266
15469
|
* [Api set: Mailbox 1.5]
|
|
@@ -15279,7 +15482,7 @@ declare namespace Office {
|
|
|
15279
15482
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15280
15483
|
*
|
|
15281
15484
|
* For supported events, refer to the Mailbox object model
|
|
15282
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15485
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox#events | events section}.
|
|
15283
15486
|
*
|
|
15284
15487
|
* @remarks
|
|
15285
15488
|
* [Api set: Mailbox 1.5]
|
|
@@ -15297,7 +15500,8 @@ declare namespace Office {
|
|
|
15297
15500
|
/**
|
|
15298
15501
|
* The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements
|
|
15299
15502
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}, including
|
|
15300
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}
|
|
15503
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts},
|
|
15504
|
+
* or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
15301
15505
|
* It allows the add-in to signify to the Outlook client that it has completed processing an event.
|
|
15302
15506
|
*
|
|
15303
15507
|
* @remarks
|
|
@@ -15306,10 +15510,12 @@ declare namespace Office {
|
|
|
15306
15510
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
15307
15511
|
*
|
|
15308
15512
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15513
|
+
*
|
|
15514
|
+
* **Important**: Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15309
15515
|
*/
|
|
15310
15516
|
interface MailboxEvent {
|
|
15311
15517
|
/**
|
|
15312
|
-
* Indicates that the event-based add-in has completed processing an event.
|
|
15518
|
+
* Indicates that the event-based or spam-reporting add-in has completed processing an event.
|
|
15313
15519
|
*
|
|
15314
15520
|
* @remarks
|
|
15315
15521
|
* [Api set: Mailbox 1.10]
|
|
@@ -15318,9 +15524,15 @@ declare namespace Office {
|
|
|
15318
15524
|
*
|
|
15319
15525
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15320
15526
|
*
|
|
15321
|
-
*
|
|
15527
|
+
* **Important**:
|
|
15528
|
+
*
|
|
15529
|
+
* - Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
15530
|
+
*
|
|
15531
|
+
* - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12.
|
|
15532
|
+
*
|
|
15533
|
+
* @param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event.
|
|
15322
15534
|
*/
|
|
15323
|
-
completed(options?: SmartAlertsEventCompletedOptions): void;
|
|
15535
|
+
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;
|
|
15324
15536
|
}
|
|
15325
15537
|
/**
|
|
15326
15538
|
* Represents the categories master list on the mailbox.
|
|
@@ -15521,7 +15733,7 @@ declare namespace Office {
|
|
|
15521
15733
|
*
|
|
15522
15734
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15523
15735
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
15524
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15736
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
15525
15737
|
*
|
|
15526
15738
|
* Child interfaces:
|
|
15527
15739
|
*
|
|
@@ -15536,7 +15748,7 @@ declare namespace Office {
|
|
|
15536
15748
|
*
|
|
15537
15749
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15538
15750
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
15539
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15751
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
15540
15752
|
*
|
|
15541
15753
|
* Parent interfaces:
|
|
15542
15754
|
*
|
|
@@ -15644,6 +15856,19 @@ declare namespace Office {
|
|
|
15644
15856
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
15645
15857
|
*/
|
|
15646
15858
|
from: From;
|
|
15859
|
+
/**
|
|
15860
|
+
* Gets the message ID of the original message being replied to by the current message.
|
|
15861
|
+
*
|
|
15862
|
+
* @remarks
|
|
15863
|
+
* [Api set: Mailbox 1.14]
|
|
15864
|
+
*
|
|
15865
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15866
|
+
*
|
|
15867
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15868
|
+
*
|
|
15869
|
+
* **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.
|
|
15870
|
+
*/
|
|
15871
|
+
inReplyTo: string;
|
|
15647
15872
|
/**
|
|
15648
15873
|
* Gets or sets the custom internet headers of a message.
|
|
15649
15874
|
*
|
|
@@ -15934,7 +16159,7 @@ declare namespace Office {
|
|
|
15934
16159
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15935
16160
|
*
|
|
15936
16161
|
* For supported events, refer to the Item object model
|
|
15937
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16162
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
15938
16163
|
*
|
|
15939
16164
|
* @remarks
|
|
15940
16165
|
* [Api set: Mailbox 1.7]
|
|
@@ -15956,7 +16181,7 @@ declare namespace Office {
|
|
|
15956
16181
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15957
16182
|
*
|
|
15958
16183
|
* For supported events, refer to the Item object model
|
|
15959
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16184
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
15960
16185
|
*
|
|
15961
16186
|
* @remarks
|
|
15962
16187
|
* [Api set: Mailbox 1.7]
|
|
@@ -16055,8 +16280,71 @@ declare namespace Office {
|
|
|
16055
16280
|
*
|
|
16056
16281
|
* **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,
|
|
16057
16282
|
* discard, or cancel even if no changes have occurred since the item was last saved.
|
|
16283
|
+
*
|
|
16284
|
+
* **Tip**: Use the
|
|
16285
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1) | closeAsync}
|
|
16286
|
+
* method instead of the `close` method if you want your add-in to:
|
|
16287
|
+
*
|
|
16288
|
+
* - Automatically discard a message being composed without prompting the user with the save dialog.
|
|
16289
|
+
*
|
|
16290
|
+
* - Determine when a user cancels the save item dialog on a message being composed.
|
|
16291
|
+
*
|
|
16292
|
+
* - Close a reply in the Reading Pane or an existing draft from an Outlook desktop client.
|
|
16058
16293
|
*/
|
|
16059
16294
|
close(): void;
|
|
16295
|
+
/**
|
|
16296
|
+
* Closes the current message being composed with the option to discard unsaved changes.
|
|
16297
|
+
* The message being composed can be a new message, reply, or an existing draft.
|
|
16298
|
+
*
|
|
16299
|
+
* @remarks
|
|
16300
|
+
* [Api set: Mailbox 1.14]
|
|
16301
|
+
*
|
|
16302
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16303
|
+
*
|
|
16304
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16305
|
+
*
|
|
16306
|
+
* **Errors**:
|
|
16307
|
+
*
|
|
16308
|
+
* - `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`.
|
|
16309
|
+
*
|
|
16310
|
+
* - `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
|
|
16311
|
+
* is set to `false`.
|
|
16312
|
+
*
|
|
16313
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16314
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16315
|
+
* `discardItem`: If `true`, the current message being composed is closed and unsaved changes are discarded. When the parameter isn't declared or is
|
|
16316
|
+
* 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
|
|
16317
|
+
* 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
|
|
16318
|
+
* return an error. For more information on the error, see the Remarks section.
|
|
16319
|
+
*
|
|
16320
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16321
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16322
|
+
*/
|
|
16323
|
+
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16324
|
+
/**
|
|
16325
|
+
* Closes the current new message being composed.
|
|
16326
|
+
*
|
|
16327
|
+
* 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
|
|
16328
|
+
* 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,
|
|
16329
|
+
* discard changes, or cancel the operation.
|
|
16330
|
+
*
|
|
16331
|
+
* @remarks
|
|
16332
|
+
* [Api set: Mailbox 1.14]
|
|
16333
|
+
*
|
|
16334
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
16335
|
+
*
|
|
16336
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16337
|
+
*
|
|
16338
|
+
* **Errors**:
|
|
16339
|
+
*
|
|
16340
|
+
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
|
|
16341
|
+
*
|
|
16342
|
+
* - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft.
|
|
16343
|
+
*
|
|
16344
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
16345
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16346
|
+
*/
|
|
16347
|
+
closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16060
16348
|
/**
|
|
16061
16349
|
* Disables the Outlook client signature.
|
|
16062
16350
|
*
|
|
@@ -16255,6 +16543,44 @@ declare namespace Office {
|
|
|
16255
16543
|
* An object with `ComposeType` and `CoercionType` enum values for the message item.
|
|
16256
16544
|
*/
|
|
16257
16545
|
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
16546
|
+
/**
|
|
16547
|
+
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16548
|
+
*
|
|
16549
|
+
* @remarks
|
|
16550
|
+
* [Api set: Mailbox 1.14]
|
|
16551
|
+
*
|
|
16552
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16553
|
+
*
|
|
16554
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16555
|
+
*
|
|
16556
|
+
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16557
|
+
* to provide context for the current message being composed.
|
|
16558
|
+
*
|
|
16559
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16560
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16561
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16562
|
+
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16563
|
+
* property.
|
|
16564
|
+
*/
|
|
16565
|
+
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16566
|
+
/**
|
|
16567
|
+
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
16568
|
+
*
|
|
16569
|
+
* @remarks
|
|
16570
|
+
* [Api set: Mailbox 1.14]
|
|
16571
|
+
*
|
|
16572
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16573
|
+
*
|
|
16574
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16575
|
+
*
|
|
16576
|
+
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
16577
|
+
* to provide context for the current message being composed.
|
|
16578
|
+
*
|
|
16579
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16580
|
+
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
16581
|
+
* property.
|
|
16582
|
+
*/
|
|
16583
|
+
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16258
16584
|
/**
|
|
16259
16585
|
* Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
|
|
16260
16586
|
*
|
|
@@ -16290,52 +16616,152 @@ declare namespace Office {
|
|
|
16290
16616
|
*/
|
|
16291
16617
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16292
16618
|
/**
|
|
16293
|
-
*
|
|
16294
|
-
*
|
|
16295
|
-
* When invoked, this method returns the item ID via the callback function.
|
|
16296
|
-
*
|
|
16297
|
-
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
16298
|
-
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
16299
|
-
* Until the item is synced, the `itemId` is not recognized and using it returns an error.
|
|
16619
|
+
* Gets the Exchange Web Services item class of the selected message.
|
|
16300
16620
|
*
|
|
16301
16621
|
* @remarks
|
|
16302
|
-
* [Api set: Mailbox 1.
|
|
16622
|
+
* [Api set: Mailbox 1.14]
|
|
16303
16623
|
*
|
|
16304
16624
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16305
16625
|
*
|
|
16306
16626
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16307
16627
|
*
|
|
16308
|
-
* **
|
|
16628
|
+
* **Important**:
|
|
16309
16629
|
*
|
|
16310
|
-
*
|
|
16630
|
+
* The following table lists the default message classes.
|
|
16631
|
+
*
|
|
16632
|
+
* <table>
|
|
16633
|
+
* <tr>
|
|
16634
|
+
* <th>Item class</th>
|
|
16635
|
+
* <th>Description</th>
|
|
16636
|
+
* </tr>
|
|
16637
|
+
* <tr>
|
|
16638
|
+
* <td>IPM.Note</td>
|
|
16639
|
+
* <td>New messages and message replies</td>
|
|
16640
|
+
* </tr>
|
|
16641
|
+
* <tr>
|
|
16642
|
+
* <td>IPM.Schedule.Meeting.Request</td>
|
|
16643
|
+
* <td>Meeting requests</td>
|
|
16644
|
+
* </tr>
|
|
16645
|
+
* <tr>
|
|
16646
|
+
* <td>IPM.Schedule.Meeting.Canceled</td>
|
|
16647
|
+
* <td>Meeting cancellations</td>
|
|
16648
|
+
* </tr>
|
|
16649
|
+
* <tr>
|
|
16650
|
+
* <td>IPM.Schedule.Meeting.Resp.Neg</td>
|
|
16651
|
+
* <td>Responses to decline meeting requests</td>
|
|
16652
|
+
* </tr>
|
|
16653
|
+
* <tr>
|
|
16654
|
+
* <td>IPM.Schedule.Meeting.Resp.Pos</td>
|
|
16655
|
+
* <td>Responses to accept meeting requests</td>
|
|
16656
|
+
* </tr>
|
|
16657
|
+
* <tr>
|
|
16658
|
+
* <td>IPM.Schedule.Meeting.Resp.Tent</td>
|
|
16659
|
+
* <td>Responses to tentatively accept meeting requests</td>
|
|
16660
|
+
* </tr>
|
|
16661
|
+
* </table>
|
|
16311
16662
|
*
|
|
16312
16663
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16313
16664
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16314
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16315
|
-
*
|
|
16665
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16666
|
+
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
16316
16667
|
*/
|
|
16317
|
-
|
|
16668
|
+
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16318
16669
|
/**
|
|
16319
|
-
*
|
|
16320
|
-
*
|
|
16321
|
-
* When invoked, this method returns the item ID via the callback function.
|
|
16322
|
-
*
|
|
16323
|
-
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
16324
|
-
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
16325
|
-
* Until the item is synced, the `itemId` is not recognized and using it returns an error.
|
|
16670
|
+
* Gets the Exchange Web Services item class of the selected message.
|
|
16326
16671
|
*
|
|
16327
16672
|
* @remarks
|
|
16328
|
-
* [Api set: Mailbox 1.
|
|
16673
|
+
* [Api set: Mailbox 1.14]
|
|
16329
16674
|
*
|
|
16330
16675
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16331
16676
|
*
|
|
16332
16677
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16333
16678
|
*
|
|
16334
|
-
* **
|
|
16679
|
+
* **Important**:
|
|
16335
16680
|
*
|
|
16336
|
-
*
|
|
16681
|
+
* The following table lists the default message classes.
|
|
16337
16682
|
*
|
|
16338
|
-
*
|
|
16683
|
+
* <table>
|
|
16684
|
+
* <tr>
|
|
16685
|
+
* <th>Item class</th>
|
|
16686
|
+
* <th>Description</th>
|
|
16687
|
+
* </tr>
|
|
16688
|
+
* <tr>
|
|
16689
|
+
* <td>IPM.Note</td>
|
|
16690
|
+
* <td>New messages and message replies</td>
|
|
16691
|
+
* </tr>
|
|
16692
|
+
* <tr>
|
|
16693
|
+
* <td>IPM.Schedule.Meeting.Request</td>
|
|
16694
|
+
* <td>Meeting requests</td>
|
|
16695
|
+
* </tr>
|
|
16696
|
+
* <tr>
|
|
16697
|
+
* <td>IPM.Schedule.Meeting.Canceled</td>
|
|
16698
|
+
* <td>Meeting cancellations</td>
|
|
16699
|
+
* </tr>
|
|
16700
|
+
* <tr>
|
|
16701
|
+
* <td>IPM.Schedule.Meeting.Resp.Neg</td>
|
|
16702
|
+
* <td>Responses to decline meeting requests</td>
|
|
16703
|
+
* </tr>
|
|
16704
|
+
* <tr>
|
|
16705
|
+
* <td>IPM.Schedule.Meeting.Resp.Pos</td>
|
|
16706
|
+
* <td>Responses to accept meeting requests</td>
|
|
16707
|
+
* </tr>
|
|
16708
|
+
* <tr>
|
|
16709
|
+
* <td>IPM.Schedule.Meeting.Resp.Tent</td>
|
|
16710
|
+
* <td>Responses to tentatively accept meeting requests</td>
|
|
16711
|
+
* </tr>
|
|
16712
|
+
* </table>
|
|
16713
|
+
*
|
|
16714
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16715
|
+
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
16716
|
+
*/
|
|
16717
|
+
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16718
|
+
/**
|
|
16719
|
+
* Asynchronously gets the ID of a saved item.
|
|
16720
|
+
*
|
|
16721
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
16722
|
+
*
|
|
16723
|
+
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
16724
|
+
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
16725
|
+
* Until the item is synced, the `itemId` is not recognized and using it returns an error.
|
|
16726
|
+
*
|
|
16727
|
+
* @remarks
|
|
16728
|
+
* [Api set: Mailbox 1.8]
|
|
16729
|
+
*
|
|
16730
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16731
|
+
*
|
|
16732
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16733
|
+
*
|
|
16734
|
+
* **Errors**:
|
|
16735
|
+
*
|
|
16736
|
+
* - `ItemNotSaved`: The ID can't be retrieved until the item is saved.
|
|
16737
|
+
*
|
|
16738
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16739
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16740
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16741
|
+
* of type `Office.AsyncResult`.
|
|
16742
|
+
*/
|
|
16743
|
+
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16744
|
+
/**
|
|
16745
|
+
* Asynchronously gets the ID of a saved item.
|
|
16746
|
+
*
|
|
16747
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
16748
|
+
*
|
|
16749
|
+
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
16750
|
+
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
16751
|
+
* Until the item is synced, the `itemId` is not recognized and using it returns an error.
|
|
16752
|
+
*
|
|
16753
|
+
* @remarks
|
|
16754
|
+
* [Api set: Mailbox 1.8]
|
|
16755
|
+
*
|
|
16756
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16757
|
+
*
|
|
16758
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16759
|
+
*
|
|
16760
|
+
* **Errors**:
|
|
16761
|
+
*
|
|
16762
|
+
* - `ItemNotSaved`: The ID can't be retrieved until the item is saved.
|
|
16763
|
+
*
|
|
16764
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16339
16765
|
* of type `Office.AsyncResult`.
|
|
16340
16766
|
*/
|
|
16341
16767
|
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
@@ -16599,7 +17025,7 @@ declare namespace Office {
|
|
|
16599
17025
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16600
17026
|
*
|
|
16601
17027
|
* For supported events, refer to the Item object model
|
|
16602
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17028
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
16603
17029
|
*
|
|
16604
17030
|
* @remarks
|
|
16605
17031
|
* [Api set: Mailbox 1.7]
|
|
@@ -16619,7 +17045,7 @@ declare namespace Office {
|
|
|
16619
17045
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16620
17046
|
*
|
|
16621
17047
|
* For supported events, refer to the Item object model
|
|
16622
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17048
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
16623
17049
|
*
|
|
16624
17050
|
* @remarks
|
|
16625
17051
|
* [Api set: Mailbox 1.7]
|
|
@@ -16767,7 +17193,7 @@ declare namespace Office {
|
|
|
16767
17193
|
*
|
|
16768
17194
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
16769
17195
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
16770
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17196
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item | Object Model} page.
|
|
16771
17197
|
*
|
|
16772
17198
|
* Parent interfaces:
|
|
16773
17199
|
*
|
|
@@ -17147,12 +17573,11 @@ declare namespace Office {
|
|
|
17147
17573
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17148
17574
|
*/
|
|
17149
17575
|
to: EmailAddressDetails[];
|
|
17150
|
-
|
|
17151
17576
|
/**
|
|
17152
17577
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
17153
17578
|
*
|
|
17154
17579
|
* For supported events, refer to the Item object model
|
|
17155
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17580
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
17156
17581
|
*
|
|
17157
17582
|
* @remarks
|
|
17158
17583
|
* [Api set: Mailbox 1.7]
|
|
@@ -17174,7 +17599,7 @@ declare namespace Office {
|
|
|
17174
17599
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
17175
17600
|
*
|
|
17176
17601
|
* For supported events, refer to the Item object model
|
|
17177
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
17602
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
17178
17603
|
*
|
|
17179
17604
|
* @remarks
|
|
17180
17605
|
* [Api set: Mailbox 1.7]
|
|
@@ -17391,6 +17816,38 @@ declare namespace Office {
|
|
|
17391
17816
|
* If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
|
|
17392
17817
|
*/
|
|
17393
17818
|
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17819
|
+
/**
|
|
17820
|
+
* Gets the current message in EML format encoded in Base64.
|
|
17821
|
+
*
|
|
17822
|
+
* @remarks
|
|
17823
|
+
* [Api set: Mailbox 1.14]
|
|
17824
|
+
*
|
|
17825
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17826
|
+
*
|
|
17827
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17828
|
+
*
|
|
17829
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
17830
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17831
|
+
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
17832
|
+
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
17833
|
+
* returned in the `asyncResult.error` property.
|
|
17834
|
+
*/
|
|
17835
|
+
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17836
|
+
/**
|
|
17837
|
+
* Gets the current message in EML format encoded in Base64.
|
|
17838
|
+
*
|
|
17839
|
+
* @remarks
|
|
17840
|
+
* [Api set: Mailbox 1.14]
|
|
17841
|
+
*
|
|
17842
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17843
|
+
*
|
|
17844
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17845
|
+
*
|
|
17846
|
+
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
17847
|
+
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
17848
|
+
* returned in the `asyncResult.error` property.
|
|
17849
|
+
*/
|
|
17850
|
+
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17394
17851
|
/**
|
|
17395
17852
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
17396
17853
|
*
|
|
@@ -17834,7 +18291,7 @@ declare namespace Office {
|
|
|
17834
18291
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
17835
18292
|
*
|
|
17836
18293
|
* For supported events, refer to the Item object model
|
|
17837
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
18294
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
17838
18295
|
*
|
|
17839
18296
|
* @remarks
|
|
17840
18297
|
* [Api set: Mailbox 1.7]
|
|
@@ -17854,7 +18311,7 @@ declare namespace Office {
|
|
|
17854
18311
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
17855
18312
|
*
|
|
17856
18313
|
* For supported events, refer to the Item object model
|
|
17857
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
18314
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/office.context.mailbox.item#events | events section}.
|
|
17858
18315
|
*
|
|
17859
18316
|
* @remarks
|
|
17860
18317
|
* [Api set: Mailbox 1.7]
|
|
@@ -18146,6 +18603,28 @@ declare namespace Office {
|
|
|
18146
18603
|
*/
|
|
18147
18604
|
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18148
18605
|
}
|
|
18606
|
+
/**
|
|
18607
|
+
* Provides the updated Office theme that raised the `Office.EventType.OfficeThemeChanged` event.
|
|
18608
|
+
*
|
|
18609
|
+
* @remarks
|
|
18610
|
+
* [Api set: Mailbox 1.14]
|
|
18611
|
+
*/
|
|
18612
|
+
export interface OfficeThemeChangedEventArgs {
|
|
18613
|
+
/**
|
|
18614
|
+
* Gets the updated Office theme.
|
|
18615
|
+
*
|
|
18616
|
+
* @remarks
|
|
18617
|
+
* [Api set: Mailbox 1.14]
|
|
18618
|
+
*/
|
|
18619
|
+
officeTheme: Office.OfficeTheme;
|
|
18620
|
+
/**
|
|
18621
|
+
* Gets the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
18622
|
+
*
|
|
18623
|
+
* @remarks
|
|
18624
|
+
* [Api set: Mailbox 1.14]
|
|
18625
|
+
*/
|
|
18626
|
+
type: "officeThemeChanged";
|
|
18627
|
+
}
|
|
18149
18628
|
/**
|
|
18150
18629
|
* Represents the appointment organizer, even if an alias or a delegate was used to create the appointment.
|
|
18151
18630
|
* This object provides a method to get the organizer value of an appointment in an Outlook add-in.
|
|
@@ -18985,23 +19464,179 @@ declare namespace Office {
|
|
|
18985
19464
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
18986
19465
|
*/
|
|
18987
19466
|
interface SelectedItemDetails {
|
|
19467
|
+
/**
|
|
19468
|
+
* The identifier of the message conversation that contains the message that's currently selected.
|
|
19469
|
+
*
|
|
19470
|
+
* @remarks
|
|
19471
|
+
* [Api set: Mailbox 1.14]
|
|
19472
|
+
*
|
|
19473
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19474
|
+
*
|
|
19475
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19476
|
+
*/
|
|
19477
|
+
conversationId: string;
|
|
19478
|
+
/**
|
|
19479
|
+
* Returns `true` if the message that's currently selected contains an attachment.
|
|
19480
|
+
*
|
|
19481
|
+
* @remarks
|
|
19482
|
+
* [Api set: Mailbox 1.14]
|
|
19483
|
+
*
|
|
19484
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19485
|
+
*
|
|
19486
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19487
|
+
*/
|
|
19488
|
+
hasAttachment: boolean;
|
|
19489
|
+
/**
|
|
19490
|
+
* The internet message identifier of the message that's currently selected.
|
|
19491
|
+
*
|
|
19492
|
+
* @remarks
|
|
19493
|
+
* [Api set: Mailbox 1.14]
|
|
19494
|
+
*
|
|
19495
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19496
|
+
*
|
|
19497
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19498
|
+
*/
|
|
19499
|
+
internetMessageId: string;
|
|
18988
19500
|
/**
|
|
18989
19501
|
* The Exchange Web Services (EWS) item identifier of the message that's currently selected.
|
|
19502
|
+
*
|
|
19503
|
+
* @remarks
|
|
19504
|
+
* [Api set: Mailbox 1.13]
|
|
19505
|
+
*
|
|
19506
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19507
|
+
*
|
|
19508
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
18990
19509
|
*/
|
|
18991
19510
|
itemId: string;
|
|
18992
19511
|
/**
|
|
18993
19512
|
* The Outlook mode (`Read` or `Compose`) of the message that's currently selected.
|
|
19513
|
+
*
|
|
19514
|
+
* @remarks
|
|
19515
|
+
* [Api set: Mailbox 1.13]
|
|
19516
|
+
*
|
|
19517
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19518
|
+
*
|
|
19519
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
18994
19520
|
*/
|
|
18995
19521
|
itemMode: string;
|
|
18996
19522
|
/**
|
|
18997
19523
|
* The type of the item that's currently selected. `Message` is the only supported type at this time.
|
|
19524
|
+
*
|
|
19525
|
+
* @remarks
|
|
19526
|
+
* [Api set: Mailbox 1.13]
|
|
19527
|
+
*
|
|
19528
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19529
|
+
*
|
|
19530
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
18998
19531
|
*/
|
|
18999
19532
|
itemType: MailboxEnums.ItemType | string;
|
|
19000
19533
|
/**
|
|
19001
19534
|
* The description that appears in the subject field of the message that's currently selected.
|
|
19535
|
+
*
|
|
19536
|
+
* @remarks
|
|
19537
|
+
* [Api set: Mailbox 1.13]
|
|
19538
|
+
*
|
|
19539
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
19540
|
+
*
|
|
19541
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
|
|
19002
19542
|
*/
|
|
19003
19543
|
subject: string;
|
|
19004
19544
|
}
|
|
19545
|
+
/**
|
|
19546
|
+
* Provides methods to get and set the sensitivity level of an appointment. To learn more about sensitivity levels, see
|
|
19547
|
+
* {@link https://support.microsoft.com/office/4a76d05b-6c29-4a0d-9096-71784a6b12c1 | Mark your email as Normal, Personal, Private, or Confidential}.
|
|
19548
|
+
*
|
|
19549
|
+
* @remarks
|
|
19550
|
+
* [Api set: Mailbox 1.14]
|
|
19551
|
+
*
|
|
19552
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19553
|
+
*
|
|
19554
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19555
|
+
*/
|
|
19556
|
+
interface Sensitivity {
|
|
19557
|
+
/**
|
|
19558
|
+
* Gets the sensitivity level of an appointment.
|
|
19559
|
+
*
|
|
19560
|
+
* @remarks
|
|
19561
|
+
* [Api set: Mailbox 1.14]
|
|
19562
|
+
*
|
|
19563
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19564
|
+
*
|
|
19565
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19566
|
+
*
|
|
19567
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19568
|
+
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19569
|
+
* is returned in the `asyncResult.value` property.
|
|
19570
|
+
*
|
|
19571
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
19572
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19573
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19574
|
+
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19575
|
+
*/
|
|
19576
|
+
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19577
|
+
/**
|
|
19578
|
+
* Gets the sensitivity level of an appointment.
|
|
19579
|
+
*
|
|
19580
|
+
* @remarks
|
|
19581
|
+
* [Api set: Mailbox 1.14]
|
|
19582
|
+
*
|
|
19583
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19584
|
+
*
|
|
19585
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19586
|
+
*
|
|
19587
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19588
|
+
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19589
|
+
* is returned in the `asyncResult.value` property.
|
|
19590
|
+
*
|
|
19591
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19592
|
+
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19593
|
+
*/
|
|
19594
|
+
getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
19595
|
+
/**
|
|
19596
|
+
* Sets the sensitivity level of an appointment.
|
|
19597
|
+
*
|
|
19598
|
+
* @remarks
|
|
19599
|
+
* [Api set: Mailbox 1.14]
|
|
19600
|
+
*
|
|
19601
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
19602
|
+
*
|
|
19603
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19604
|
+
*
|
|
19605
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19606
|
+
*
|
|
19607
|
+
* **Errors**:
|
|
19608
|
+
*
|
|
19609
|
+
* - `Unsupported API parameter`: Setting the sensitivity level of an appointment isn't supported.
|
|
19610
|
+
*
|
|
19611
|
+
* @param sensitivity - The sensitivity level as an enum or string.
|
|
19612
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
19613
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19614
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19615
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
19616
|
+
*/
|
|
19617
|
+
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
19618
|
+
/**
|
|
19619
|
+
* Sets the sensitivity level of an appointment.
|
|
19620
|
+
*
|
|
19621
|
+
* @remarks
|
|
19622
|
+
* [Api set: Mailbox 1.14]
|
|
19623
|
+
*
|
|
19624
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
19625
|
+
*
|
|
19626
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19627
|
+
*
|
|
19628
|
+
* **Important**: Outlook on the web, new Outlook on Windows (preview), and Outlook on Mac only support Normal and Private sensitivity levels.
|
|
19629
|
+
*
|
|
19630
|
+
* **Errors**:
|
|
19631
|
+
*
|
|
19632
|
+
* - `Unsupported API parameter`: Setting the sensitivity level of an appointment isn't supported.
|
|
19633
|
+
*
|
|
19634
|
+
* @param sensitivity - The sensitivity level as an enum or string.
|
|
19635
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19636
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
19637
|
+
*/
|
|
19638
|
+
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
19639
|
+
}
|
|
19005
19640
|
/**
|
|
19006
19641
|
* Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
|
|
19007
19642
|
* {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
|
|
@@ -19637,10 +20272,18 @@ declare namespace Office {
|
|
|
19637
20272
|
/**
|
|
19638
20273
|
* Specifies the behavior of a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in}
|
|
19639
20274
|
* when it completes processing an `OnMessageSend` or `OnAppointmentSend` event.
|
|
20275
|
+
*
|
|
20276
|
+
* @remarks
|
|
20277
|
+
*
|
|
20278
|
+
* [Api set: Mailbox 1.12]
|
|
20279
|
+
*
|
|
20280
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20281
|
+
*
|
|
20282
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19640
20283
|
*/
|
|
19641
20284
|
interface SmartAlertsEventCompletedOptions {
|
|
19642
20285
|
/**
|
|
19643
|
-
* When you use the {@link
|
|
20286
|
+
* 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,
|
|
19644
20287
|
* this value indicates if the handled event should continue execution or be canceled.
|
|
19645
20288
|
* For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the sending of an item.
|
|
19646
20289
|
* For a complete sample, see the
|
|
@@ -19656,7 +20299,76 @@ declare namespace Office {
|
|
|
19656
20299
|
*/
|
|
19657
20300
|
allowEvent?: boolean;
|
|
19658
20301
|
/**
|
|
19659
|
-
* When you use the {@link
|
|
20302
|
+
* 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`,
|
|
20303
|
+
* this property customizes the text of the **Don't Send** button in the Smart Alerts dialog. Custom text must be 20 characters or less.
|
|
20304
|
+
*
|
|
20305
|
+
* For an example, see the
|
|
20306
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20307
|
+
*
|
|
20308
|
+
* @remarks
|
|
20309
|
+
*
|
|
20310
|
+
* [Api set: Mailbox 1.14]
|
|
20311
|
+
*
|
|
20312
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20313
|
+
*
|
|
20314
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20315
|
+
*/
|
|
20316
|
+
cancelLabel?: string;
|
|
20317
|
+
/**
|
|
20318
|
+
* 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`,
|
|
20319
|
+
* this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
|
|
20320
|
+
*
|
|
20321
|
+
* For an example, see the
|
|
20322
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
|
|
20323
|
+
*
|
|
20324
|
+
* @remarks
|
|
20325
|
+
*
|
|
20326
|
+
* [Api set: Mailbox 1.14]
|
|
20327
|
+
*
|
|
20328
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20329
|
+
*
|
|
20330
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20331
|
+
*
|
|
20332
|
+
* **Important**:
|
|
20333
|
+
*
|
|
20334
|
+
* The `commandId` value must match the task pane ID specified in the manifest of your add-in. The markup depends on the type of manifest your
|
|
20335
|
+
* add-in uses.
|
|
20336
|
+
*
|
|
20337
|
+
* - **XML manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
|
|
20338
|
+
*
|
|
20339
|
+
* - **Unified manifest for Microsoft 365 (preview)**: The "id" property of the task pane command in the "controls" array.
|
|
20340
|
+
*
|
|
20341
|
+
* If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
20342
|
+
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
20343
|
+
*/
|
|
20344
|
+
commandId?: string;
|
|
20345
|
+
/**
|
|
20346
|
+
* 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`,
|
|
20347
|
+
* 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.
|
|
20348
|
+
*
|
|
20349
|
+
* @remarks
|
|
20350
|
+
*
|
|
20351
|
+
* [Api set: Mailbox 1.14]
|
|
20352
|
+
*
|
|
20353
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20354
|
+
*
|
|
20355
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20356
|
+
*
|
|
20357
|
+
* **Important**:
|
|
20358
|
+
*
|
|
20359
|
+
* - In Outlook on Windows, the `any` type is supported starting in Version 2402 (Build 17308.20000). In earlier versions of Outlook on Windows, only the `string`
|
|
20360
|
+
* type is supported.
|
|
20361
|
+
*
|
|
20362
|
+
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
20363
|
+
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
20364
|
+
*
|
|
20365
|
+
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
20366
|
+
* 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
|
|
20367
|
+
* `JSON.parse()` once you retrieve it.
|
|
20368
|
+
*/
|
|
20369
|
+
contextData?: any;
|
|
20370
|
+
/**
|
|
20371
|
+
* 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
|
|
19660
20372
|
* to `false`, this property sets the error message that will be displayed to the user. For an example, see the
|
|
19661
20373
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
19662
20374
|
*
|
|
@@ -19669,6 +20381,195 @@ declare namespace Office {
|
|
|
19669
20381
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19670
20382
|
*/
|
|
19671
20383
|
errorMessage?: string;
|
|
20384
|
+
/**
|
|
20385
|
+
* 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
|
|
20386
|
+
* and set its `allowEvent` property to `false`, this property overrides the
|
|
20387
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
|
|
20388
|
+
* specified in the manifest at runtime.
|
|
20389
|
+
*
|
|
20390
|
+
* For an example, see the
|
|
20391
|
+
* {@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}.
|
|
20392
|
+
*
|
|
20393
|
+
* @remarks
|
|
20394
|
+
*
|
|
20395
|
+
* [Api set: Mailbox 1.14]
|
|
20396
|
+
*
|
|
20397
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
20398
|
+
*
|
|
20399
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20400
|
+
*
|
|
20401
|
+
* **Important**: Currently, `sendModeOverride` can only be set to the
|
|
20402
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#prompt-user | prompt user} option.
|
|
20403
|
+
*/
|
|
20404
|
+
sendModeOverride?: MailboxEnums.SendModeOverride | string;
|
|
20405
|
+
}
|
|
20406
|
+
/**
|
|
20407
|
+
* Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
|
|
20408
|
+
*
|
|
20409
|
+
* @remarks
|
|
20410
|
+
* [Api set: Mailbox 1.14]
|
|
20411
|
+
*/
|
|
20412
|
+
export interface SpamReportingEventArgs {
|
|
20413
|
+
/**
|
|
20414
|
+
* The text provided by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20415
|
+
*
|
|
20416
|
+
* @remarks
|
|
20417
|
+
* [Api set: Mailbox 1.14]
|
|
20418
|
+
*
|
|
20419
|
+
* To add an optional text box to the preprocessing dialog of your spam-reporting add-in, you must configure the
|
|
20420
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/preprocessingdialog#child-elements | FreeTextLabel}
|
|
20421
|
+
* element in the manifest of your add-in.
|
|
20422
|
+
*
|
|
20423
|
+
* To learn more about how to develop a spam-reporting add-in, see
|
|
20424
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20425
|
+
*/
|
|
20426
|
+
freeText: string;
|
|
20427
|
+
/**
|
|
20428
|
+
* Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.
|
|
20429
|
+
*
|
|
20430
|
+
* @remarks
|
|
20431
|
+
* [Api set: Mailbox 1.14]
|
|
20432
|
+
*
|
|
20433
|
+
* The order of the booleans in the array corresponds to the order of the reporting options specified in the
|
|
20434
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/reportingoptions | ReportingOptions}
|
|
20435
|
+
* element of your add-in's manifest.
|
|
20436
|
+
*
|
|
20437
|
+
* To learn more about how to develop a spam-reporting add-in, see
|
|
20438
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
20439
|
+
*/
|
|
20440
|
+
options: boolean[];
|
|
20441
|
+
/**
|
|
20442
|
+
* The type of event that was raised. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
20443
|
+
*
|
|
20444
|
+
* @remarks
|
|
20445
|
+
* [Api set: Mailbox 1.14]
|
|
20446
|
+
*/
|
|
20447
|
+
type: "SpamReporting";
|
|
20448
|
+
}
|
|
20449
|
+
/**
|
|
20450
|
+
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting add-in}
|
|
20451
|
+
* after it completes processing a
|
|
20452
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | SpamReporting} event.
|
|
20453
|
+
*
|
|
20454
|
+
* @remarks
|
|
20455
|
+
*
|
|
20456
|
+
* [Api set: Mailbox 1.14]
|
|
20457
|
+
*
|
|
20458
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
20459
|
+
*
|
|
20460
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20461
|
+
*/
|
|
20462
|
+
interface SpamReportingEventCompletedOptions {
|
|
20463
|
+
/**
|
|
20464
|
+
* 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,
|
|
20465
|
+
* this property specifies the Outlook mailbox folder to which the message will be moved.
|
|
20466
|
+
*
|
|
20467
|
+
* @remarks
|
|
20468
|
+
*
|
|
20469
|
+
* [Api set: Mailbox 1.14]
|
|
20470
|
+
*
|
|
20471
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20472
|
+
*
|
|
20473
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20474
|
+
*
|
|
20475
|
+
* **Important**:
|
|
20476
|
+
*
|
|
20477
|
+
* - If the specified folder doesn't exist yet, it will be created before the message is moved.
|
|
20478
|
+
*
|
|
20479
|
+
* - If the `postProcessingAction` property is set to `moveToCustomFolder`, the `folderName` property must be specified.
|
|
20480
|
+
* Otherwise, the reported message is moved to the **Junk Email** folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
|
|
20481
|
+
* the `folderName` property is ignored.
|
|
20482
|
+
*/
|
|
20483
|
+
folderName?: string;
|
|
20484
|
+
/**
|
|
20485
|
+
* 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,
|
|
20486
|
+
* this property specifies whether the message is moved to a different folder in the mailbox.
|
|
20487
|
+
*
|
|
20488
|
+
* @remarks
|
|
20489
|
+
*
|
|
20490
|
+
* [Api set: Mailbox 1.14]
|
|
20491
|
+
*
|
|
20492
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20493
|
+
*
|
|
20494
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20495
|
+
*
|
|
20496
|
+
* **Important**:
|
|
20497
|
+
*
|
|
20498
|
+
* - You can only use this property in a spam-reporting add-in in Outlook on the web, on Windows (starting in Version 2308 (Build 16724.10000)), on Mac,
|
|
20499
|
+
* and in new Outlook on Windows (preview). If you're using an earlier build in Outlook on Windows that supports the integrated spam-reporting feature, use the
|
|
20500
|
+
* `postProcessingAction` property instead.
|
|
20501
|
+
*
|
|
20502
|
+
* - If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
20503
|
+
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
20504
|
+
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
20505
|
+
*/
|
|
20506
|
+
moveItemTo?: MailboxEnums.MoveSpamItemTo;
|
|
20507
|
+
/**
|
|
20508
|
+
* When set to `true`, deletes a reported message if an error occurs while the message is processed.
|
|
20509
|
+
* 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},
|
|
20510
|
+
* the reported message remains in its current mailbox folder.
|
|
20511
|
+
*
|
|
20512
|
+
* @remarks
|
|
20513
|
+
*
|
|
20514
|
+
* [Api set: Mailbox 1.14]
|
|
20515
|
+
*
|
|
20516
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20517
|
+
*
|
|
20518
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20519
|
+
*/
|
|
20520
|
+
onErrorDeleteItem?: boolean;
|
|
20521
|
+
/**
|
|
20522
|
+
* 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,
|
|
20523
|
+
* this property specifies whether the message is moved to a different folder in the mailbox. The following post-processing actions are available.
|
|
20524
|
+
*
|
|
20525
|
+
* - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
|
|
20526
|
+
*
|
|
20527
|
+
* - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
|
|
20528
|
+
*
|
|
20529
|
+
* - `moveToSpamFolder` - Moves the reported message to the **Junk Email** folder of the mailbox.
|
|
20530
|
+
*
|
|
20531
|
+
* - `noMove` - Leaves the reported message in its current folder.
|
|
20532
|
+
*
|
|
20533
|
+
* @remarks
|
|
20534
|
+
*
|
|
20535
|
+
* [Api set: Mailbox 1.14]
|
|
20536
|
+
*
|
|
20537
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20538
|
+
*
|
|
20539
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20540
|
+
*
|
|
20541
|
+
* **Important**:
|
|
20542
|
+
*
|
|
20543
|
+
* - In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
|
|
20544
|
+
* If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
|
|
20545
|
+
*
|
|
20546
|
+
* - This property isn't supported in Outlook on the web, on Mac, or in new Outlook on Windows (preview). Use the `moveItemTo` property instead.
|
|
20547
|
+
*
|
|
20548
|
+
* - If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
20549
|
+
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
20550
|
+
* `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
|
|
20551
|
+
*/
|
|
20552
|
+
postProcessingAction?: string;
|
|
20553
|
+
/**
|
|
20554
|
+
* 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,
|
|
20555
|
+
* 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.
|
|
20556
|
+
* If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
|
|
20557
|
+
*
|
|
20558
|
+
* @remarks
|
|
20559
|
+
*
|
|
20560
|
+
* [Api set: Mailbox 1.14]
|
|
20561
|
+
*
|
|
20562
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20563
|
+
*
|
|
20564
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20565
|
+
*
|
|
20566
|
+
* **Important**: In Outlook on the web or in new Outlook on Windows (preview), a post-processing dialog isn't shown once the add-in completes processing a
|
|
20567
|
+
* reported message. This applies even if `showPostProcessingDialog` is configured. However, depending on how you configured the `moveItemTo` property in the
|
|
20568
|
+
* `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
|
|
20569
|
+
* the "Review feature behavior and limitations" section of
|
|
20570
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#review-feature-behavior-and-limitations | Implement an integrated spam-reporting add-in}.
|
|
20571
|
+
*/
|
|
20572
|
+
showPostProcessingDialog?: object;
|
|
19672
20573
|
}
|
|
19673
20574
|
/**
|
|
19674
20575
|
* Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
|