@types/office-js-preview 1.0.489 → 1.0.491
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +402 -304
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -517,7 +517,7 @@ declare namespace Office {
|
|
|
517
517
|
* - Word on the web
|
|
518
518
|
*
|
|
519
519
|
* It's also supported in
|
|
520
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
520
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
521
521
|
*
|
|
522
522
|
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/device-permission-service-requirement-sets | DevicePermission 1.1}
|
|
523
523
|
*/
|
|
@@ -529,7 +529,7 @@ declare namespace Office {
|
|
|
529
529
|
/**
|
|
530
530
|
* The add-in is requesting access to the user's geolocation.
|
|
531
531
|
*
|
|
532
|
-
* **Important**: Access to a user's geolocation is only supported in Outlook on the web and new Outlook on Windows
|
|
532
|
+
* **Important**: Access to a user's geolocation is only supported in Outlook on the web and new Outlook on Windows.
|
|
533
533
|
*/
|
|
534
534
|
geolocation,
|
|
535
535
|
/**
|
|
@@ -908,7 +908,7 @@ declare namespace Office {
|
|
|
908
908
|
* The platform is Office on the web (in a browser).
|
|
909
909
|
*
|
|
910
910
|
* **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
911
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
911
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
912
912
|
*/
|
|
913
913
|
OfficeOnline,
|
|
914
914
|
/**
|
|
@@ -3137,7 +3137,7 @@ declare namespace Office {
|
|
|
3137
3137
|
/**
|
|
3138
3138
|
* Associates the ID or name of an action with a function.
|
|
3139
3139
|
*
|
|
3140
|
-
* @param actionId The ID of an action that is defined in
|
|
3140
|
+
* @param actionId The ID of an action that is defined in the manifest.
|
|
3141
3141
|
* @param actionFunction The function that is run when the action is invoked.
|
|
3142
3142
|
*/
|
|
3143
3143
|
associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
|
|
@@ -3152,14 +3152,14 @@ declare namespace Office {
|
|
|
3152
3152
|
*
|
|
3153
3153
|
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
3154
3154
|
*
|
|
3155
|
-
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions
|
|
3155
|
+
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
|
|
3156
3156
|
* To learn how to specify a valid action ID and a key combination, see {@link https://learn.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts | Add custom keyboard shortcuts to your Office Add-ins}. (Note that a key combination can be `null`, in which case, the action keeps the key combination specified in the JSON file.)
|
|
3157
3157
|
* @returns A promise that resolves when every custom shortcut assignment in `shortcuts` has been registered. Even if there is a conflict with existing shortcuts, the customized shortcut will be registered.
|
|
3158
3158
|
* Otherwise, the promise will be rejected with error code and error message. An "InvalidOperation" error code is returned if any action ID in `shortcuts` does not exist, or if shortcut combination is invalid.
|
|
3159
3159
|
*/
|
|
3160
3160
|
replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;
|
|
3161
3161
|
/**
|
|
3162
|
-
* Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's
|
|
3162
|
+
* Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's manifest for keyboard shortcuts and (2) the current user's custom shortcuts if those exist.
|
|
3163
3163
|
* The shortcut can be `null` if it conflicts with the shortcut of another add-in or with the Office application. Specifically, it would be `null` if, when prompted to choose which shortcut to use, the user didn't choose the action of the current add-in. For more information about conflicts with shortcuts, see {@link https://learn.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#avoid-key-combinations-in-use-by-other-add-ins | Avoid key combinations in use by other add-ins}.
|
|
3164
3164
|
*
|
|
3165
3165
|
* @remarks
|
|
@@ -3170,7 +3170,7 @@ declare namespace Office {
|
|
|
3170
3170
|
*
|
|
3171
3171
|
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
3172
3172
|
*
|
|
3173
|
-
* @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions
|
|
3173
|
+
* @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
|
|
3174
3174
|
*/
|
|
3175
3175
|
getShortcuts(): Promise<{[actionId: string]: string|null}>;
|
|
3176
3176
|
/**
|
|
@@ -3580,7 +3580,7 @@ declare namespace Office {
|
|
|
3580
3580
|
*
|
|
3581
3581
|
* - In Outlook on the web, this API isn't supported if you use the Safari browser. This results in error 13001 ("The user is not signed into Office").
|
|
3582
3582
|
*
|
|
3583
|
-
* - In Outlook on the web, if you use the
|
|
3583
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, if you use the
|
|
3584
3584
|
* {@link https://learn.microsoft.com/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1) | displayDialogAsync}
|
|
3585
3585
|
* method to open a dialog, you must close the dialog before you can call `getAccessToken`.
|
|
3586
3586
|
*
|
|
@@ -4661,7 +4661,7 @@ declare namespace Office {
|
|
|
4661
4661
|
* property to get similar information.
|
|
4662
4662
|
*
|
|
4663
4663
|
* - In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
4664
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
4664
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
4665
4665
|
*/
|
|
4666
4666
|
platform: PlatformType;
|
|
4667
4667
|
/**
|
|
@@ -4717,7 +4717,7 @@ declare namespace Office {
|
|
|
4717
4717
|
*
|
|
4718
4718
|
* @remarks
|
|
4719
4719
|
*
|
|
4720
|
-
* **Applications**: Outlook on the web and on Windows (
|
|
4720
|
+
* **Applications**: Outlook on the web and on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic clients)
|
|
4721
4721
|
*
|
|
4722
4722
|
* [Api set: Mailbox 1.14]
|
|
4723
4723
|
*
|
|
@@ -4727,8 +4727,8 @@ declare namespace Office {
|
|
|
4727
4727
|
*
|
|
4728
4728
|
* **Important**:
|
|
4729
4729
|
*
|
|
4730
|
-
* - In Outlook on the web and new Outlook on Windows, this API isn't supported in add-ins that implement a task pane.
|
|
4731
|
-
* the API is only supported in add-ins that implement event-based activation or integrated spam reporting.
|
|
4730
|
+
* - In Outlook on the web and new Outlook on Windows, this API isn't supported in add-ins that implement a task pane.
|
|
4731
|
+
* On these clients, the API is only supported in add-ins that implement event-based activation or integrated spam reporting.
|
|
4732
4732
|
*
|
|
4733
4733
|
* - In classic Outlook on Windows, this API is supported in add-ins that implement a task pane, event-based activation, or integrated spam reporting.
|
|
4734
4734
|
*/
|
|
@@ -4753,7 +4753,7 @@ declare namespace Office {
|
|
|
4753
4753
|
*
|
|
4754
4754
|
* @remarks
|
|
4755
4755
|
* **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
4756
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
4756
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
4757
4757
|
*/
|
|
4758
4758
|
platform: Office.PlatformType;
|
|
4759
4759
|
/**
|
|
@@ -5318,7 +5318,7 @@ declare namespace Office {
|
|
|
5318
5318
|
* - Word on the web
|
|
5319
5319
|
*
|
|
5320
5320
|
* It's also supported in
|
|
5321
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
5321
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
5322
5322
|
*
|
|
5323
5323
|
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/device-permission-service-requirement-sets | DevicePermission 1.1}
|
|
5324
5324
|
*/
|
|
@@ -5391,7 +5391,8 @@ declare namespace Office {
|
|
|
5391
5391
|
* browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
|
|
5392
5392
|
*
|
|
5393
5393
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5394
|
-
* In Outlook on the web, an add-in can request access to a
|
|
5394
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, an add-in can request access to a
|
|
5395
|
+
* user's camera, geolocation, and microphone.
|
|
5395
5396
|
* @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.
|
|
5396
5397
|
* @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.
|
|
5397
5398
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property. You must then reload the add-in before you can
|
|
@@ -5431,7 +5432,8 @@ declare namespace Office {
|
|
|
5431
5432
|
* browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
|
|
5432
5433
|
*
|
|
5433
5434
|
* @param permissions An array of device capabilities to which an add-in is requesting access.
|
|
5434
|
-
* In Outlook on the web, an add-in can request access to a
|
|
5435
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, an add-in can request access to a
|
|
5436
|
+
* user's camera, geolocation, and microphone.
|
|
5435
5437
|
* @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.
|
|
5436
5438
|
* If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property. You must then reload the add-in before you can
|
|
5437
5439
|
* run code that uses the device capabilities. For example, you can call `window.location.reload()` to reload your add-in.
|
|
@@ -8448,7 +8450,7 @@ declare namespace Office {
|
|
|
8448
8450
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
8449
8451
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
8450
8452
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | Specify Office applications and API requirements},
|
|
8451
|
-
* if you're using the
|
|
8453
|
+
* if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
|
|
8452
8454
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
|
|
8453
8455
|
*
|
|
8454
8456
|
* The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
|
|
@@ -8551,7 +8553,7 @@ declare namespace Office {
|
|
|
8551
8553
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
8552
8554
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
8553
8555
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | Specify Office applications and API requirements},
|
|
8554
|
-
* if you're using the
|
|
8556
|
+
* if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
|
|
8555
8557
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
|
|
8556
8558
|
*
|
|
8557
8559
|
* The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
|
|
@@ -8716,10 +8718,11 @@ declare namespace Office {
|
|
|
8716
8718
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Configure your Outlook add-in for event-based activation} and
|
|
8717
8719
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
8718
8720
|
*
|
|
8719
|
-
* - In Outlook on the web and new Outlook on Windows,
|
|
8720
|
-
* the API is only supported in add-ins that implement event-based activation
|
|
8721
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
8722
|
+
* this API isn't supported in add-ins that implement a task pane. On these clients, the API is only supported in add-ins that implement event-based activation
|
|
8723
|
+
* or integrated spam reporting.
|
|
8721
8724
|
*
|
|
8722
|
-
* - If your add-in uses the
|
|
8725
|
+
* - If your add-in uses the add-in only manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
|
|
8723
8726
|
* To learn more, see {@link https://learn.microsoft.com/javascript/api/manifest/override#override-element-for-runtime | Override element for Runtime}.
|
|
8724
8727
|
*
|
|
8725
8728
|
* - If your add-in uses the unified manifest for Microsoft 365, the URL returned matches the value of the `script` property in the
|
|
@@ -8874,7 +8877,7 @@ declare namespace Office {
|
|
|
8874
8877
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8875
8878
|
*
|
|
8876
8879
|
* **Important**: The actual color depends on how the Outlook client renders it.
|
|
8877
|
-
* In this case, the colors noted on each preset apply to Outlook on the web, on Windows,
|
|
8880
|
+
* In this case, the colors noted on each preset apply to Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic),
|
|
8878
8881
|
* and on Mac (starting in Version 16.78).
|
|
8879
8882
|
*
|
|
8880
8883
|
* Earlier versions of Outlook on Mac had a bug that displayed incorrect preset colors.
|
|
@@ -9404,9 +9407,9 @@ declare namespace Office {
|
|
|
9404
9407
|
/**
|
|
9405
9408
|
* Specifies the recipient is an SMTP email address that isn't on the Exchange server. It also refers to a recipient added from a personal Outlook address book.
|
|
9406
9409
|
*
|
|
9407
|
-
* **Important**: In Outlook on the web, on Windows (
|
|
9408
|
-
*
|
|
9409
|
-
* added or resolved against the GAL.
|
|
9410
|
+
* **Important**: In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic
|
|
9411
|
+
* (starting with Version 2210, Build 15813.20002)), and on Mac, Global Address Book (GAL) recipients saved to a personal address book return the `ExternalUser` value,
|
|
9412
|
+
* even if their SMTP email address appears on the Exchange server. Recipients return a `User` value only if they're directly added or resolved against the GAL.
|
|
9410
9413
|
*/
|
|
9411
9414
|
ExternalUser = "externalUser",
|
|
9412
9415
|
/**
|
|
@@ -10331,7 +10334,8 @@ declare namespace Office {
|
|
|
10331
10334
|
*
|
|
10332
10335
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10333
10336
|
*
|
|
10334
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
10337
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and Outlook on Mac
|
|
10338
|
+
* only support Normal and Private sensitivity levels.
|
|
10335
10339
|
*/
|
|
10336
10340
|
sensitivity: Sensitivity;
|
|
10337
10341
|
/**
|
|
@@ -10630,8 +10634,8 @@ declare namespace Office {
|
|
|
10630
10634
|
*
|
|
10631
10635
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10632
10636
|
*
|
|
10633
|
-
* If your Office Add-in is running in Outlook on the web
|
|
10634
|
-
* you
|
|
10637
|
+
* If your Office Add-in is running in Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10638
|
+
* the `addItemAttachmentAsync` method can attach items to items other than the item that you're editing. However, this isn't supported and isn't recommended.
|
|
10635
10639
|
*
|
|
10636
10640
|
* @remarks
|
|
10637
10641
|
* [Api set: Mailbox 1.1]
|
|
@@ -10665,8 +10669,8 @@ declare namespace Office {
|
|
|
10665
10669
|
*
|
|
10666
10670
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10667
10671
|
*
|
|
10668
|
-
* If your Office Add-in is running in Outlook on the web
|
|
10669
|
-
* you
|
|
10672
|
+
* If your Office Add-in is running in Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10673
|
+
* the `addItemAttachmentAsync` method can attach items to items other than the item that you're editing. However, this isn't supported and isn't recommended.
|
|
10670
10674
|
*
|
|
10671
10675
|
* @remarks
|
|
10672
10676
|
* [Api set: Mailbox 1.1]
|
|
@@ -10703,17 +10707,18 @@ declare namespace Office {
|
|
|
10703
10707
|
*
|
|
10704
10708
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10705
10709
|
*
|
|
10706
|
-
* **Important**: In Outlook on the web
|
|
10707
|
-
* discard, or cancel even if no changes have occurred
|
|
10710
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10711
|
+
* if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, discard, or cancel even if no changes have occurred
|
|
10712
|
+
* since the item was last saved.
|
|
10708
10713
|
*/
|
|
10709
10714
|
close(): void;
|
|
10710
10715
|
/**
|
|
10711
10716
|
* Disables the Outlook client signature.
|
|
10712
10717
|
*
|
|
10713
|
-
*
|
|
10718
|
+
* In Outlook on Windows (classic) and on Mac, this API sets the signature under the "New Message" and "Replies/Forwards" sections
|
|
10714
10719
|
* for the sending account to "(none)", effectively disabling the signature.
|
|
10715
|
-
*
|
|
10716
|
-
* If the signature is selected, this API call
|
|
10720
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, the API disables the signature
|
|
10721
|
+
* option for new mails, replies, and forwards. If the signature is selected, this API call disables it.
|
|
10717
10722
|
*
|
|
10718
10723
|
* @remarks
|
|
10719
10724
|
* [Api set: Mailbox 1.10]
|
|
@@ -10731,10 +10736,10 @@ declare namespace Office {
|
|
|
10731
10736
|
/**
|
|
10732
10737
|
* Disables the Outlook client signature.
|
|
10733
10738
|
*
|
|
10734
|
-
*
|
|
10739
|
+
* In Outlook on Windows (classic) and on Mac, this API sets the signature under the "New Message" and "Replies/Forwards" sections
|
|
10735
10740
|
* for the sending account to "(none)", effectively disabling the signature.
|
|
10736
|
-
*
|
|
10737
|
-
* If the signature is selected, this API call
|
|
10741
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, the API disables the signature
|
|
10742
|
+
* option for new mails, replies, and forwards. If the signature is selected, this API call disables it.
|
|
10738
10743
|
*
|
|
10739
10744
|
* @remarks
|
|
10740
10745
|
* [Api set: Mailbox 1.10]
|
|
@@ -10752,7 +10757,8 @@ declare namespace Office {
|
|
|
10752
10757
|
*
|
|
10753
10758
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10754
10759
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10755
|
-
* In Outlook on the web
|
|
10760
|
+
* In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10761
|
+
* the attachment identifier is valid only within the same session.
|
|
10756
10762
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10757
10763
|
* continue in a separate window.
|
|
10758
10764
|
*
|
|
@@ -10783,7 +10789,8 @@ declare namespace Office {
|
|
|
10783
10789
|
*
|
|
10784
10790
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10785
10791
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10786
|
-
* In Outlook on the web
|
|
10792
|
+
* In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10793
|
+
* the attachment identifier is valid only within the same session.
|
|
10787
10794
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10788
10795
|
* continue in a separate window.
|
|
10789
10796
|
*
|
|
@@ -11018,10 +11025,10 @@ declare namespace Office {
|
|
|
11018
11025
|
/**
|
|
11019
11026
|
* Gets if the client signature is enabled.
|
|
11020
11027
|
*
|
|
11021
|
-
* For
|
|
11022
|
-
*
|
|
11023
|
-
*
|
|
11024
|
-
*
|
|
11028
|
+
* For Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, the API call
|
|
11029
|
+
* should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11030
|
+
* If the settings are set to "(none)" in Windows (classic) or Mac desktop clients or disabled in Outlook on the web or new Outlook on Windows,
|
|
11031
|
+
* the API call should return `false`.
|
|
11025
11032
|
*
|
|
11026
11033
|
* @remarks
|
|
11027
11034
|
* [Api set: Mailbox 1.10]
|
|
@@ -11039,10 +11046,10 @@ declare namespace Office {
|
|
|
11039
11046
|
/**
|
|
11040
11047
|
* Gets if the client signature is enabled.
|
|
11041
11048
|
*
|
|
11042
|
-
* For
|
|
11043
|
-
*
|
|
11044
|
-
*
|
|
11045
|
-
*
|
|
11049
|
+
* For Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, the API call
|
|
11050
|
+
* should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11051
|
+
* If the settings are set to "(none)" in Windows (classic) or Mac desktop clients or disabled in Outlook on the web or new Outlook on Windows,
|
|
11052
|
+
* the API call should return `false`.
|
|
11046
11053
|
*
|
|
11047
11054
|
* @remarks
|
|
11048
11055
|
* [Api set: Mailbox 1.10]
|
|
@@ -11086,7 +11093,8 @@ declare namespace Office {
|
|
|
11086
11093
|
*
|
|
11087
11094
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
11088
11095
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
11089
|
-
* in the same session. In Outlook on the web
|
|
11096
|
+
* in the same session. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11097
|
+
* the attachment identifier is valid only within the same session.
|
|
11090
11098
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
11091
11099
|
* continue in a separate window.
|
|
11092
11100
|
*
|
|
@@ -11106,7 +11114,7 @@ declare namespace Office {
|
|
|
11106
11114
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
11107
11115
|
*
|
|
11108
11116
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
11109
|
-
* is 200 characters in Outlook on the web and on Windows.
|
|
11117
|
+
* is 200 characters in Outlook on the web and on Windows (new and classic).
|
|
11110
11118
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11111
11119
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11112
11120
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -11119,7 +11127,8 @@ declare namespace Office {
|
|
|
11119
11127
|
*
|
|
11120
11128
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
11121
11129
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
11122
|
-
* in the same session. In Outlook on the web
|
|
11130
|
+
* in the same session. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11131
|
+
* the attachment identifier is valid only within the same session.
|
|
11123
11132
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
11124
11133
|
* continue in a separate window.
|
|
11125
11134
|
*
|
|
@@ -11139,7 +11148,7 @@ declare namespace Office {
|
|
|
11139
11148
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
11140
11149
|
*
|
|
11141
11150
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
11142
|
-
* is 200 characters in Outlook on the web and on Windows.
|
|
11151
|
+
* is 200 characters in Outlook on the web and on Windows (new and classic).
|
|
11143
11152
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11144
11153
|
* type `Office.AsyncResult`.
|
|
11145
11154
|
* If removing the attachment fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
|
|
@@ -11199,7 +11208,8 @@ declare namespace Office {
|
|
|
11199
11208
|
*
|
|
11200
11209
|
* **Important**:
|
|
11201
11210
|
*
|
|
11202
|
-
* - In Outlook on the web
|
|
11211
|
+
* - In Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, or classic Outlook on Windows
|
|
11212
|
+
* in online mode (non-cached mode), the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
|
|
11203
11213
|
*
|
|
11204
11214
|
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
11205
11215
|
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
@@ -11238,7 +11248,8 @@ declare namespace Office {
|
|
|
11238
11248
|
*
|
|
11239
11249
|
* **Important**:
|
|
11240
11250
|
*
|
|
11241
|
-
* - In Outlook on the web
|
|
11251
|
+
* - In Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, or classic Outlook on Windows
|
|
11252
|
+
* in online mode (non-cached mode), the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
|
|
11242
11253
|
*
|
|
11243
11254
|
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
11244
11255
|
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
@@ -11281,13 +11292,14 @@ declare namespace Office {
|
|
|
11281
11292
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
11282
11293
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11283
11294
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11284
|
-
* `coercionType`: If text, the current style is applied in Outlook on the web
|
|
11285
|
-
*
|
|
11286
|
-
*
|
|
11287
|
-
*
|
|
11288
|
-
*
|
|
11289
|
-
*
|
|
11290
|
-
*
|
|
11295
|
+
* `coercionType`: If text, the current style is applied in Outlook on the web, on Windows
|
|
11296
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac.
|
|
11297
|
+
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
11298
|
+
* If the data is HTML and the field supports HTML (the subject doesn't), the current style is applied in
|
|
11299
|
+
* Outlook on the web and new Outlook on Windows. The default style is applied in Outlook on Windows (classic) and on Mac.
|
|
11300
|
+
* If the field is a text field, an `InvalidDataFormat` error is returned.
|
|
11301
|
+
* If `coercionType` is not set, the result depends on the field:
|
|
11302
|
+
* if the field is HTML then HTML is used; if the field is text, then plain text is used.
|
|
11291
11303
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11292
11304
|
* type `Office.AsyncResult`.
|
|
11293
11305
|
*/
|
|
@@ -11815,7 +11827,8 @@ declare namespace Office {
|
|
|
11815
11827
|
*
|
|
11816
11828
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11817
11829
|
*
|
|
11818
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
11830
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and Outlook on Mac
|
|
11831
|
+
* only support Normal and Private sensitivity levels.
|
|
11819
11832
|
*/
|
|
11820
11833
|
sensitivity: MailboxEnums.AppointmentSensitivityType;
|
|
11821
11834
|
/**
|
|
@@ -11873,9 +11886,10 @@ declare namespace Office {
|
|
|
11873
11886
|
*
|
|
11874
11887
|
* **Important**:
|
|
11875
11888
|
*
|
|
11876
|
-
*
|
|
11889
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11890
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11877
11891
|
*
|
|
11878
|
-
* - If any of the string parameters exceed their limits, `
|
|
11892
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception.
|
|
11879
11893
|
*
|
|
11880
11894
|
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11881
11895
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
@@ -11891,15 +11905,6 @@ declare namespace Office {
|
|
|
11891
11905
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
11892
11906
|
* selected appointment.
|
|
11893
11907
|
*
|
|
11894
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11895
|
-
*
|
|
11896
|
-
* If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
11897
|
-
*
|
|
11898
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11899
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11900
|
-
*
|
|
11901
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11902
|
-
*
|
|
11903
11908
|
* @remarks
|
|
11904
11909
|
* [Api set: Mailbox 1.9]
|
|
11905
11910
|
*
|
|
@@ -11907,6 +11912,19 @@ declare namespace Office {
|
|
|
11907
11912
|
*
|
|
11908
11913
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11909
11914
|
*
|
|
11915
|
+
* **Important**:
|
|
11916
|
+
*
|
|
11917
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11918
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11919
|
+
*
|
|
11920
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
11921
|
+
*
|
|
11922
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11923
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11924
|
+
*
|
|
11925
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11926
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11927
|
+
*
|
|
11910
11928
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11911
11929
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
11912
11930
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -11919,15 +11937,6 @@ declare namespace Office {
|
|
|
11919
11937
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
11920
11938
|
* selected appointment.
|
|
11921
11939
|
*
|
|
11922
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11923
|
-
*
|
|
11924
|
-
* If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
11925
|
-
*
|
|
11926
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11927
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11928
|
-
*
|
|
11929
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11930
|
-
*
|
|
11931
11940
|
* @remarks
|
|
11932
11941
|
* [Api set: Mailbox 1.9]
|
|
11933
11942
|
*
|
|
@@ -11935,6 +11944,19 @@ declare namespace Office {
|
|
|
11935
11944
|
*
|
|
11936
11945
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11937
11946
|
*
|
|
11947
|
+
* **Important**:
|
|
11948
|
+
*
|
|
11949
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11950
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11951
|
+
*
|
|
11952
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
11953
|
+
*
|
|
11954
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11955
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11956
|
+
*
|
|
11957
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11958
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11959
|
+
*
|
|
11938
11960
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11939
11961
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
11940
11962
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -11953,7 +11975,8 @@ declare namespace Office {
|
|
|
11953
11975
|
*
|
|
11954
11976
|
* **Important**:
|
|
11955
11977
|
*
|
|
11956
|
-
* - In Outlook on the web
|
|
11978
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11979
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11957
11980
|
*
|
|
11958
11981
|
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
11959
11982
|
*
|
|
@@ -11970,15 +11993,6 @@ declare namespace Office {
|
|
|
11970
11993
|
/**
|
|
11971
11994
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
11972
11995
|
*
|
|
11973
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11974
|
-
*
|
|
11975
|
-
* If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
11976
|
-
*
|
|
11977
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11978
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11979
|
-
*
|
|
11980
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11981
|
-
*
|
|
11982
11996
|
* @remarks
|
|
11983
11997
|
* [Api set: Mailbox 1.9]
|
|
11984
11998
|
*
|
|
@@ -11986,6 +12000,19 @@ declare namespace Office {
|
|
|
11986
12000
|
*
|
|
11987
12001
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11988
12002
|
*
|
|
12003
|
+
* **Important**:
|
|
12004
|
+
*
|
|
12005
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12006
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
12007
|
+
*
|
|
12008
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
12009
|
+
*
|
|
12010
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
12011
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
12012
|
+
*
|
|
12013
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
12014
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12015
|
+
*
|
|
11989
12016
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11990
12017
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
11991
12018
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -11997,15 +12024,6 @@ declare namespace Office {
|
|
|
11997
12024
|
/**
|
|
11998
12025
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
11999
12026
|
*
|
|
12000
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
12001
|
-
*
|
|
12002
|
-
* If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
12003
|
-
*
|
|
12004
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
12005
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
12006
|
-
*
|
|
12007
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
12008
|
-
*
|
|
12009
12027
|
* @remarks
|
|
12010
12028
|
* [Api set: Mailbox 1.9]
|
|
12011
12029
|
*
|
|
@@ -12013,6 +12031,19 @@ declare namespace Office {
|
|
|
12013
12031
|
*
|
|
12014
12032
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12015
12033
|
*
|
|
12034
|
+
* **Important**:
|
|
12035
|
+
*
|
|
12036
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12037
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
12038
|
+
*
|
|
12039
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
12040
|
+
*
|
|
12041
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
12042
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
12043
|
+
*
|
|
12044
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
12045
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12046
|
+
*
|
|
12016
12047
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
12017
12048
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
12018
12049
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -12024,9 +12055,9 @@ declare namespace Office {
|
|
|
12024
12055
|
*
|
|
12025
12056
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12026
12057
|
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12027
|
-
* to retrieve the attachment. In Outlook on the web
|
|
12028
|
-
* A session is over when the user closes the app, or if the user starts composing an
|
|
12029
|
-
* continue in a separate window.
|
|
12058
|
+
* to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12059
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
|
|
12060
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
12030
12061
|
*
|
|
12031
12062
|
* @remarks
|
|
12032
12063
|
* [Api set: Mailbox 1.8]
|
|
@@ -12055,9 +12086,9 @@ declare namespace Office {
|
|
|
12055
12086
|
*
|
|
12056
12087
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12057
12088
|
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12058
|
-
* to retrieve the attachment. In Outlook on the web
|
|
12059
|
-
* A session is over when the user closes the app, or if the user starts composing an
|
|
12060
|
-
* continue in a separate window.
|
|
12089
|
+
* to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12090
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
|
|
12091
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
12061
12092
|
*
|
|
12062
12093
|
* @remarks
|
|
12063
12094
|
* [Api set: Mailbox 1.8]
|
|
@@ -12123,7 +12154,7 @@ declare namespace Office {
|
|
|
12123
12154
|
*/
|
|
12124
12155
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
12125
12156
|
/**
|
|
12126
|
-
* Returns well-known entities in the selected item that pass the named filter defined in an
|
|
12157
|
+
* Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.
|
|
12127
12158
|
*
|
|
12128
12159
|
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12129
12160
|
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
@@ -12134,7 +12165,7 @@ declare namespace Office {
|
|
|
12134
12165
|
*
|
|
12135
12166
|
* @returns
|
|
12136
12167
|
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
12137
|
-
* manifest
|
|
12168
|
+
* add-in manifest file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
12138
12169
|
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
12139
12170
|
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
12140
12171
|
*
|
|
@@ -12183,10 +12214,10 @@ declare namespace Office {
|
|
|
12183
12214
|
*/
|
|
12184
12215
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
12185
12216
|
/**
|
|
12186
|
-
* Returns string values in the selected item that match the regular expressions defined in an
|
|
12217
|
+
* Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.
|
|
12187
12218
|
*
|
|
12188
12219
|
* @returns
|
|
12189
|
-
* An object that contains arrays of strings that match the regular expressions defined in the manifest
|
|
12220
|
+
* An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
|
|
12190
12221
|
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
12191
12222
|
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
12192
12223
|
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
@@ -12217,10 +12248,10 @@ declare namespace Office {
|
|
|
12217
12248
|
*/
|
|
12218
12249
|
getRegExMatches(): any;
|
|
12219
12250
|
/**
|
|
12220
|
-
* Returns string values in the selected item that match the named regular expression defined in an
|
|
12251
|
+
* Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.
|
|
12221
12252
|
*
|
|
12222
12253
|
* @returns
|
|
12223
|
-
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest
|
|
12254
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the add-in manifest file,
|
|
12224
12255
|
* with the specified `RegExName` element value.
|
|
12225
12256
|
*
|
|
12226
12257
|
* @remarks
|
|
@@ -12271,11 +12302,11 @@ declare namespace Office {
|
|
|
12271
12302
|
*/
|
|
12272
12303
|
getSelectedEntities(): Entities;
|
|
12273
12304
|
/**
|
|
12274
|
-
* Returns string values in a highlighted match that match the regular expressions defined in an
|
|
12305
|
+
* Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.
|
|
12275
12306
|
* Highlighted matches apply to contextual add-ins.
|
|
12276
12307
|
*
|
|
12277
12308
|
* @returns
|
|
12278
|
-
* An object that contains arrays of strings that match the regular expressions defined in the manifest
|
|
12309
|
+
* An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
|
|
12279
12310
|
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
12280
12311
|
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
|
|
12281
12312
|
* The `PropertyName` simple type defines the supported properties.
|
|
@@ -12461,11 +12492,13 @@ declare namespace Office {
|
|
|
12461
12492
|
*
|
|
12462
12493
|
* For item attachments that represent messages and were attached by drag-and-drop or "Attach Item",
|
|
12463
12494
|
* the formatting is a string representing an .eml formatted file.
|
|
12464
|
-
* **Important**: If a message item was attached by drag-and-drop in Outlook on the web, then `getAttachmentContentAsync` throws an error.
|
|
12465
12495
|
*
|
|
12466
12496
|
* For item attachments that represent calendar items and were attached by drag-and-drop or "Attach Item",
|
|
12467
12497
|
* the formatting is a string representing an .icalendar file.
|
|
12468
|
-
*
|
|
12498
|
+
*
|
|
12499
|
+
* **Important**: If a message or calendar item was attached by drag-and-drop in Outlook on the web or
|
|
12500
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12501
|
+
* then `getAttachmentContentAsync` throws an error.
|
|
12469
12502
|
*
|
|
12470
12503
|
* For cloud attachments, the formatting is a URL string.
|
|
12471
12504
|
*/
|
|
@@ -12784,10 +12817,11 @@ declare namespace Office {
|
|
|
12784
12817
|
*
|
|
12785
12818
|
* **Important**:
|
|
12786
12819
|
*
|
|
12787
|
-
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
12788
|
-
*
|
|
12789
|
-
*
|
|
12790
|
-
* position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the
|
|
12820
|
+
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
12821
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), the cursor position remains the same in the preexisting content of the body.
|
|
12822
|
+
* For example, if the cursor was positioned at the beginning of the body prior to the `prependAsync` call, it will appear between the prepended content and the preexisting
|
|
12823
|
+
* content of the body after the call. In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the
|
|
12824
|
+
* user selects something in the body of the mail item.
|
|
12791
12825
|
*
|
|
12792
12826
|
* - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
|
|
12793
12827
|
* make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
|
|
@@ -12826,10 +12860,11 @@ declare namespace Office {
|
|
|
12826
12860
|
*
|
|
12827
12861
|
* **Important**:
|
|
12828
12862
|
*
|
|
12829
|
-
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
12830
|
-
*
|
|
12831
|
-
*
|
|
12832
|
-
* position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the
|
|
12863
|
+
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
12864
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), the cursor position remains the same in the preexisting content of the body.
|
|
12865
|
+
* For example, if the cursor was positioned at the beginning of the body prior to the `prependAsync` call, it will appear between the prepended content and the preexisting
|
|
12866
|
+
* content of the body after the call. In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the
|
|
12867
|
+
* user selects something in the body of the mail item.
|
|
12833
12868
|
*
|
|
12834
12869
|
* - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
|
|
12835
12870
|
* make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
|
|
@@ -12944,10 +12979,11 @@ declare namespace Office {
|
|
|
12944
12979
|
*
|
|
12945
12980
|
* **Important**:
|
|
12946
12981
|
*
|
|
12947
|
-
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
12948
|
-
*
|
|
12949
|
-
* In Outlook on
|
|
12950
|
-
*
|
|
12982
|
+
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
12983
|
+
* In classic Outlook on Windows, the cursor appears at the beginning of the body of the mail item.
|
|
12984
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12985
|
+
* the cursor appears at the end of the body of the mail item. In Outlook on Mac, the cursor position isn't preserved.
|
|
12986
|
+
* The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
|
|
12951
12987
|
*
|
|
12952
12988
|
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
|
|
12953
12989
|
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
|
|
@@ -12990,10 +13026,11 @@ declare namespace Office {
|
|
|
12990
13026
|
*
|
|
12991
13027
|
* **Important**:
|
|
12992
13028
|
*
|
|
12993
|
-
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
12994
|
-
*
|
|
12995
|
-
* In Outlook on
|
|
12996
|
-
*
|
|
13029
|
+
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
13030
|
+
* In classic Outlook on Windows, the cursor appears at the beginning of the body of the mail item.
|
|
13031
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13032
|
+
* the cursor appears at the end of the body of the mail item. In Outlook on Mac, the cursor position isn't preserved.
|
|
13033
|
+
* The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
|
|
12997
13034
|
*
|
|
12998
13035
|
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
|
|
12999
13036
|
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
|
|
@@ -13096,7 +13133,8 @@ declare namespace Office {
|
|
|
13096
13133
|
*
|
|
13097
13134
|
* **Important**:
|
|
13098
13135
|
*
|
|
13099
|
-
* - In Outlook on the web
|
|
13136
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13137
|
+
* `setSignatureAsync` only works on messages.
|
|
13100
13138
|
*
|
|
13101
13139
|
* - This method is supported in Message Compose on Outlook on Android and on iOS starting in Version 4.2352.0. For a sample scenario, see
|
|
13102
13140
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
@@ -13135,7 +13173,8 @@ declare namespace Office {
|
|
|
13135
13173
|
*
|
|
13136
13174
|
* **Important**:
|
|
13137
13175
|
*
|
|
13138
|
-
* - In Outlook on the web
|
|
13176
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13177
|
+
* `setSignatureAsync` only works on messages.
|
|
13139
13178
|
*
|
|
13140
13179
|
* - This method is supported in Message Compose on Outlook on Android and on iOS starting in Version 4.2352.0. For a sample scenario, see
|
|
13141
13180
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
@@ -13166,7 +13205,8 @@ declare namespace Office {
|
|
|
13166
13205
|
* The user defines {@link Office.MasterCategories | categories in a master list} on their mailbox.
|
|
13167
13206
|
* They can then apply one or more categories to an item.
|
|
13168
13207
|
*
|
|
13169
|
-
* **Important**: In Outlook on the web
|
|
13208
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13209
|
+
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13170
13210
|
*
|
|
13171
13211
|
* @remarks
|
|
13172
13212
|
* [Api set: Mailbox 1.8]
|
|
@@ -13180,7 +13220,8 @@ declare namespace Office {
|
|
|
13180
13220
|
* Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name
|
|
13181
13221
|
* but multiple categories can use the same color.
|
|
13182
13222
|
*
|
|
13183
|
-
* **Important**: In Outlook on the web
|
|
13223
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13224
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13184
13225
|
*
|
|
13185
13226
|
* @remarks
|
|
13186
13227
|
* [Api set: Mailbox 1.8]
|
|
@@ -13204,7 +13245,8 @@ declare namespace Office {
|
|
|
13204
13245
|
* Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name
|
|
13205
13246
|
* but multiple categories can use the same color.
|
|
13206
13247
|
*
|
|
13207
|
-
* **Important**: In Outlook on the web
|
|
13248
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13249
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13208
13250
|
*
|
|
13209
13251
|
* @remarks
|
|
13210
13252
|
* [Api set: Mailbox 1.8]
|
|
@@ -13230,7 +13272,8 @@ declare namespace Office {
|
|
|
13230
13272
|
* - If there are no categories on the item, `null` or an empty array will be returned depending on the Outlook version
|
|
13231
13273
|
* so make sure to handle both cases.
|
|
13232
13274
|
*
|
|
13233
|
-
* - In Outlook on the web
|
|
13275
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13276
|
+
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13234
13277
|
*
|
|
13235
13278
|
* @remarks
|
|
13236
13279
|
* [Api set: Mailbox 1.8]
|
|
@@ -13253,7 +13296,8 @@ declare namespace Office {
|
|
|
13253
13296
|
* - If there are no categories on the item, `null` or an empty array will be returned depending on the Outlook version
|
|
13254
13297
|
* so make sure to handle both cases.
|
|
13255
13298
|
*
|
|
13256
|
-
* - In Outlook on the web
|
|
13299
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13300
|
+
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13257
13301
|
*
|
|
13258
13302
|
* @remarks
|
|
13259
13303
|
* [Api set: Mailbox 1.8]
|
|
@@ -13269,7 +13313,8 @@ declare namespace Office {
|
|
|
13269
13313
|
/**
|
|
13270
13314
|
* Removes categories from an item.
|
|
13271
13315
|
*
|
|
13272
|
-
* **Important**: In Outlook on the web
|
|
13316
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13317
|
+
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13273
13318
|
*
|
|
13274
13319
|
* @remarks
|
|
13275
13320
|
* [Api set: Mailbox 1.8]
|
|
@@ -13288,7 +13333,8 @@ declare namespace Office {
|
|
|
13288
13333
|
/**
|
|
13289
13334
|
* Removes categories from an item.
|
|
13290
13335
|
*
|
|
13291
|
-
* **Important**: In Outlook on the web
|
|
13336
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13337
|
+
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13292
13338
|
*
|
|
13293
13339
|
* @remarks
|
|
13294
13340
|
* [Api set: Mailbox 1.8]
|
|
@@ -13683,15 +13729,15 @@ declare namespace Office {
|
|
|
13683
13729
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13684
13730
|
*
|
|
13685
13731
|
* **Important**: The `Outlook` value is returned for Outlook desktop clients on Windows and on Mac. `newOutlookWindows` is returned for the
|
|
13686
|
-
* {@link https://
|
|
13687
|
-
* currently in preview.
|
|
13732
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows desktop client}.
|
|
13688
13733
|
*/
|
|
13689
13734
|
hostName: string;
|
|
13690
13735
|
/**
|
|
13691
13736
|
* Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").
|
|
13692
13737
|
*
|
|
13693
|
-
* If the mail add-in is running in Outlook on
|
|
13694
|
-
* Outlook client. In Outlook on the web
|
|
13738
|
+
* If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the `hostVersion` property returns the version of the
|
|
13739
|
+
* Outlook client. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13740
|
+
* the property returns the version of the Exchange Server.
|
|
13695
13741
|
*
|
|
13696
13742
|
* @remarks
|
|
13697
13743
|
*
|
|
@@ -14824,8 +14870,9 @@ declare namespace Office {
|
|
|
14824
14870
|
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
|
|
14825
14871
|
*
|
|
14826
14872
|
* - `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0").
|
|
14827
|
-
* If the mail add-in is running in Outlook on
|
|
14828
|
-
*
|
|
14873
|
+
* If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the `hostVersion` property returns the version of the
|
|
14874
|
+
* Outlook client. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
14875
|
+
* the property returns the version of the Exchange Server.
|
|
14829
14876
|
*
|
|
14830
14877
|
* - `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web.
|
|
14831
14878
|
* If the application is not Outlook on the web, then accessing this property results in undefined.
|
|
@@ -14988,14 +15035,13 @@ declare namespace Office {
|
|
|
14988
15035
|
/**
|
|
14989
15036
|
* Gets a dictionary containing time information in local client time.
|
|
14990
15037
|
*
|
|
14991
|
-
* The
|
|
14992
|
-
* Outlook
|
|
14993
|
-
*
|
|
14994
|
-
* the user expects.
|
|
15038
|
+
* The time zone used by the Outlook client varies by platform.
|
|
15039
|
+
* Outlook on Windows (classic) and on Mac use the client computer time zone.
|
|
15040
|
+
* Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows} use the time zone set on the Exchange Admin Center (EAC).
|
|
15041
|
+
* You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that the user expects.
|
|
14995
15042
|
*
|
|
14996
|
-
*
|
|
14997
|
-
*
|
|
14998
|
-
* If the mail app is running in Outlook on the web, the `convertToLocalClientTime` method will return a dictionary object
|
|
15043
|
+
* In Outlook on Windows (classic) and on Mac, the `convertToLocalClientTime` method returns a dictionary object with the values set to the client computer time zone.
|
|
15044
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, the `convertToLocalClientTime` method returns a dictionary object
|
|
14999
15045
|
* with the values set to the time zone specified in the EAC.
|
|
15000
15046
|
*
|
|
15001
15047
|
* @remarks
|
|
@@ -15059,7 +15105,8 @@ declare namespace Office {
|
|
|
15059
15105
|
* of a recurring series. However, you can't display an instance of the series because you can't access the properties
|
|
15060
15106
|
* (including the item ID) of instances of a recurring series.
|
|
15061
15107
|
*
|
|
15062
|
-
* In Outlook on the web
|
|
15108
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15109
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15063
15110
|
*
|
|
15064
15111
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
15065
15112
|
* no error message is returned.
|
|
@@ -15087,7 +15134,8 @@ declare namespace Office {
|
|
|
15087
15134
|
* of a recurring series. However, you can't display an instance of the series because you can't access the properties
|
|
15088
15135
|
* (including the item ID) of instances of a recurring series.
|
|
15089
15136
|
*
|
|
15090
|
-
* In Outlook on the web
|
|
15137
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15138
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15091
15139
|
*
|
|
15092
15140
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
15093
15141
|
* no error message is returned.
|
|
@@ -15118,7 +15166,8 @@ declare namespace Office {
|
|
|
15118
15166
|
* of a recurring series. However, you can't display an instance of the series because you can't access the properties
|
|
15119
15167
|
* (including the item ID) of instances of a recurring series.
|
|
15120
15168
|
*
|
|
15121
|
-
* In Outlook on the web
|
|
15169
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15170
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15122
15171
|
*
|
|
15123
15172
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
15124
15173
|
* no error message is returned.
|
|
@@ -15142,7 +15191,8 @@ declare namespace Office {
|
|
|
15142
15191
|
*
|
|
15143
15192
|
* The `displayMessageForm` method opens an existing message in a new window on the desktop.
|
|
15144
15193
|
*
|
|
15145
|
-
* In Outlook on the web
|
|
15194
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15195
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15146
15196
|
*
|
|
15147
15197
|
* If the specified item identifier doesn't identify an existing message, no message will be displayed on the client computer, and
|
|
15148
15198
|
* no error message is returned.
|
|
@@ -15170,7 +15220,8 @@ declare namespace Office {
|
|
|
15170
15220
|
*
|
|
15171
15221
|
* The `displayMessageFormAsync` method opens an existing message in a new window on the desktop or in a dialog box on mobile devices.
|
|
15172
15222
|
*
|
|
15173
|
-
* In Outlook on the web
|
|
15223
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15224
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15174
15225
|
*
|
|
15175
15226
|
* If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and
|
|
15176
15227
|
* no error message is returned.
|
|
@@ -15200,7 +15251,8 @@ declare namespace Office {
|
|
|
15200
15251
|
*
|
|
15201
15252
|
* The `displayMessageFormAsync` method opens an existing message in a new window on the desktop or in a dialog box on mobile devices.
|
|
15202
15253
|
*
|
|
15203
|
-
* In Outlook on the web
|
|
15254
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15255
|
+
* this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
15204
15256
|
*
|
|
15205
15257
|
* If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and
|
|
15206
15258
|
* no error message is returned.
|
|
@@ -15229,7 +15281,8 @@ declare namespace Office {
|
|
|
15229
15281
|
* The `displayNewAppointmentForm` method opens a form that enables the user to create a new appointment or meeting.
|
|
15230
15282
|
* If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.
|
|
15231
15283
|
*
|
|
15232
|
-
* In Outlook on the web
|
|
15284
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15285
|
+
* this method always displays a form with an attendees field.
|
|
15233
15286
|
* If you don't specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15234
15287
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15235
15288
|
*
|
|
@@ -15258,7 +15311,8 @@ declare namespace Office {
|
|
|
15258
15311
|
* The `displayNewAppointmentFormAsync` method opens a form that enables the user to create a new appointment or meeting.
|
|
15259
15312
|
* If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.
|
|
15260
15313
|
*
|
|
15261
|
-
* In Outlook on the web
|
|
15314
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15315
|
+
* this method always displays a form with an attendees field.
|
|
15262
15316
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15263
15317
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15264
15318
|
*
|
|
@@ -15290,7 +15344,8 @@ declare namespace Office {
|
|
|
15290
15344
|
* The `displayNewAppointmentFormAsync` method opens a form that enables the user to create a new appointment or meeting.
|
|
15291
15345
|
* If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.
|
|
15292
15346
|
*
|
|
15293
|
-
* In Outlook on the web
|
|
15347
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15348
|
+
* this method always displays a form with an attendees field.
|
|
15294
15349
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15295
15350
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15296
15351
|
*
|
|
@@ -15732,16 +15787,17 @@ declare namespace Office {
|
|
|
15732
15787
|
*
|
|
15733
15788
|
* - When you use the `makeEwsRequestAsync` method in add-ins that run in Outlook versions earlier than Version 15.0.4535.1004, you must set
|
|
15734
15789
|
* the encoding value to ISO-8859-1 (`<?xml version="1.0" encoding="iso-8859-1"?>`). To determine the version of an Outlook client, use the
|
|
15735
|
-
* `mailbox.diagnostics.hostVersion` property. You don't need to set the encoding value when your add-in is running in Outlook on the web
|
|
15790
|
+
* `mailbox.diagnostics.hostVersion` property. You don't need to set the encoding value when your add-in is running in Outlook on the web and
|
|
15791
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
15736
15792
|
* To determine the Outlook client in which your add-in is running, use the `mailbox.diagnostics.hostName` property.
|
|
15737
15793
|
*
|
|
15738
15794
|
* @param data - The EWS request.
|
|
15739
15795
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15740
15796
|
* `asyncResult`, which is an `Office.AsyncResult` object. The XML response of the EWS request is provided as a string
|
|
15741
|
-
* in the `asyncResult.value` property. In Outlook on the web, on Windows
|
|
15742
|
-
* and
|
|
15743
|
-
* in
|
|
15744
|
-
* the response exceeds 1 MB in size.
|
|
15797
|
+
* in the `asyncResult.value` property. In Outlook on the web, on Windows
|
|
15798
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic (starting in Version 2303, Build 16225.10000)),
|
|
15799
|
+
* and on Mac (starting in Version 16.73 (23042601)), if the response exceeds 5 MB in size, an error message is returned in the `asyncResult.error` property.
|
|
15800
|
+
* In earlier versions of Outlook on Windows (classic) and on Mac, an error message is returned if the response exceeds 1 MB in size.
|
|
15745
15801
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
15746
15802
|
*/
|
|
15747
15803
|
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
@@ -16098,7 +16154,8 @@ declare namespace Office {
|
|
|
16098
16154
|
/**
|
|
16099
16155
|
* Gets an object that provides methods for managing the item's categories.
|
|
16100
16156
|
*
|
|
16101
|
-
* **Important**: In Outlook on the web
|
|
16157
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16158
|
+
* you can't use the API to manage categories on a message in Compose mode.
|
|
16102
16159
|
*
|
|
16103
16160
|
* @remarks
|
|
16104
16161
|
* [Api set: Mailbox 1.8]
|
|
@@ -16249,8 +16306,9 @@ declare namespace Office {
|
|
|
16249
16306
|
/**
|
|
16250
16307
|
* Gets the ID of the series that an instance belongs to.
|
|
16251
16308
|
*
|
|
16252
|
-
* In Outlook on the web
|
|
16253
|
-
*
|
|
16309
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
16310
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
16311
|
+
* However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
16254
16312
|
*
|
|
16255
16313
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
16256
16314
|
* The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API.
|
|
@@ -16524,8 +16582,8 @@ declare namespace Office {
|
|
|
16524
16582
|
*
|
|
16525
16583
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
16526
16584
|
*
|
|
16527
|
-
* If your Office Add-in is running in Outlook on the web
|
|
16528
|
-
* you are editing
|
|
16585
|
+
* If your Office Add-in is running in Outlook on the web or {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16586
|
+
* the `addItemAttachmentAsync` method can attach items to items other than the item that you are editing. However, this isn't supported and isn't recommended.
|
|
16529
16587
|
*
|
|
16530
16588
|
* @remarks
|
|
16531
16589
|
* [Api set: Mailbox 1.1]
|
|
@@ -16558,8 +16616,8 @@ declare namespace Office {
|
|
|
16558
16616
|
*
|
|
16559
16617
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
16560
16618
|
*
|
|
16561
|
-
* If your Office Add-in is running in Outlook on the web
|
|
16562
|
-
* you are editing
|
|
16619
|
+
* If your Office Add-in is running in Outlook on the web or {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16620
|
+
* the `addItemAttachmentAsync` method can attach items to items other than the item that you are editing. However, this isn't supported and isn't recommended.
|
|
16563
16621
|
*
|
|
16564
16622
|
* @remarks
|
|
16565
16623
|
* [Api set: Mailbox 1.1]
|
|
@@ -16595,8 +16653,9 @@ declare namespace Office {
|
|
|
16595
16653
|
*
|
|
16596
16654
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16597
16655
|
*
|
|
16598
|
-
* **Important**: In Outlook on the web
|
|
16599
|
-
*
|
|
16656
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16657
|
+
* if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, discard, or cancel even if no changes
|
|
16658
|
+
* have occurred since the item was last saved.
|
|
16600
16659
|
*
|
|
16601
16660
|
* **Tip**: Use the
|
|
16602
16661
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1) | closeAsync}
|
|
@@ -16667,10 +16726,11 @@ declare namespace Office {
|
|
|
16667
16726
|
*
|
|
16668
16727
|
* The behavior of this method depends on which client the add-in is running.
|
|
16669
16728
|
*
|
|
16670
|
-
* - In Outlook on the web
|
|
16729
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16730
|
+
* the signature option for new mails, replies, and forwards is disabled.
|
|
16671
16731
|
* A signature that's selected is also disabled by the method.
|
|
16672
16732
|
*
|
|
16673
|
-
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
16733
|
+
* - In Outlook on Windows (classic) and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
16674
16734
|
* of the sending account is set to **(none)**.
|
|
16675
16735
|
*
|
|
16676
16736
|
* - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
|
|
@@ -16697,10 +16757,11 @@ declare namespace Office {
|
|
|
16697
16757
|
*
|
|
16698
16758
|
* The behavior of this method depends on which client the add-in is running.
|
|
16699
16759
|
*
|
|
16700
|
-
* - In Outlook on the web
|
|
16760
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16761
|
+
* the signature option for new mails, replies, and forwards is disabled.
|
|
16701
16762
|
* A signature that's selected is also disabled by the method.
|
|
16702
16763
|
*
|
|
16703
|
-
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
16764
|
+
* - In Outlook on Windows (classic) and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
16704
16765
|
* of the sending account is set to **(none)**.
|
|
16705
16766
|
*
|
|
16706
16767
|
* - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
|
|
@@ -16725,9 +16786,9 @@ declare namespace Office {
|
|
|
16725
16786
|
*
|
|
16726
16787
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16727
16788
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16728
|
-
* In Outlook on the web
|
|
16729
|
-
* A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16730
|
-
* continue in a separate window.
|
|
16789
|
+
* In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16790
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16791
|
+
* then subsequently pops out the form to continue in a separate window.
|
|
16731
16792
|
*
|
|
16732
16793
|
* @remarks
|
|
16733
16794
|
* [Api set: Mailbox 1.8]
|
|
@@ -16756,9 +16817,9 @@ declare namespace Office {
|
|
|
16756
16817
|
*
|
|
16757
16818
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16758
16819
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16759
|
-
* In Outlook on the web
|
|
16760
|
-
* A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16761
|
-
* continue in a separate window.
|
|
16820
|
+
* In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16821
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16822
|
+
* then subsequently pops out the form to continue in a separate window.
|
|
16762
16823
|
*
|
|
16763
16824
|
* @remarks
|
|
16764
16825
|
* [Api set: Mailbox 1.8]
|
|
@@ -17149,7 +17210,8 @@ declare namespace Office {
|
|
|
17149
17210
|
*
|
|
17150
17211
|
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17151
17212
|
*
|
|
17152
|
-
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
17213
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
17214
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic) unless the following conditions are met.
|
|
17153
17215
|
*
|
|
17154
17216
|
* a. **Delegate access/Shared folders**
|
|
17155
17217
|
*
|
|
@@ -17191,7 +17253,8 @@ declare namespace Office {
|
|
|
17191
17253
|
*
|
|
17192
17254
|
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17193
17255
|
*
|
|
17194
|
-
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
17256
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
17257
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic) unless the following conditions are met.
|
|
17195
17258
|
*
|
|
17196
17259
|
* a. **Delegate access/Shared folders**
|
|
17197
17260
|
*
|
|
@@ -17219,10 +17282,12 @@ declare namespace Office {
|
|
|
17219
17282
|
/**
|
|
17220
17283
|
* Gets if the client signature is enabled.
|
|
17221
17284
|
*
|
|
17222
|
-
*
|
|
17285
|
+
* In Outlook on Windows (classic) and on Mac, the API call returns `true` if the default signature for new messages, replies, or forwards is set
|
|
17223
17286
|
* to a template for the sending Outlook account.
|
|
17224
|
-
*
|
|
17225
|
-
*
|
|
17287
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
17288
|
+
* the API call returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
17289
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or on Mac, or disabled in Outlook on the web or new Outlook on Windows,
|
|
17290
|
+
* the API call returns `false`.
|
|
17226
17291
|
*
|
|
17227
17292
|
* @remarks
|
|
17228
17293
|
* [Api set: Mailbox 1.10]
|
|
@@ -17240,10 +17305,12 @@ declare namespace Office {
|
|
|
17240
17305
|
/**
|
|
17241
17306
|
* Gets if the client signature is enabled.
|
|
17242
17307
|
*
|
|
17243
|
-
*
|
|
17308
|
+
* In Outlook on Windows (classic) and on Mac, the API call returns `true` if the default signature for new messages, replies, or forwards is set
|
|
17244
17309
|
* to a template for the sending Outlook account.
|
|
17245
|
-
*
|
|
17246
|
-
*
|
|
17310
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
17311
|
+
* the API call returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
17312
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or on Mac, or disabled in Outlook on the web or new Outlook on Windows,
|
|
17313
|
+
* the API call returns `false`.
|
|
17247
17314
|
*
|
|
17248
17315
|
* @remarks
|
|
17249
17316
|
* [Api set: Mailbox 1.10]
|
|
@@ -17287,7 +17354,8 @@ declare namespace Office {
|
|
|
17287
17354
|
*
|
|
17288
17355
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
17289
17356
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
17290
|
-
* in the same session. In Outlook on the web
|
|
17357
|
+
* in the same session. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
17358
|
+
* the attachment identifier is valid only within the same session.
|
|
17291
17359
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
17292
17360
|
* continue in a separate window.
|
|
17293
17361
|
*
|
|
@@ -17307,7 +17375,7 @@ declare namespace Office {
|
|
|
17307
17375
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
17308
17376
|
*
|
|
17309
17377
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
17310
|
-
* is 200 characters in Outlook on the web and on Windows.
|
|
17378
|
+
* is 200 characters in Outlook on the web and on Windows (new and classic).
|
|
17311
17379
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
17312
17380
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17313
17381
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -17320,7 +17388,8 @@ declare namespace Office {
|
|
|
17320
17388
|
*
|
|
17321
17389
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
17322
17390
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
17323
|
-
* in the same session. In Outlook on the web
|
|
17391
|
+
* in the same session. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
17392
|
+
* the attachment identifier is valid only within the same session.
|
|
17324
17393
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
17325
17394
|
* continue in a separate window.
|
|
17326
17395
|
*
|
|
@@ -17340,7 +17409,7 @@ declare namespace Office {
|
|
|
17340
17409
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
17341
17410
|
*
|
|
17342
17411
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
17343
|
-
* is 200 characters in Outlook on the web and on Windows.
|
|
17412
|
+
* is 200 characters in Outlook on the web and on Windows (new and classic).
|
|
17344
17413
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
17345
17414
|
* type `Office.AsyncResult`. If removing the attachment fails, the `asyncResult.error` property will contain an error code
|
|
17346
17415
|
* with the reason for the failure.
|
|
@@ -17396,7 +17465,8 @@ declare namespace Office {
|
|
|
17396
17465
|
*
|
|
17397
17466
|
* **Important**:
|
|
17398
17467
|
*
|
|
17399
|
-
* - In Outlook on the web
|
|
17468
|
+
* - In Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, or classic Outlook on Windows
|
|
17469
|
+
* in online mode (non-cached mode), the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
|
|
17400
17470
|
*
|
|
17401
17471
|
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
17402
17472
|
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
@@ -17405,7 +17475,7 @@ declare namespace Office {
|
|
|
17405
17475
|
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
|
|
17406
17476
|
* Until the item is synced, using the item ID will return an error.
|
|
17407
17477
|
*
|
|
17408
|
-
* - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
|
|
17478
|
+
* - In Outlook on the web and new Outlook on Windows, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
|
|
17409
17479
|
* from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
|
|
17410
17480
|
* in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
|
|
17411
17481
|
* shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
|
|
@@ -17433,7 +17503,8 @@ declare namespace Office {
|
|
|
17433
17503
|
*
|
|
17434
17504
|
* **Important**:
|
|
17435
17505
|
*
|
|
17436
|
-
* - In Outlook on the web
|
|
17506
|
+
* - In Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, or classic Outlook on Windows
|
|
17507
|
+
* in online mode (non-cached mode), the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
|
|
17437
17508
|
*
|
|
17438
17509
|
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
17439
17510
|
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
@@ -17442,7 +17513,7 @@ declare namespace Office {
|
|
|
17442
17513
|
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
|
|
17443
17514
|
* Until the item is synced, using the item ID will return an error.
|
|
17444
17515
|
*
|
|
17445
|
-
* - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
|
|
17516
|
+
* - In Outlook on the web and new Outlook on Windows, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
|
|
17446
17517
|
* from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
|
|
17447
17518
|
* in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
|
|
17448
17519
|
* shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
|
|
@@ -17478,10 +17549,12 @@ declare namespace Office {
|
|
|
17478
17549
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
17479
17550
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
17480
17551
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17481
|
-
* `coercionType`: If text, the current style is applied in Outlook on the web
|
|
17552
|
+
* `coercionType`: If text, the current style is applied in Outlook on the web, on Windows
|
|
17553
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac.
|
|
17482
17554
|
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
17483
|
-
* If
|
|
17484
|
-
*
|
|
17555
|
+
* If the data is HTML and the field supports HTML (the subject doesn't), the current style is applied in
|
|
17556
|
+
* Outlook on the web and new Outlook on Windows. The default style is applied in Outlook on Windows (classic) and on Mac.
|
|
17557
|
+
* If the field is a text field, an `InvalidDataFormat` error is returned.
|
|
17485
17558
|
* If `coercionType` is not set, the result depends on the field:
|
|
17486
17559
|
* if the field is HTML then HTML is used; if the field is text, then plain text is used.
|
|
17487
17560
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -17828,8 +17901,9 @@ declare namespace Office {
|
|
|
17828
17901
|
/**
|
|
17829
17902
|
* Gets the ID of the series that an instance belongs to.
|
|
17830
17903
|
*
|
|
17831
|
-
* In Outlook on the web
|
|
17832
|
-
*
|
|
17904
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
17905
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
17906
|
+
* However, in Outlook on Android and on iOS, the `seriesId` returns the REST ID of the parent item.
|
|
17833
17907
|
*
|
|
17834
17908
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
17835
17909
|
* The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API.
|
|
@@ -17966,9 +18040,10 @@ declare namespace Office {
|
|
|
17966
18040
|
*
|
|
17967
18041
|
* **Important**:
|
|
17968
18042
|
*
|
|
17969
|
-
* - In Outlook on the web
|
|
18043
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18044
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
17970
18045
|
*
|
|
17971
|
-
* - If any of the string parameters exceed their limits, `
|
|
18046
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception.
|
|
17972
18047
|
*
|
|
17973
18048
|
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17974
18049
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
@@ -17984,15 +18059,6 @@ declare namespace Office {
|
|
|
17984
18059
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
17985
18060
|
* selected appointment.
|
|
17986
18061
|
*
|
|
17987
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
17988
|
-
*
|
|
17989
|
-
* If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
17990
|
-
*
|
|
17991
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17992
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
17993
|
-
*
|
|
17994
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17995
|
-
*
|
|
17996
18062
|
* @remarks
|
|
17997
18063
|
* [Api set: Mailbox 1.9]
|
|
17998
18064
|
*
|
|
@@ -18000,6 +18066,19 @@ declare namespace Office {
|
|
|
18000
18066
|
*
|
|
18001
18067
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18002
18068
|
*
|
|
18069
|
+
* **Important**:
|
|
18070
|
+
*
|
|
18071
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18072
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18073
|
+
*
|
|
18074
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
18075
|
+
*
|
|
18076
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18077
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18078
|
+
*
|
|
18079
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18080
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18081
|
+
*
|
|
18003
18082
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
18004
18083
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
18005
18084
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -18012,15 +18091,6 @@ declare namespace Office {
|
|
|
18012
18091
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
18013
18092
|
* selected appointment.
|
|
18014
18093
|
*
|
|
18015
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18016
|
-
*
|
|
18017
|
-
* If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
18018
|
-
*
|
|
18019
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18020
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18021
|
-
*
|
|
18022
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
18023
|
-
*
|
|
18024
18094
|
* @remarks
|
|
18025
18095
|
* [Api set: Mailbox 1.9]
|
|
18026
18096
|
*
|
|
@@ -18028,6 +18098,19 @@ declare namespace Office {
|
|
|
18028
18098
|
*
|
|
18029
18099
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18030
18100
|
*
|
|
18101
|
+
* **Important**:
|
|
18102
|
+
*
|
|
18103
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18104
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18105
|
+
*
|
|
18106
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
18107
|
+
*
|
|
18108
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18109
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18110
|
+
*
|
|
18111
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18112
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18113
|
+
*
|
|
18031
18114
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
18032
18115
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
18033
18116
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -18046,7 +18129,8 @@ declare namespace Office {
|
|
|
18046
18129
|
*
|
|
18047
18130
|
* **Important**:
|
|
18048
18131
|
*
|
|
18049
|
-
* - In Outlook on the web
|
|
18132
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18133
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18050
18134
|
*
|
|
18051
18135
|
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
18052
18136
|
*
|
|
@@ -18063,15 +18147,6 @@ declare namespace Office {
|
|
|
18063
18147
|
/**
|
|
18064
18148
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
18065
18149
|
*
|
|
18066
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18067
|
-
*
|
|
18068
|
-
* If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
18069
|
-
*
|
|
18070
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18071
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18072
|
-
*
|
|
18073
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
18074
|
-
*
|
|
18075
18150
|
* @remarks
|
|
18076
18151
|
* [Api set: Mailbox 1.9]
|
|
18077
18152
|
*
|
|
@@ -18079,6 +18154,19 @@ declare namespace Office {
|
|
|
18079
18154
|
*
|
|
18080
18155
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18081
18156
|
*
|
|
18157
|
+
* **Important**:
|
|
18158
|
+
*
|
|
18159
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18160
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18161
|
+
*
|
|
18162
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
18163
|
+
*
|
|
18164
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18165
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18166
|
+
*
|
|
18167
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18168
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18169
|
+
*
|
|
18082
18170
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
18083
18171
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
18084
18172
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -18090,15 +18178,6 @@ declare namespace Office {
|
|
|
18090
18178
|
/**
|
|
18091
18179
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
18092
18180
|
*
|
|
18093
|
-
* In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18094
|
-
*
|
|
18095
|
-
* If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
18096
|
-
*
|
|
18097
|
-
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18098
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18099
|
-
*
|
|
18100
|
-
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
18101
|
-
*
|
|
18102
18181
|
* @remarks
|
|
18103
18182
|
* [Api set: Mailbox 1.9]
|
|
18104
18183
|
*
|
|
@@ -18106,6 +18185,19 @@ declare namespace Office {
|
|
|
18106
18185
|
*
|
|
18107
18186
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18108
18187
|
*
|
|
18188
|
+
* **Important**:
|
|
18189
|
+
*
|
|
18190
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18191
|
+
* the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
18192
|
+
*
|
|
18193
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
18194
|
+
*
|
|
18195
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
18196
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
18197
|
+
*
|
|
18198
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18199
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18200
|
+
*
|
|
18109
18201
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
18110
18202
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
18111
18203
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -18191,9 +18283,9 @@ declare namespace Office {
|
|
|
18191
18283
|
*
|
|
18192
18284
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
18193
18285
|
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
18194
|
-
* to retrieve the attachment. In Outlook on the web
|
|
18195
|
-
* A session is over when the user closes the app, or if the user starts composing an
|
|
18196
|
-
* continue in a separate window.
|
|
18286
|
+
* to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18287
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
|
|
18288
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
18197
18289
|
*
|
|
18198
18290
|
* @remarks
|
|
18199
18291
|
* [Api set: Mailbox 1.8]
|
|
@@ -18222,9 +18314,9 @@ declare namespace Office {
|
|
|
18222
18314
|
*
|
|
18223
18315
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
18224
18316
|
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
18225
|
-
* to retrieve the attachment. In Outlook on the web
|
|
18226
|
-
* A session is over when the user closes the app, or if the user starts composing an
|
|
18227
|
-
* continue in a separate window.
|
|
18317
|
+
* to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18318
|
+
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
|
|
18319
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
18228
18320
|
*
|
|
18229
18321
|
* @remarks
|
|
18230
18322
|
* [Api set: Mailbox 1.8]
|
|
@@ -18290,7 +18382,7 @@ declare namespace Office {
|
|
|
18290
18382
|
*/
|
|
18291
18383
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
18292
18384
|
/**
|
|
18293
|
-
* Returns well-known entities in the selected item that pass the named filter defined in an
|
|
18385
|
+
* Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.
|
|
18294
18386
|
*
|
|
18295
18387
|
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18296
18388
|
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
@@ -18301,7 +18393,7 @@ declare namespace Office {
|
|
|
18301
18393
|
*
|
|
18302
18394
|
* @returns
|
|
18303
18395
|
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
18304
|
-
* manifest
|
|
18396
|
+
* add-in manifest file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
18305
18397
|
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
18306
18398
|
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
18307
18399
|
*
|
|
@@ -18350,10 +18442,10 @@ declare namespace Office {
|
|
|
18350
18442
|
*/
|
|
18351
18443
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18352
18444
|
/**
|
|
18353
|
-
* Returns string values in the selected item that match the regular expressions defined in an
|
|
18445
|
+
* Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.
|
|
18354
18446
|
*
|
|
18355
18447
|
* @returns
|
|
18356
|
-
* An object that contains arrays of strings that match the regular expressions defined in the manifest
|
|
18448
|
+
* An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
|
|
18357
18449
|
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
18358
18450
|
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
18359
18451
|
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
@@ -18384,10 +18476,10 @@ declare namespace Office {
|
|
|
18384
18476
|
*/
|
|
18385
18477
|
getRegExMatches(): any;
|
|
18386
18478
|
/**
|
|
18387
|
-
* Returns string values in the selected item that match the named regular expression defined in an
|
|
18479
|
+
* Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.
|
|
18388
18480
|
*
|
|
18389
18481
|
* @returns
|
|
18390
|
-
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest
|
|
18482
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the add-in manifest file,
|
|
18391
18483
|
* with the specified `RegExName` element value.
|
|
18392
18484
|
*
|
|
18393
18485
|
* @remarks
|
|
@@ -18438,11 +18530,11 @@ declare namespace Office {
|
|
|
18438
18530
|
*/
|
|
18439
18531
|
getSelectedEntities(): Entities;
|
|
18440
18532
|
/**
|
|
18441
|
-
* Returns string values in a highlighted match that match the regular expressions defined in an
|
|
18533
|
+
* Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.
|
|
18442
18534
|
* Highlighted matches apply to contextual add-ins.
|
|
18443
18535
|
*
|
|
18444
18536
|
* @returns
|
|
18445
|
-
* An object that contains arrays of strings that match the regular expressions defined in the manifest
|
|
18537
|
+
* An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
|
|
18446
18538
|
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
18447
18539
|
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
|
|
18448
18540
|
* The `PropertyName` simple type defines the supported properties.
|
|
@@ -18677,7 +18769,8 @@ declare namespace Office {
|
|
|
18677
18769
|
*
|
|
18678
18770
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
18679
18771
|
*
|
|
18680
|
-
* **Important**: In modern Outlook on the web
|
|
18772
|
+
* **Important**: In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18773
|
+
* the `NotificationMessageAction` object is available in Compose mode only.
|
|
18681
18774
|
*/
|
|
18682
18775
|
interface NotificationMessageAction {
|
|
18683
18776
|
/**
|
|
@@ -18761,7 +18854,8 @@ declare namespace Office {
|
|
|
18761
18854
|
* Only applicable when the type is `InsightMessage`.
|
|
18762
18855
|
* Specifying this property for an unsupported type or including too many actions throws an error.
|
|
18763
18856
|
*
|
|
18764
|
-
* **Important**: In modern Outlook on the web
|
|
18857
|
+
* **Important**: In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18858
|
+
* the `actions` property is available in Compose mode only.
|
|
18765
18859
|
*
|
|
18766
18860
|
* @remarks
|
|
18767
18861
|
* [Api set: Mailbox 1.10]
|
|
@@ -18798,7 +18892,8 @@ declare namespace Office {
|
|
|
18798
18892
|
* - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
|
|
18799
18893
|
* is allowed per add-in. Attempting to add more will throw an error.
|
|
18800
18894
|
*
|
|
18801
|
-
* - In modern Outlook on the web
|
|
18895
|
+
* - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18896
|
+
* you can add an `InsightMessage` notification only in Compose mode.
|
|
18802
18897
|
*
|
|
18803
18898
|
* - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
|
|
18804
18899
|
*
|
|
@@ -18829,7 +18924,8 @@ declare namespace Office {
|
|
|
18829
18924
|
* - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
|
|
18830
18925
|
* is allowed per add-in. Attempting to add more will throw an error.
|
|
18831
18926
|
*
|
|
18832
|
-
* - In modern Outlook on the web
|
|
18927
|
+
* - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18928
|
+
* you can add an `InsightMessage` notification only in Compose mode.
|
|
18833
18929
|
*
|
|
18834
18930
|
* - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
|
|
18835
18931
|
*
|
|
@@ -19095,10 +19191,11 @@ declare namespace Office {
|
|
|
19095
19191
|
*
|
|
19096
19192
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19097
19193
|
*
|
|
19098
|
-
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
19099
|
-
* on Mac (classic UI), on Android, and on iOS.
|
|
19194
|
+
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
19195
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19196
|
+
* However, take note of the following:
|
|
19100
19197
|
*
|
|
19101
|
-
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19198
|
+
* - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19102
19199
|
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
19103
19200
|
*
|
|
19104
19201
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -19165,7 +19262,7 @@ declare namespace Office {
|
|
|
19165
19262
|
*
|
|
19166
19263
|
* The maximum number of recipients returned by this method varies per Outlook client.
|
|
19167
19264
|
*
|
|
19168
|
-
* - Windows, web browser, Mac (classic UI): 500 recipients
|
|
19265
|
+
* - Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), web browser, Mac (classic UI): 500 recipients
|
|
19169
19266
|
*
|
|
19170
19267
|
* - Android, iOS: 100 recipients
|
|
19171
19268
|
*
|
|
@@ -19184,10 +19281,10 @@ declare namespace Office {
|
|
|
19184
19281
|
* To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
|
|
19185
19282
|
* the auto-complete list.
|
|
19186
19283
|
*
|
|
19187
|
-
* In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
|
|
19284
|
+
* In Outlook on the web and on Windows (new and classic), if a user creates a new message by activating a contact's email address link from their contact
|
|
19188
19285
|
* or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
|
|
19189
|
-
* {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name.
|
|
19190
|
-
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
19286
|
+
* {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name.
|
|
19287
|
+
* For more details, see {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
19191
19288
|
*
|
|
19192
19289
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19193
19290
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -19210,7 +19307,7 @@ declare namespace Office {
|
|
|
19210
19307
|
*
|
|
19211
19308
|
* The maximum number of recipients returned by this method varies per Outlook client.
|
|
19212
19309
|
*
|
|
19213
|
-
* - Windows, web browser, Mac (classic UI): 500 recipients
|
|
19310
|
+
* - Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), web browser, Mac (classic UI): 500 recipients
|
|
19214
19311
|
*
|
|
19215
19312
|
* - Android, iOS: 100 recipients
|
|
19216
19313
|
*
|
|
@@ -19229,10 +19326,10 @@ declare namespace Office {
|
|
|
19229
19326
|
* To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
|
|
19230
19327
|
* the auto-complete list.
|
|
19231
19328
|
*
|
|
19232
|
-
* In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
|
|
19329
|
+
* In Outlook on the web and on Windows (new and classic), if a user creates a new message by activating a contact's email address link from their contact
|
|
19233
19330
|
* or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
|
|
19234
|
-
* {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name.
|
|
19235
|
-
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
19331
|
+
* {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name.
|
|
19332
|
+
* For more details, see {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
19236
19333
|
*
|
|
19237
19334
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19238
19335
|
* of type `Office.AsyncResult`. The `asyncResult.value` property of the result is an array of
|
|
@@ -19251,10 +19348,11 @@ declare namespace Office {
|
|
|
19251
19348
|
*
|
|
19252
19349
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19253
19350
|
*
|
|
19254
|
-
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19255
|
-
* on Mac (classic UI), on Android, and on iOS.
|
|
19351
|
+
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19352
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19353
|
+
* However, take note of the following:
|
|
19256
19354
|
*
|
|
19257
|
-
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19355
|
+
* - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19258
19356
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
19259
19357
|
*
|
|
19260
19358
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -19288,10 +19386,11 @@ declare namespace Office {
|
|
|
19288
19386
|
*
|
|
19289
19387
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19290
19388
|
*
|
|
19291
|
-
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19292
|
-
* on Mac (classic UI), on Android, and on iOS.
|
|
19389
|
+
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19390
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19391
|
+
* However, take note of the following:
|
|
19293
19392
|
*
|
|
19294
|
-
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19393
|
+
* - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
19295
19394
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
19296
19395
|
*
|
|
19297
19396
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -19725,7 +19824,8 @@ declare namespace Office {
|
|
|
19725
19824
|
* your add-in has persisted changes.
|
|
19726
19825
|
* The persisted changes will not be available until the task pane (or item in the case of UI-less add-ins) is closed and reopened.
|
|
19727
19826
|
*
|
|
19728
|
-
* - When set and saved through Outlook on Windows
|
|
19827
|
+
* - When set and saved through Outlook on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} or classic) or on Mac,
|
|
19828
|
+
* these settings are reflected in Outlook on the web only after a browser refresh.
|
|
19729
19829
|
*
|
|
19730
19830
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
19731
19831
|
*
|
|
@@ -19911,9 +20011,9 @@ declare namespace Office {
|
|
|
19911
20011
|
*
|
|
19912
20012
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19913
20013
|
*
|
|
19914
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
19915
|
-
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity
|
|
19916
|
-
* is returned in the `asyncResult.value` property.
|
|
20014
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and
|
|
20015
|
+
* Outlook on Mac only support Normal and Private sensitivity levels. If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity
|
|
20016
|
+
* level from these clients, the Normal sensitivity level is returned in the `asyncResult.value` property.
|
|
19917
20017
|
*
|
|
19918
20018
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19919
20019
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -19931,9 +20031,9 @@ declare namespace Office {
|
|
|
19931
20031
|
*
|
|
19932
20032
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19933
20033
|
*
|
|
19934
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
19935
|
-
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity
|
|
19936
|
-
* is returned in the `asyncResult.value` property.
|
|
20034
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and
|
|
20035
|
+
* Outlook on Mac only support Normal and Private sensitivity levels. If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity
|
|
20036
|
+
* level from these clients, the Normal sensitivity level is returned in the `asyncResult.value` property.
|
|
19937
20037
|
*
|
|
19938
20038
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19939
20039
|
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
@@ -19949,7 +20049,8 @@ declare namespace Office {
|
|
|
19949
20049
|
*
|
|
19950
20050
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19951
20051
|
*
|
|
19952
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
20052
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and Outlook on Mac
|
|
20053
|
+
* only support Normal and Private sensitivity levels.
|
|
19953
20054
|
*
|
|
19954
20055
|
* **Errors**:
|
|
19955
20056
|
*
|
|
@@ -19972,7 +20073,8 @@ declare namespace Office {
|
|
|
19972
20073
|
*
|
|
19973
20074
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19974
20075
|
*
|
|
19975
|
-
* **Important**: Outlook on the web, new Outlook on Windows
|
|
20076
|
+
* **Important**: Outlook on the web, {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}, and Outlook on Mac
|
|
20077
|
+
* only support Normal and Private sensitivity levels.
|
|
19976
20078
|
*
|
|
19977
20079
|
* **Errors**:
|
|
19978
20080
|
*
|
|
@@ -20681,7 +20783,7 @@ declare namespace Office {
|
|
|
20681
20783
|
* 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
|
|
20682
20784
|
* add-in uses.
|
|
20683
20785
|
*
|
|
20684
|
-
* - **
|
|
20786
|
+
* - **Add-in only manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
|
|
20685
20787
|
*
|
|
20686
20788
|
* - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "extensions.ribbons.tabs.groups.controls" array.
|
|
20687
20789
|
*
|
|
@@ -20868,9 +20970,9 @@ declare namespace Office {
|
|
|
20868
20970
|
*
|
|
20869
20971
|
* **Important**:
|
|
20870
20972
|
*
|
|
20871
|
-
* - You can only use this property in a spam-reporting add-in in Outlook on the web, on Windows (
|
|
20872
|
-
* and in
|
|
20873
|
-
* `postProcessingAction` property instead.
|
|
20973
|
+
* - You can only use this property in a spam-reporting add-in in Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new}
|
|
20974
|
+
* and classic (starting in Version 2308, Build 16724.10000)), and on Mac. If you're using an earlier build of classic Outlook on Windows that supports the
|
|
20975
|
+
* integrated spam-reporting feature, use the `postProcessingAction` property instead.
|
|
20874
20976
|
*
|
|
20875
20977
|
* - If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
20876
20978
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
@@ -20916,7 +21018,8 @@ declare namespace Office {
|
|
|
20916
21018
|
* - In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
|
|
20917
21019
|
* If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
|
|
20918
21020
|
*
|
|
20919
|
-
* - This property isn't supported in Outlook on the web, on Mac, or in new Outlook on Windows
|
|
21021
|
+
* - This property isn't supported in Outlook on the web, on Mac, or in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
21022
|
+
* Use the `moveItemTo` property instead.
|
|
20920
21023
|
*
|
|
20921
21024
|
* - If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
20922
21025
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
@@ -20935,12 +21038,6 @@ declare namespace Office {
|
|
|
20935
21038
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
20936
21039
|
*
|
|
20937
21040
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20938
|
-
*
|
|
20939
|
-
* **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
|
|
20940
|
-
* reported message. This applies even if `showPostProcessingDialog` is configured. However, depending on how you configured the `moveItemTo` property in the
|
|
20941
|
-
* `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
|
|
20942
|
-
* the "Review feature behavior and limitations" section of
|
|
20943
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#review-feature-behavior-and-limitations | Implement an integrated spam-reporting add-in}.
|
|
20944
21041
|
*/
|
|
20945
21042
|
showPostProcessingDialog?: object;
|
|
20946
21043
|
}
|
|
@@ -21264,7 +21361,8 @@ declare namespace Office {
|
|
|
21264
21361
|
/**
|
|
21265
21362
|
* Gets the user's time zone in Windows format.
|
|
21266
21363
|
*
|
|
21267
|
-
* The system time zone is usually returned. However, in Outlook on the web
|
|
21364
|
+
* The system time zone is usually returned. However, in Outlook on the web and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}),
|
|
21365
|
+
* the default time zone in the calendar preferences is returned instead.
|
|
21268
21366
|
*
|
|
21269
21367
|
* @remarks
|
|
21270
21368
|
*
|