@types/office-js-preview 1.0.529 → 1.0.531
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 +2195 -160
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -12733,8 +12733,9 @@ declare namespace Office {
|
|
|
12733
12733
|
/**
|
|
12734
12734
|
* Appends on send the specified content to the end of the item body, after any signature.
|
|
12735
12735
|
*
|
|
12736
|
-
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest.
|
|
12737
|
-
*
|
|
12736
|
+
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest.
|
|
12737
|
+
* See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12738
|
+
* To learn more about append-on-send and its configuration, see
|
|
12738
12739
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12739
12740
|
*
|
|
12740
12741
|
* @remarks
|
|
@@ -12760,6 +12761,9 @@ declare namespace Office {
|
|
|
12760
12761
|
*
|
|
12761
12762
|
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12762
12763
|
*
|
|
12764
|
+
* - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
12765
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
12766
|
+
*
|
|
12763
12767
|
* **Errors**:
|
|
12764
12768
|
*
|
|
12765
12769
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12777,8 +12781,9 @@ declare namespace Office {
|
|
|
12777
12781
|
/**
|
|
12778
12782
|
* Appends on send the specified content to the end of the item body, after any signature.
|
|
12779
12783
|
*
|
|
12780
|
-
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest.
|
|
12781
|
-
*
|
|
12784
|
+
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest.
|
|
12785
|
+
* See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12786
|
+
* To learn more about append-on-send and its configuration, see
|
|
12782
12787
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12783
12788
|
*
|
|
12784
12789
|
* @remarks
|
|
@@ -12804,6 +12809,9 @@ declare namespace Office {
|
|
|
12804
12809
|
*
|
|
12805
12810
|
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12806
12811
|
*
|
|
12812
|
+
* - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
12813
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
12814
|
+
*
|
|
12807
12815
|
* **Errors**:
|
|
12808
12816
|
*
|
|
12809
12817
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12946,6 +12954,9 @@ declare namespace Office {
|
|
|
12946
12954
|
*
|
|
12947
12955
|
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12948
12956
|
*
|
|
12957
|
+
* - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
12958
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
12959
|
+
*
|
|
12949
12960
|
* **Errors**:
|
|
12950
12961
|
*
|
|
12951
12962
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -12993,6 +13004,9 @@ declare namespace Office {
|
|
|
12993
13004
|
*
|
|
12994
13005
|
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12995
13006
|
*
|
|
13007
|
+
* - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13008
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13009
|
+
*
|
|
12996
13010
|
* **Errors**:
|
|
12997
13011
|
*
|
|
12998
13012
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13033,6 +13047,9 @@ declare namespace Office {
|
|
|
13033
13047
|
*
|
|
13034
13048
|
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13035
13049
|
*
|
|
13050
|
+
* - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13051
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13052
|
+
*
|
|
13036
13053
|
* **Errors**:
|
|
13037
13054
|
*
|
|
13038
13055
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
@@ -13078,6 +13095,9 @@ declare namespace Office {
|
|
|
13078
13095
|
*
|
|
13079
13096
|
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13080
13097
|
*
|
|
13098
|
+
* - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13099
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13100
|
+
*
|
|
13081
13101
|
* **Errors**:
|
|
13082
13102
|
*
|
|
13083
13103
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
@@ -13116,7 +13136,7 @@ declare namespace Office {
|
|
|
13116
13136
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13117
13137
|
* (see the **Examples** section for a sample).
|
|
13118
13138
|
*
|
|
13119
|
-
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
13139
|
+
* - In Outlook on Windows (classic) and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
13120
13140
|
*
|
|
13121
13141
|
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
13122
13142
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
@@ -13126,6 +13146,9 @@ declare namespace Office {
|
|
|
13126
13146
|
*
|
|
13127
13147
|
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13128
13148
|
*
|
|
13149
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13150
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13151
|
+
*
|
|
13129
13152
|
* **Errors**:
|
|
13130
13153
|
*
|
|
13131
13154
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13167,7 +13190,7 @@ declare namespace Office {
|
|
|
13167
13190
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13168
13191
|
* (see the **Examples** section for a sample).
|
|
13169
13192
|
*
|
|
13170
|
-
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
13193
|
+
* - In Outlook on Windows (classic) and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
13171
13194
|
*
|
|
13172
13195
|
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
13173
13196
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
@@ -13177,6 +13200,9 @@ declare namespace Office {
|
|
|
13177
13200
|
*
|
|
13178
13201
|
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13179
13202
|
*
|
|
13203
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13204
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13205
|
+
*
|
|
13180
13206
|
* **Errors**:
|
|
13181
13207
|
*
|
|
13182
13208
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13204,7 +13230,7 @@ declare namespace Office {
|
|
|
13204
13230
|
*
|
|
13205
13231
|
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13206
13232
|
*
|
|
13207
|
-
* **Important
|
|
13233
|
+
* **Important**:
|
|
13208
13234
|
*
|
|
13209
13235
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13210
13236
|
* (see the **Examples** section for a sample).
|
|
@@ -13213,6 +13239,9 @@ declare namespace Office {
|
|
|
13213
13239
|
*
|
|
13214
13240
|
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13215
13241
|
*
|
|
13242
|
+
* - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13243
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13244
|
+
*
|
|
13216
13245
|
* **Errors**:
|
|
13217
13246
|
*
|
|
13218
13247
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13243,7 +13272,7 @@ declare namespace Office {
|
|
|
13243
13272
|
*
|
|
13244
13273
|
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13245
13274
|
*
|
|
13246
|
-
* **Important
|
|
13275
|
+
* **Important**:
|
|
13247
13276
|
*
|
|
13248
13277
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13249
13278
|
* (see the **Examples** section for a sample).
|
|
@@ -13252,6 +13281,9 @@ declare namespace Office {
|
|
|
13252
13281
|
*
|
|
13253
13282
|
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13254
13283
|
*
|
|
13284
|
+
* - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13285
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13286
|
+
*
|
|
13255
13287
|
* **Errors**:
|
|
13256
13288
|
*
|
|
13257
13289
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13292,6 +13324,9 @@ declare namespace Office {
|
|
|
13292
13324
|
*
|
|
13293
13325
|
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13294
13326
|
*
|
|
13327
|
+
* - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13328
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13329
|
+
*
|
|
13295
13330
|
* **Errors**:
|
|
13296
13331
|
*
|
|
13297
13332
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13336,6 +13371,9 @@ declare namespace Office {
|
|
|
13336
13371
|
*
|
|
13337
13372
|
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13338
13373
|
*
|
|
13374
|
+
* - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13375
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13376
|
+
*
|
|
13339
13377
|
* **Errors**:
|
|
13340
13378
|
*
|
|
13341
13379
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13370,9 +13408,6 @@ declare namespace Office {
|
|
|
13370
13408
|
* Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name
|
|
13371
13409
|
* but multiple categories can use the same color.
|
|
13372
13410
|
*
|
|
13373
|
-
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13374
|
-
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13375
|
-
*
|
|
13376
13411
|
* @remarks
|
|
13377
13412
|
* [Api set: Mailbox 1.8]
|
|
13378
13413
|
*
|
|
@@ -13380,6 +13415,9 @@ declare namespace Office {
|
|
|
13380
13415
|
*
|
|
13381
13416
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13382
13417
|
*
|
|
13418
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13419
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13420
|
+
*
|
|
13383
13421
|
* **Errors**:
|
|
13384
13422
|
*
|
|
13385
13423
|
* - `InvalidCategory`: Invalid categories were provided.
|
|
@@ -13395,9 +13433,6 @@ declare namespace Office {
|
|
|
13395
13433
|
* Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name
|
|
13396
13434
|
* but multiple categories can use the same color.
|
|
13397
13435
|
*
|
|
13398
|
-
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13399
|
-
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13400
|
-
*
|
|
13401
13436
|
* @remarks
|
|
13402
13437
|
* [Api set: Mailbox 1.8]
|
|
13403
13438
|
*
|
|
@@ -13405,6 +13440,9 @@ declare namespace Office {
|
|
|
13405
13440
|
*
|
|
13406
13441
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13407
13442
|
*
|
|
13443
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13444
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13445
|
+
*
|
|
13408
13446
|
* **Errors**:
|
|
13409
13447
|
*
|
|
13410
13448
|
* - `InvalidCategory`: Invalid categories were provided.
|
|
@@ -13463,9 +13501,6 @@ declare namespace Office {
|
|
|
13463
13501
|
/**
|
|
13464
13502
|
* Removes categories from an item.
|
|
13465
13503
|
*
|
|
13466
|
-
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13467
|
-
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13468
|
-
*
|
|
13469
13504
|
* @remarks
|
|
13470
13505
|
* [Api set: Mailbox 1.8]
|
|
13471
13506
|
*
|
|
@@ -13473,6 +13508,9 @@ declare namespace Office {
|
|
|
13473
13508
|
*
|
|
13474
13509
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13475
13510
|
*
|
|
13511
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13512
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13513
|
+
*
|
|
13476
13514
|
* @param categories - The categories to be removed from the item.
|
|
13477
13515
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
13478
13516
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -13483,9 +13521,6 @@ declare namespace Office {
|
|
|
13483
13521
|
/**
|
|
13484
13522
|
* Removes categories from an item.
|
|
13485
13523
|
*
|
|
13486
|
-
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13487
|
-
* you can't use the API to manage categories applied to a message in Compose mode.
|
|
13488
|
-
*
|
|
13489
13524
|
* @remarks
|
|
13490
13525
|
* [Api set: Mailbox 1.8]
|
|
13491
13526
|
*
|
|
@@ -13493,6 +13528,9 @@ declare namespace Office {
|
|
|
13493
13528
|
*
|
|
13494
13529
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13495
13530
|
*
|
|
13531
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
13532
|
+
* you can't use the API to manage categories applied to a message or appointment item in Compose mode.
|
|
13533
|
+
*
|
|
13496
13534
|
* @param categories - The categories to be removed from the item.
|
|
13497
13535
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
13498
13536
|
* type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code.
|
|
@@ -13679,6 +13717,9 @@ declare namespace Office {
|
|
|
13679
13717
|
*
|
|
13680
13718
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13681
13719
|
*
|
|
13720
|
+
* **Important**: The `remove` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13721
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13722
|
+
*
|
|
13682
13723
|
* @param name - The `name` of the property to be removed.
|
|
13683
13724
|
*/
|
|
13684
13725
|
remove(name: string): void;
|
|
@@ -13737,9 +13778,9 @@ declare namespace Office {
|
|
|
13737
13778
|
* The `set` method sets the specified property to the specified value. To ensure that the set property and value persist on the mail item,
|
|
13738
13779
|
* you must call the `saveAsync` method.
|
|
13739
13780
|
*
|
|
13740
|
-
* The `set` method creates a new property if the specified property
|
|
13781
|
+
* The `set` method creates a new property if the specified property doesn't already exist;
|
|
13741
13782
|
* otherwise, the existing value is replaced with the new value.
|
|
13742
|
-
* The `value` parameter can be of any type; however, it
|
|
13783
|
+
* The `value` parameter can be of any type; however, it's always passed to the server as a string.
|
|
13743
13784
|
*
|
|
13744
13785
|
* @remarks
|
|
13745
13786
|
* [Api set: Mailbox 1.1]
|
|
@@ -13748,6 +13789,9 @@ declare namespace Office {
|
|
|
13748
13789
|
*
|
|
13749
13790
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13750
13791
|
*
|
|
13792
|
+
* **Important**: The `set` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13793
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13794
|
+
*
|
|
13751
13795
|
* @param name - The name of the property to be set.
|
|
13752
13796
|
* @param value - The value of the property to be set.
|
|
13753
13797
|
*/
|
|
@@ -13806,7 +13850,9 @@ declare namespace Office {
|
|
|
13806
13850
|
*
|
|
13807
13851
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13808
13852
|
*
|
|
13809
|
-
* **Important**:
|
|
13853
|
+
* **Important**:
|
|
13854
|
+
*
|
|
13855
|
+
* - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
|
|
13810
13856
|
* This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on Windows, the message doesn't appear in the
|
|
13811
13857
|
* **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
|
|
13812
13858
|
* the message from the **Sent Items** folder. In Outlook on the web, on Mac, and in
|
|
@@ -13814,6 +13860,9 @@ declare namespace Office {
|
|
|
13814
13860
|
* until the scheduled delivery time. While it's in the **Drafts** folder, you'll be able to edit the message before it's sent.
|
|
13815
13861
|
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
|
|
13816
13862
|
*
|
|
13863
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13864
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13865
|
+
*
|
|
13817
13866
|
* **Errors**:
|
|
13818
13867
|
*
|
|
13819
13868
|
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
@@ -13835,7 +13884,9 @@ declare namespace Office {
|
|
|
13835
13884
|
*
|
|
13836
13885
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13837
13886
|
*
|
|
13838
|
-
* **Important**:
|
|
13887
|
+
* **Important**:
|
|
13888
|
+
*
|
|
13889
|
+
* - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
|
|
13839
13890
|
* This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on Windows, the message doesn't appear in the
|
|
13840
13891
|
* **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
|
|
13841
13892
|
* the message from the **Sent Items** folder. In Outlook on the web, on Mac, and in
|
|
@@ -13843,6 +13894,9 @@ declare namespace Office {
|
|
|
13843
13894
|
* until the scheduled delivery time. While it's in the **Drafts** folder, you'll be able to edit the message before it's sent.
|
|
13844
13895
|
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
|
|
13845
13896
|
*
|
|
13897
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13898
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13899
|
+
*
|
|
13846
13900
|
* **Errors**:
|
|
13847
13901
|
*
|
|
13848
13902
|
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
@@ -14661,10 +14715,15 @@ declare namespace Office {
|
|
|
14661
14715
|
*
|
|
14662
14716
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14663
14717
|
*
|
|
14664
|
-
* **Important**:
|
|
14718
|
+
* **Important**:
|
|
14719
|
+
*
|
|
14720
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14665
14721
|
* To learn more about features supported in Outlook on mobile devices, see
|
|
14666
14722
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14667
14723
|
*
|
|
14724
|
+
* - The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14725
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14726
|
+
*
|
|
14668
14727
|
* @param names - The names of the internet headers to be removed.
|
|
14669
14728
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
14670
14729
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -14678,144 +14737,1967 @@ declare namespace Office {
|
|
|
14678
14737
|
* **Note**: This method is intended to remove the custom headers you set using the `setAsync` method.
|
|
14679
14738
|
*
|
|
14680
14739
|
* @remarks
|
|
14681
|
-
* [Api set: Mailbox 1.8]
|
|
14740
|
+
* [Api set: Mailbox 1.8]
|
|
14741
|
+
*
|
|
14742
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14743
|
+
*
|
|
14744
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14745
|
+
*
|
|
14746
|
+
* **Important**:
|
|
14747
|
+
*
|
|
14748
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14749
|
+
* To learn more about features supported in Outlook on mobile devices, see
|
|
14750
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14751
|
+
*
|
|
14752
|
+
* - The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14753
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14754
|
+
*
|
|
14755
|
+
* @param names - The names of the internet headers to be removed.
|
|
14756
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14757
|
+
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
|
|
14758
|
+
*/
|
|
14759
|
+
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14760
|
+
/**
|
|
14761
|
+
* Sets the specified internet headers to the specified values.
|
|
14762
|
+
*
|
|
14763
|
+
* The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with
|
|
14764
|
+
* the new value.
|
|
14765
|
+
*
|
|
14766
|
+
* **Note**: This method is intended to set the values of your custom headers.
|
|
14767
|
+
*
|
|
14768
|
+
* @remarks
|
|
14769
|
+
* [Api set: Mailbox 1.8]
|
|
14770
|
+
*
|
|
14771
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14772
|
+
*
|
|
14773
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14774
|
+
*
|
|
14775
|
+
* **Important**:
|
|
14776
|
+
*
|
|
14777
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14778
|
+
* To learn more about features supported in Outlook on mobile devices, see
|
|
14779
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14780
|
+
*
|
|
14781
|
+
* - The header quota is based on the total size of headers applied to a message. In Exchange Online,
|
|
14782
|
+
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
|
|
14783
|
+
* For further information on header limits, see
|
|
14784
|
+
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14785
|
+
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
14786
|
+
*
|
|
14787
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14788
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14789
|
+
*
|
|
14790
|
+
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
|
|
14791
|
+
* and values being the corresponding header value strings.
|
|
14792
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
14793
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14794
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14795
|
+
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
|
|
14796
|
+
*/
|
|
14797
|
+
setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14798
|
+
/**
|
|
14799
|
+
* Sets the specified internet headers to the specified values.
|
|
14800
|
+
*
|
|
14801
|
+
* The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with
|
|
14802
|
+
* the new value.
|
|
14803
|
+
*
|
|
14804
|
+
* **Note**: This method is intended to set the values of your custom headers.
|
|
14805
|
+
*
|
|
14806
|
+
* @remarks
|
|
14807
|
+
* [Api set: Mailbox 1.8]
|
|
14808
|
+
*
|
|
14809
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14810
|
+
*
|
|
14811
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14812
|
+
*
|
|
14813
|
+
* **Important**:
|
|
14814
|
+
*
|
|
14815
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14816
|
+
* To learn more about features supported in Outlook on mobile devices, see
|
|
14817
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14818
|
+
*
|
|
14819
|
+
* - The header quota is based on the total size of headers applied to a message. In Exchange Online,
|
|
14820
|
+
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
|
|
14821
|
+
* For further information on header limits, see
|
|
14822
|
+
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14823
|
+
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
14824
|
+
*
|
|
14825
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14826
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14827
|
+
*
|
|
14828
|
+
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
|
|
14829
|
+
* and values being the corresponding header value strings.
|
|
14830
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14831
|
+
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
|
|
14832
|
+
*/
|
|
14833
|
+
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14834
|
+
}
|
|
14835
|
+
/**
|
|
14836
|
+
* The item namespace is used to access the currently selected message, meeting request, or appointment.
|
|
14837
|
+
* You can determine the type of the item by using the `itemType` property.
|
|
14838
|
+
*
|
|
14839
|
+
* To see the full member list, refer to the
|
|
14840
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14841
|
+
*
|
|
14842
|
+
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
14843
|
+
*
|
|
14844
|
+
* - {@link Office.AppointmentCompose | AppointmentCompose}
|
|
14845
|
+
*
|
|
14846
|
+
* - {@link Office.AppointmentRead | AppointmentRead}
|
|
14847
|
+
*
|
|
14848
|
+
* - {@link Office.MessageCompose | MessageCompose}
|
|
14849
|
+
*
|
|
14850
|
+
* - {@link Office.MessageRead | MessageRead}
|
|
14851
|
+
*
|
|
14852
|
+
* @remarks
|
|
14853
|
+
*
|
|
14854
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
14855
|
+
*
|
|
14856
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read
|
|
14857
|
+
*/
|
|
14858
|
+
interface Item {
|
|
14859
|
+
}
|
|
14860
|
+
/**
|
|
14861
|
+
* The compose mode of {@link Office.Item | Office.context.mailbox.item}.
|
|
14862
|
+
*
|
|
14863
|
+
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14864
|
+
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14865
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14866
|
+
*
|
|
14867
|
+
* Child interfaces:
|
|
14868
|
+
*
|
|
14869
|
+
* - {@link Office.AppointmentCompose | AppointmentCompose}
|
|
14870
|
+
*
|
|
14871
|
+
* - {@link Office.MessageCompose | MessageCompose}
|
|
14872
|
+
*/
|
|
14873
|
+
interface ItemCompose extends Item {
|
|
14874
|
+
}
|
|
14875
|
+
/**
|
|
14876
|
+
* The read mode of {@link Office.Item | Office.context.mailbox.item}.
|
|
14877
|
+
*
|
|
14878
|
+
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14879
|
+
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14880
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14881
|
+
*
|
|
14882
|
+
* Child interfaces:
|
|
14883
|
+
*
|
|
14884
|
+
* - {@link Office.AppointmentRead | AppointmentRead}
|
|
14885
|
+
*
|
|
14886
|
+
* - {@link Office.MessageRead | MessageRead}
|
|
14887
|
+
*/
|
|
14888
|
+
interface ItemRead extends Item {
|
|
14889
|
+
}
|
|
14890
|
+
/**
|
|
14891
|
+
* Represents a message in compose mode that's currently loaded.
|
|
14892
|
+
* A `LoadedMessageCompose` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in compose mode.
|
|
14893
|
+
*
|
|
14894
|
+
* @remarks
|
|
14895
|
+
* [Api set: Mailbox preview]
|
|
14896
|
+
*
|
|
14897
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14898
|
+
*
|
|
14899
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14900
|
+
*
|
|
14901
|
+
* **Important**:
|
|
14902
|
+
*
|
|
14903
|
+
* - When implementing the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select feature},
|
|
14904
|
+
* determine if you can already access the required properties of the selected item through the
|
|
14905
|
+
* `Office.context.mailbox.getSelectedItemsAsync` call. If you can, you don't need to call `loadItemByIdAsync`.
|
|
14906
|
+
*
|
|
14907
|
+
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
14908
|
+
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
14909
|
+
*
|
|
14910
|
+
* @beta
|
|
14911
|
+
*/
|
|
14912
|
+
interface LoadedMessageCompose {
|
|
14913
|
+
/**
|
|
14914
|
+
* Gets the recipients on the **Bcc** (blind carbon copy) line of a message.
|
|
14915
|
+
*
|
|
14916
|
+
* @remarks
|
|
14917
|
+
* [Api set: Mailbox 1.1]
|
|
14918
|
+
*
|
|
14919
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14920
|
+
*
|
|
14921
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14922
|
+
*
|
|
14923
|
+
* **Important**:
|
|
14924
|
+
*
|
|
14925
|
+
* - Only the `getAsync` method of the Recipients object is supported.
|
|
14926
|
+
*
|
|
14927
|
+
* - Depending on the Outlook client and platform, limits may apply on how many recipients you can get.
|
|
14928
|
+
* For more information, see the {@link Office.Recipients | Recipients} object.
|
|
14929
|
+
*/
|
|
14930
|
+
bcc: Recipients;
|
|
14931
|
+
/**
|
|
14932
|
+
* Gets the item's body and format.
|
|
14933
|
+
*
|
|
14934
|
+
* @remarks
|
|
14935
|
+
* [Api set: Mailbox 1.1]
|
|
14936
|
+
*
|
|
14937
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14938
|
+
*
|
|
14939
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14940
|
+
*
|
|
14941
|
+
* **Important**: Only the `getAsync` and `getTypeAsync` methods of the Body object are supported.
|
|
14942
|
+
*/
|
|
14943
|
+
body: Body;
|
|
14944
|
+
/**
|
|
14945
|
+
* Gets an object that provides methods to manage the item's categories.
|
|
14946
|
+
*
|
|
14947
|
+
* @remarks
|
|
14948
|
+
* [Api set: Mailbox 1.8]
|
|
14949
|
+
*
|
|
14950
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14951
|
+
*
|
|
14952
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14953
|
+
*/
|
|
14954
|
+
categories: Categories;
|
|
14955
|
+
/**
|
|
14956
|
+
* Gets recipients on the **Cc** (carbon copy) line of a message.
|
|
14957
|
+
*
|
|
14958
|
+
* @remarks
|
|
14959
|
+
*
|
|
14960
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14961
|
+
*
|
|
14962
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14963
|
+
*
|
|
14964
|
+
* **Important**:
|
|
14965
|
+
*
|
|
14966
|
+
* - Only the `getAsync` method of the Recipients object is supported.
|
|
14967
|
+
*
|
|
14968
|
+
* - Depending on the Outlook client and platform, limits may apply on how many recipients you can get.
|
|
14969
|
+
* For more information, see the {@link Office.Recipients | Recipients} object.
|
|
14970
|
+
*/
|
|
14971
|
+
cc: Recipients;
|
|
14972
|
+
/**
|
|
14973
|
+
* Gets an identifier for the email conversation that contains a particular message.
|
|
14974
|
+
*
|
|
14975
|
+
* You can get an integer for this property if your mail app is activated in read forms or responses in compose forms.
|
|
14976
|
+
* If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change
|
|
14977
|
+
* and that value you obtained earlier will no longer apply.
|
|
14978
|
+
*
|
|
14979
|
+
* You get null for this property for a new item in a compose form.
|
|
14980
|
+
*
|
|
14981
|
+
* @remarks
|
|
14982
|
+
*
|
|
14983
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14984
|
+
*
|
|
14985
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14986
|
+
*/
|
|
14987
|
+
conversationId: string;
|
|
14988
|
+
/**
|
|
14989
|
+
* Gets the delayed delivery date and time of a message.
|
|
14990
|
+
*
|
|
14991
|
+
* @remarks
|
|
14992
|
+
* [Api set: Mailbox 1.13]
|
|
14993
|
+
*
|
|
14994
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14995
|
+
*
|
|
14996
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14997
|
+
*
|
|
14998
|
+
* **Important**: Only the `getAsync` method of the DelayDeliveryTime object is supported.
|
|
14999
|
+
*/
|
|
15000
|
+
delayDeliveryTime: DelayDeliveryTime;
|
|
15001
|
+
/**
|
|
15002
|
+
* Gets the email address of the sender of a message.
|
|
15003
|
+
*
|
|
15004
|
+
* @remarks
|
|
15005
|
+
* [Api set: Mailbox 1.7]
|
|
15006
|
+
*
|
|
15007
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15008
|
+
*
|
|
15009
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15010
|
+
*/
|
|
15011
|
+
from: From;
|
|
15012
|
+
/**
|
|
15013
|
+
* Gets the message ID of the original message being replied to by the current message.
|
|
15014
|
+
*
|
|
15015
|
+
* @remarks
|
|
15016
|
+
* [Api set: Mailbox 1.14]
|
|
15017
|
+
*
|
|
15018
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15019
|
+
*
|
|
15020
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15021
|
+
*
|
|
15022
|
+
* **Important**:
|
|
15023
|
+
*
|
|
15024
|
+
* - In Outlook on Windows, the `inReplyTo` value is maintained on all replies regardless of changes made by the user, such as changing the subject in a reply.
|
|
15025
|
+
*
|
|
15026
|
+
* - The `inReplyTo` property returns `null` for new messages and meeting invites being forwarded by a user who's also the meeting organizer.
|
|
15027
|
+
*/
|
|
15028
|
+
inReplyTo: string;
|
|
15029
|
+
/**
|
|
15030
|
+
* Gets the custom internet headers of a message.
|
|
15031
|
+
*
|
|
15032
|
+
* To learn more, see
|
|
15033
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
|
|
15034
|
+
*
|
|
15035
|
+
* @remarks
|
|
15036
|
+
* [Api set: Mailbox 1.8]
|
|
15037
|
+
*
|
|
15038
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15039
|
+
*
|
|
15040
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15041
|
+
*
|
|
15042
|
+
* **Important**: Only the `getAsync` method of the InternetHeaders object is supported.
|
|
15043
|
+
*/
|
|
15044
|
+
internetHeaders: InternetHeaders;
|
|
15045
|
+
/**
|
|
15046
|
+
* Gets the type of item that an instance represents.
|
|
15047
|
+
*
|
|
15048
|
+
* The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or
|
|
15049
|
+
* an appointment.
|
|
15050
|
+
*
|
|
15051
|
+
* @remarks
|
|
15052
|
+
*
|
|
15053
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15054
|
+
*
|
|
15055
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15056
|
+
*/
|
|
15057
|
+
itemType: MailboxEnums.ItemType | string;
|
|
15058
|
+
/**
|
|
15059
|
+
* Gets the notification messages of the item.
|
|
15060
|
+
*
|
|
15061
|
+
* @remarks
|
|
15062
|
+
* [Api set: Mailbox 1.3]
|
|
15063
|
+
*
|
|
15064
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15065
|
+
*
|
|
15066
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15067
|
+
*
|
|
15068
|
+
* **Important**:
|
|
15069
|
+
*
|
|
15070
|
+
* - Only the `getAllAsync` method of the NotificationMessages object is supported.
|
|
15071
|
+
*/
|
|
15072
|
+
notificationMessages: NotificationMessages;
|
|
15073
|
+
/**
|
|
15074
|
+
* Gets the sensitivity label of a message.
|
|
15075
|
+
*
|
|
15076
|
+
* @remarks
|
|
15077
|
+
* [Api set: Mailbox 1.13]
|
|
15078
|
+
*
|
|
15079
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15080
|
+
*
|
|
15081
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15082
|
+
*
|
|
15083
|
+
* **Important**:
|
|
15084
|
+
*
|
|
15085
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
15086
|
+
*
|
|
15087
|
+
* - Only the `getAsync` method of the SensitivityLabel object is supported.
|
|
15088
|
+
*
|
|
15089
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
15090
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
15091
|
+
*/
|
|
15092
|
+
sensitivityLabel: SensitivityLabel;
|
|
15093
|
+
/**
|
|
15094
|
+
* Gets the ID of the series that an instance belongs to.
|
|
15095
|
+
*
|
|
15096
|
+
* In Outlook on the web and on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic),
|
|
15097
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
15098
|
+
*
|
|
15099
|
+
* @remarks
|
|
15100
|
+
* [Api set: Mailbox 1.7]
|
|
15101
|
+
*
|
|
15102
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15103
|
+
*
|
|
15104
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15105
|
+
*
|
|
15106
|
+
* **Important**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
15107
|
+
* The `seriesId` property isn't identical to the Outlook IDs used by the Outlook REST API.
|
|
15108
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
15109
|
+
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
15110
|
+
*
|
|
15111
|
+
* The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
15112
|
+
* and returns `undefined` for any other items that aren't meeting requests.
|
|
15113
|
+
*/
|
|
15114
|
+
seriesId: string;
|
|
15115
|
+
/**
|
|
15116
|
+
* Gets the description that appears in the subject field of an item.
|
|
15117
|
+
*
|
|
15118
|
+
* The `subject` property gets the entire subject of the item, as sent by the email server.
|
|
15119
|
+
*
|
|
15120
|
+
* @remarks
|
|
15121
|
+
*
|
|
15122
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15123
|
+
*
|
|
15124
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15125
|
+
*
|
|
15126
|
+
* **Important**: Only the `getAsync` method of the Subject object is supported.
|
|
15127
|
+
*/
|
|
15128
|
+
subject: Subject;
|
|
15129
|
+
/**
|
|
15130
|
+
* Gets the recipients on the **To** line of a message.
|
|
15131
|
+
* Provides access to the recipients on the **To** line of a message. The type of object and level of access depend on the mode of the
|
|
15132
|
+
* current item.
|
|
15133
|
+
*
|
|
15134
|
+
* @remarks
|
|
15135
|
+
*
|
|
15136
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15137
|
+
*
|
|
15138
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15139
|
+
*
|
|
15140
|
+
* **Important**:
|
|
15141
|
+
*
|
|
15142
|
+
* - Only the `getAsync` method of the Recipients object is supported.
|
|
15143
|
+
*
|
|
15144
|
+
* - Depending on the Outlook client and platform, limits may apply on how many recipients you can get.
|
|
15145
|
+
* For more information, see the {@link Office.Recipients | Recipients} object.
|
|
15146
|
+
*/
|
|
15147
|
+
to: Recipients;
|
|
15148
|
+
/**
|
|
15149
|
+
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
15150
|
+
*
|
|
15151
|
+
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15152
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15153
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15154
|
+
* 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
|
|
15155
|
+
* then subsequently pops out the form to continue in a separate window.
|
|
15156
|
+
*
|
|
15157
|
+
* @remarks
|
|
15158
|
+
* [Api set: Mailbox 1.8]
|
|
15159
|
+
*
|
|
15160
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15161
|
+
*
|
|
15162
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15163
|
+
*
|
|
15164
|
+
* **Errors**:
|
|
15165
|
+
*
|
|
15166
|
+
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
15167
|
+
* or item attachment types other than email or calendar items (such as a contact or task item).
|
|
15168
|
+
*
|
|
15169
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
15170
|
+
*
|
|
15171
|
+
* @param attachmentId - The identifier of the attachment you want to get.
|
|
15172
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15173
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15174
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15175
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
15176
|
+
* an error code with the reason for the failure.
|
|
15177
|
+
*/
|
|
15178
|
+
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
|
|
15179
|
+
/**
|
|
15180
|
+
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
15181
|
+
*
|
|
15182
|
+
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15183
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15184
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15185
|
+
* 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
|
|
15186
|
+
* then subsequently pops out the form to continue in a separate window.
|
|
15187
|
+
*
|
|
15188
|
+
* @remarks
|
|
15189
|
+
* [Api set: Mailbox 1.8]
|
|
15190
|
+
*
|
|
15191
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15192
|
+
*
|
|
15193
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15194
|
+
*
|
|
15195
|
+
* **Errors**:
|
|
15196
|
+
*
|
|
15197
|
+
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
15198
|
+
* or item attachment types other than email or calendar items (such as a contact or task item).
|
|
15199
|
+
*
|
|
15200
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
15201
|
+
*
|
|
15202
|
+
* @param attachmentId - The identifier of the attachment you want to get.
|
|
15203
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15204
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
15205
|
+
* an error code with the reason for the failure.
|
|
15206
|
+
*/
|
|
15207
|
+
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
|
|
15208
|
+
/**
|
|
15209
|
+
* Gets the item's attachments as an array.
|
|
15210
|
+
*
|
|
15211
|
+
* @remarks
|
|
15212
|
+
* [Api set: Mailbox 1.8]
|
|
15213
|
+
*
|
|
15214
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15215
|
+
*
|
|
15216
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15217
|
+
*
|
|
15218
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15219
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15220
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15221
|
+
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
15222
|
+
* the failure.
|
|
15223
|
+
*/
|
|
15224
|
+
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
15225
|
+
/**
|
|
15226
|
+
* Gets the item's attachments as an array.
|
|
15227
|
+
*
|
|
15228
|
+
* @remarks
|
|
15229
|
+
* [Api set: Mailbox 1.8]
|
|
15230
|
+
*
|
|
15231
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15232
|
+
*
|
|
15233
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15234
|
+
*
|
|
15235
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15236
|
+
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
15237
|
+
* the failure.
|
|
15238
|
+
*/
|
|
15239
|
+
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
15240
|
+
/**
|
|
15241
|
+
* Specifies the type of message compose and its coercion type. The message can be new, or a reply or forward.
|
|
15242
|
+
* The coercion type can be HTML or plain text.
|
|
15243
|
+
*
|
|
15244
|
+
* @remarks
|
|
15245
|
+
* [Api set: Mailbox 1.10]
|
|
15246
|
+
*
|
|
15247
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15248
|
+
*
|
|
15249
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15250
|
+
*
|
|
15251
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15252
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15253
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15254
|
+
* type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
|
|
15255
|
+
* and coercion type.
|
|
15256
|
+
*
|
|
15257
|
+
* @returns
|
|
15258
|
+
* An object with `ComposeType` and `CoercionType` enum values for the message item.
|
|
15259
|
+
*/
|
|
15260
|
+
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
15261
|
+
/**
|
|
15262
|
+
* Specifies the type of message compose and its coercion type. The message can be new, or a reply or forward.
|
|
15263
|
+
* The coercion type can be HTML or plain text.
|
|
15264
|
+
*
|
|
15265
|
+
* @remarks
|
|
15266
|
+
* [Api set: Mailbox 1.10]
|
|
15267
|
+
*
|
|
15268
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15269
|
+
*
|
|
15270
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15271
|
+
*
|
|
15272
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15273
|
+
* type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
|
|
15274
|
+
* and coercion type.
|
|
15275
|
+
*
|
|
15276
|
+
* @returns
|
|
15277
|
+
* An object with `ComposeType` and `CoercionType` enum values for the message item.
|
|
15278
|
+
*/
|
|
15279
|
+
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
15280
|
+
/**
|
|
15281
|
+
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
15282
|
+
*
|
|
15283
|
+
* @remarks
|
|
15284
|
+
* [Api set: Mailbox 1.14]
|
|
15285
|
+
*
|
|
15286
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15287
|
+
*
|
|
15288
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15289
|
+
*
|
|
15290
|
+
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
15291
|
+
* to provide context for the current message being composed.
|
|
15292
|
+
*
|
|
15293
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15294
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15295
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15296
|
+
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
15297
|
+
* property.
|
|
15298
|
+
*/
|
|
15299
|
+
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15300
|
+
/**
|
|
15301
|
+
* Gets the Base64-encoded position of the current message in a conversation thread.
|
|
15302
|
+
*
|
|
15303
|
+
* @remarks
|
|
15304
|
+
* [Api set: Mailbox 1.14]
|
|
15305
|
+
*
|
|
15306
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15307
|
+
*
|
|
15308
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15309
|
+
*
|
|
15310
|
+
* **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
|
|
15311
|
+
* to provide context for the current message being composed.
|
|
15312
|
+
*
|
|
15313
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15314
|
+
* `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
|
|
15315
|
+
* property.
|
|
15316
|
+
*/
|
|
15317
|
+
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15318
|
+
/**
|
|
15319
|
+
* Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
|
|
15320
|
+
*
|
|
15321
|
+
* @remarks
|
|
15322
|
+
* [Api set: Mailbox 1.8]
|
|
15323
|
+
*
|
|
15324
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15325
|
+
*
|
|
15326
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15327
|
+
*
|
|
15328
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15329
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15330
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15331
|
+
* of type `Office.AsyncResult`.
|
|
15332
|
+
* On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
|
|
15333
|
+
* in the `asyncResult.value` property.
|
|
15334
|
+
*/
|
|
15335
|
+
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15336
|
+
/**
|
|
15337
|
+
* Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
|
|
15338
|
+
*
|
|
15339
|
+
* @remarks
|
|
15340
|
+
* [Api set: Mailbox 1.8]
|
|
15341
|
+
*
|
|
15342
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15343
|
+
*
|
|
15344
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15345
|
+
*
|
|
15346
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15347
|
+
* of type `Office.AsyncResult`.
|
|
15348
|
+
* On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
|
|
15349
|
+
* in the `asyncResult.value` property.
|
|
15350
|
+
*/
|
|
15351
|
+
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15352
|
+
/**
|
|
15353
|
+
* Gets the Exchange Web Services item class of the selected message.
|
|
15354
|
+
*
|
|
15355
|
+
* @remarks
|
|
15356
|
+
* [Api set: Mailbox 1.14]
|
|
15357
|
+
*
|
|
15358
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15359
|
+
*
|
|
15360
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15361
|
+
*
|
|
15362
|
+
* **Important**:
|
|
15363
|
+
*
|
|
15364
|
+
* The following table lists the default message classes.
|
|
15365
|
+
*
|
|
15366
|
+
* <table>
|
|
15367
|
+
* <tr>
|
|
15368
|
+
* <th>Item class</th>
|
|
15369
|
+
* <th>Description</th>
|
|
15370
|
+
* </tr>
|
|
15371
|
+
* <tr>
|
|
15372
|
+
* <td>IPM.Note</td>
|
|
15373
|
+
* <td>New messages and message replies</td>
|
|
15374
|
+
* </tr>
|
|
15375
|
+
* <tr>
|
|
15376
|
+
* <td>IPM.Note.SMIME</td>
|
|
15377
|
+
* <td>Encrypted messages that can also be signed</td>
|
|
15378
|
+
* </tr>
|
|
15379
|
+
* <tr>
|
|
15380
|
+
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
15381
|
+
* <td>Clear-signed messages</td>
|
|
15382
|
+
* </tr>
|
|
15383
|
+
* <tr>
|
|
15384
|
+
* <td>IPM.Schedule.Meeting.Request</td>
|
|
15385
|
+
* <td>Meeting requests</td>
|
|
15386
|
+
* </tr>
|
|
15387
|
+
* <tr>
|
|
15388
|
+
* <td>IPM.Schedule.Meeting.Canceled</td>
|
|
15389
|
+
* <td>Meeting cancellations</td>
|
|
15390
|
+
* </tr>
|
|
15391
|
+
* <tr>
|
|
15392
|
+
* <td>IPM.Schedule.Meeting.Resp.Neg</td>
|
|
15393
|
+
* <td>Responses to decline meeting requests</td>
|
|
15394
|
+
* </tr>
|
|
15395
|
+
* <tr>
|
|
15396
|
+
* <td>IPM.Schedule.Meeting.Resp.Pos</td>
|
|
15397
|
+
* <td>Responses to accept meeting requests</td>
|
|
15398
|
+
* </tr>
|
|
15399
|
+
* <tr>
|
|
15400
|
+
* <td>IPM.Schedule.Meeting.Resp.Tent</td>
|
|
15401
|
+
* <td>Responses to tentatively accept meeting requests</td>
|
|
15402
|
+
* </tr>
|
|
15403
|
+
* </table>
|
|
15404
|
+
*
|
|
15405
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15406
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15407
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15408
|
+
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
15409
|
+
*/
|
|
15410
|
+
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15411
|
+
/**
|
|
15412
|
+
* Gets the Exchange Web Services item class of the selected message.
|
|
15413
|
+
*
|
|
15414
|
+
* @remarks
|
|
15415
|
+
* [Api set: Mailbox 1.14]
|
|
15416
|
+
*
|
|
15417
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15418
|
+
*
|
|
15419
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15420
|
+
*
|
|
15421
|
+
* **Important**:
|
|
15422
|
+
*
|
|
15423
|
+
* The following table lists the default message classes.
|
|
15424
|
+
*
|
|
15425
|
+
* <table>
|
|
15426
|
+
* <tr>
|
|
15427
|
+
* <th>Item class</th>
|
|
15428
|
+
* <th>Description</th>
|
|
15429
|
+
* </tr>
|
|
15430
|
+
* <tr>
|
|
15431
|
+
* <td>IPM.Note</td>
|
|
15432
|
+
* <td>New messages and message replies</td>
|
|
15433
|
+
* </tr>
|
|
15434
|
+
* <tr>
|
|
15435
|
+
* <td>IPM.Note.SMIME</td>
|
|
15436
|
+
* <td>Encrypted messages that can also be signed</td>
|
|
15437
|
+
* </tr>
|
|
15438
|
+
* <tr>
|
|
15439
|
+
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
15440
|
+
* <td>Clear-signed messages</td>
|
|
15441
|
+
* </tr>
|
|
15442
|
+
* <tr>
|
|
15443
|
+
* <td>IPM.Schedule.Meeting.Request</td>
|
|
15444
|
+
* <td>Meeting requests</td>
|
|
15445
|
+
* </tr>
|
|
15446
|
+
* <tr>
|
|
15447
|
+
* <td>IPM.Schedule.Meeting.Canceled</td>
|
|
15448
|
+
* <td>Meeting cancellations</td>
|
|
15449
|
+
* </tr>
|
|
15450
|
+
* <tr>
|
|
15451
|
+
* <td>IPM.Schedule.Meeting.Resp.Neg</td>
|
|
15452
|
+
* <td>Responses to decline meeting requests</td>
|
|
15453
|
+
* </tr>
|
|
15454
|
+
* <tr>
|
|
15455
|
+
* <td>IPM.Schedule.Meeting.Resp.Pos</td>
|
|
15456
|
+
* <td>Responses to accept meeting requests</td>
|
|
15457
|
+
* </tr>
|
|
15458
|
+
* <tr>
|
|
15459
|
+
* <td>IPM.Schedule.Meeting.Resp.Tent</td>
|
|
15460
|
+
* <td>Responses to tentatively accept meeting requests</td>
|
|
15461
|
+
* </tr>
|
|
15462
|
+
* </table>
|
|
15463
|
+
*
|
|
15464
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15465
|
+
* `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
|
|
15466
|
+
*/
|
|
15467
|
+
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15468
|
+
/**
|
|
15469
|
+
* Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}
|
|
15470
|
+
* of a saved item.
|
|
15471
|
+
*
|
|
15472
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
15473
|
+
*
|
|
15474
|
+
* @remarks
|
|
15475
|
+
* [Api set: Mailbox 1.8]
|
|
15476
|
+
*
|
|
15477
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15478
|
+
*
|
|
15479
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15480
|
+
*
|
|
15481
|
+
* **Important**:
|
|
15482
|
+
*
|
|
15483
|
+
* - The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API.
|
|
15484
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
15485
|
+
*
|
|
15486
|
+
* - If your add-in calls `getItemIdAsync` on an item in compose mode (for example, to get an `itemId` to use with EWS or the REST API),
|
|
15487
|
+
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
15488
|
+
* Until the item is synced, the `itemId` isn't recognized and using it returns an error.
|
|
15489
|
+
*
|
|
15490
|
+
* **Errors**:
|
|
15491
|
+
*
|
|
15492
|
+
* - `ItemNotSaved`: The ID can't be retrieved until the item is saved.
|
|
15493
|
+
*
|
|
15494
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15495
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15496
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15497
|
+
* of type `Office.AsyncResult`. The EWS item ID of the item is returned in the `asyncResult.value` property.
|
|
15498
|
+
*/
|
|
15499
|
+
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15500
|
+
/**
|
|
15501
|
+
* Asynchronously gets the ID of a saved item.
|
|
15502
|
+
*
|
|
15503
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
15504
|
+
*
|
|
15505
|
+
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (for example, to get an `itemId` to use with EWS or the REST API),
|
|
15506
|
+
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
15507
|
+
* Until the item is synced, the `itemId` isn't recognized and using it returns an error.
|
|
15508
|
+
*
|
|
15509
|
+
* @remarks
|
|
15510
|
+
* [Api set: Mailbox 1.8]
|
|
15511
|
+
*
|
|
15512
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15513
|
+
*
|
|
15514
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15515
|
+
*
|
|
15516
|
+
* **Errors**:
|
|
15517
|
+
*
|
|
15518
|
+
* - `ItemNotSaved`: The ID can't be retrieved until the item is saved.
|
|
15519
|
+
*
|
|
15520
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15521
|
+
* of type `Office.AsyncResult`.
|
|
15522
|
+
*/
|
|
15523
|
+
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15524
|
+
/**
|
|
15525
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15526
|
+
*
|
|
15527
|
+
* For more information around using this API, see
|
|
15528
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
15529
|
+
*
|
|
15530
|
+
* @remarks
|
|
15531
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15532
|
+
*
|
|
15533
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15534
|
+
*
|
|
15535
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15536
|
+
*
|
|
15537
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
15538
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic) unless the following conditions are met.
|
|
15539
|
+
*
|
|
15540
|
+
* a. **Delegate access/Shared folders**
|
|
15541
|
+
*
|
|
15542
|
+
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15543
|
+
*
|
|
15544
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15545
|
+
*
|
|
15546
|
+
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15547
|
+
*
|
|
15548
|
+
* b. **Shared mailbox (applies to classic Outlook on Windows only)**
|
|
15549
|
+
*
|
|
15550
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15551
|
+
*
|
|
15552
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15553
|
+
*
|
|
15554
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15555
|
+
*
|
|
15556
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15557
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15558
|
+
*
|
|
15559
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15560
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15561
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15562
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15563
|
+
*/
|
|
15564
|
+
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15565
|
+
/**
|
|
15566
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15567
|
+
*
|
|
15568
|
+
* For more information around using this API, see
|
|
15569
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
15570
|
+
*
|
|
15571
|
+
* @remarks
|
|
15572
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15573
|
+
*
|
|
15574
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15575
|
+
*
|
|
15576
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15577
|
+
*
|
|
15578
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows
|
|
15579
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic) unless the following conditions are met.
|
|
15580
|
+
*
|
|
15581
|
+
* a. **Delegate access/Shared folders**
|
|
15582
|
+
*
|
|
15583
|
+
* 1. The mailbox owner starts a message. This can be a new message, a reply, or a forward.
|
|
15584
|
+
*
|
|
15585
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder shared with the delegate.
|
|
15586
|
+
*
|
|
15587
|
+
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
15588
|
+
*
|
|
15589
|
+
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
15590
|
+
*
|
|
15591
|
+
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
15592
|
+
*
|
|
15593
|
+
* 2. They save the message then move it from their own **Drafts** folder to a folder in the shared mailbox.
|
|
15594
|
+
*
|
|
15595
|
+
* 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
|
|
15596
|
+
*
|
|
15597
|
+
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
15598
|
+
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
15599
|
+
*
|
|
15600
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15601
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
15602
|
+
*/
|
|
15603
|
+
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
15604
|
+
/**
|
|
15605
|
+
* Gets if the client signature is enabled.
|
|
15606
|
+
*
|
|
15607
|
+
* In Outlook on Windows (classic), the API call returns `true` if the default signature for new messages, replies, or forwards is set
|
|
15608
|
+
* to a template for the sending Outlook account.
|
|
15609
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15610
|
+
* the API call returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
15611
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or are disabled in Outlook on the web or new Outlook on Windows,
|
|
15612
|
+
* the API call returns `false`.
|
|
15613
|
+
*
|
|
15614
|
+
* @remarks
|
|
15615
|
+
* [Api set: Mailbox 1.10]
|
|
15616
|
+
*
|
|
15617
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15618
|
+
*
|
|
15619
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15620
|
+
*
|
|
15621
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15622
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15623
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15624
|
+
* type `Office.AsyncResult`.
|
|
15625
|
+
*/
|
|
15626
|
+
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
15627
|
+
/**
|
|
15628
|
+
* Gets if the client signature is enabled.
|
|
15629
|
+
*
|
|
15630
|
+
* In Outlook on Windows (classic), the API call returns `true` if the default signature for new messages, replies, or forwards is set
|
|
15631
|
+
* to a template for the sending Outlook account.
|
|
15632
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15633
|
+
* the API call returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
15634
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or are disabled in Outlook on the web or new Outlook on Windows,
|
|
15635
|
+
* the API call returns `false`.
|
|
15636
|
+
*
|
|
15637
|
+
* @remarks
|
|
15638
|
+
* [Api set: Mailbox 1.10]
|
|
15639
|
+
*
|
|
15640
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15641
|
+
*
|
|
15642
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15643
|
+
*
|
|
15644
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15645
|
+
* type `Office.AsyncResult`.
|
|
15646
|
+
*/
|
|
15647
|
+
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
15648
|
+
/**
|
|
15649
|
+
* Asynchronously loads custom properties for this add-in on the selected item.
|
|
15650
|
+
*
|
|
15651
|
+
* Custom properties are stored as key-value pairs on a per-app, per-item basis.
|
|
15652
|
+
* This method returns a {@link Office.CustomProperties | CustomProperties} object in the callback, which provides methods to access the custom properties specific to the
|
|
15653
|
+
* current item and the current add-in. Custom properties aren't encrypted on the item, so this shouldn't be used as secure storage.
|
|
15654
|
+
*
|
|
15655
|
+
* The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property.
|
|
15656
|
+
* This object can be used to get custom properties from the mail item.
|
|
15657
|
+
*
|
|
15658
|
+
* @remarks
|
|
15659
|
+
* [Api set: Mailbox 1.1]
|
|
15660
|
+
*
|
|
15661
|
+
* To learn more about custom properties, see
|
|
15662
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/metadata-for-an-outlook-add-in | Get and set add-in metadata for an Outlook add-in}.
|
|
15663
|
+
*
|
|
15664
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15665
|
+
*
|
|
15666
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15667
|
+
*
|
|
15668
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15669
|
+
* type `Office.AsyncResult`.
|
|
15670
|
+
* @param userContext - Optional. Developers can provide any object they wish to access in the callback function.
|
|
15671
|
+
* This object can be accessed by the `asyncResult.asyncContext` property in the callback function.
|
|
15672
|
+
*/
|
|
15673
|
+
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
|
|
15674
|
+
/**
|
|
15675
|
+
* Asynchronously saves the current message as a draft.
|
|
15676
|
+
*
|
|
15677
|
+
* @remarks
|
|
15678
|
+
* [Api set: Mailbox 1.3]
|
|
15679
|
+
*
|
|
15680
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15681
|
+
*
|
|
15682
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15683
|
+
*
|
|
15684
|
+
* **Important**:
|
|
15685
|
+
*
|
|
15686
|
+
* - 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
|
|
15687
|
+
* 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.
|
|
15688
|
+
*
|
|
15689
|
+
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
15690
|
+
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
15691
|
+
*
|
|
15692
|
+
* - The identifier returned is the same as the
|
|
15693
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}.
|
|
15694
|
+
* The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API.
|
|
15695
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
15696
|
+
*
|
|
15697
|
+
* - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
|
|
15698
|
+
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
|
|
15699
|
+
* Until the item is synced, using the item ID will return an error.
|
|
15700
|
+
*
|
|
15701
|
+
* - 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
|
|
15702
|
+
* from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
|
|
15703
|
+
* in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
|
|
15704
|
+
* shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
|
|
15705
|
+
* there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
|
|
15706
|
+
*
|
|
15707
|
+
* **Errors**:
|
|
15708
|
+
*
|
|
15709
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
15710
|
+
*
|
|
15711
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
15712
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15713
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
15714
|
+
* which is an `Office.AsyncResult` object. The EWS message ID is returned in the `asyncResult.value` property.
|
|
15715
|
+
*/
|
|
15716
|
+
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15717
|
+
/**
|
|
15718
|
+
* Asynchronously saves the current message as a draft.
|
|
15719
|
+
*
|
|
15720
|
+
* @remarks
|
|
15721
|
+
* [Api set: Mailbox 1.3]
|
|
15722
|
+
*
|
|
15723
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15724
|
+
*
|
|
15725
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15726
|
+
*
|
|
15727
|
+
* **Important**:
|
|
15728
|
+
*
|
|
15729
|
+
* - 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
|
|
15730
|
+
* 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.
|
|
15731
|
+
*
|
|
15732
|
+
* - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
|
|
15733
|
+
* subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
|
|
15734
|
+
*
|
|
15735
|
+
* - The identifier returned is the same as the
|
|
15736
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}.
|
|
15737
|
+
* The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API.
|
|
15738
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
15739
|
+
*
|
|
15740
|
+
* - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
|
|
15741
|
+
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
|
|
15742
|
+
* Until the item is synced, using the item ID will return an error.
|
|
15743
|
+
*
|
|
15744
|
+
* - 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
|
|
15745
|
+
* from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
|
|
15746
|
+
* in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
|
|
15747
|
+
* shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
|
|
15748
|
+
* there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
|
|
15749
|
+
*
|
|
15750
|
+
* **Errors**:
|
|
15751
|
+
*
|
|
15752
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
15753
|
+
*
|
|
15754
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
15755
|
+
* which is an `Office.AsyncResult` object. The EWS message ID is returned in the `asyncResult.value` property.
|
|
15756
|
+
*/
|
|
15757
|
+
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
15758
|
+
/**
|
|
15759
|
+
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
15760
|
+
*
|
|
15761
|
+
* @remarks
|
|
15762
|
+
* [Api set: Mailbox preview]
|
|
15763
|
+
*
|
|
15764
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15765
|
+
*
|
|
15766
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15767
|
+
*
|
|
15768
|
+
* **Important**:
|
|
15769
|
+
*
|
|
15770
|
+
* - To learn more about processing multiple selected messages, see
|
|
15771
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
15772
|
+
*
|
|
15773
|
+
* - When a selected mail item is loaded using `loadItemByIdAsync`, you must call `unloadAsync` after processing on it. This must be done before
|
|
15774
|
+
* calling `loadItemByIdAsync` on another selected item.
|
|
15775
|
+
*
|
|
15776
|
+
* @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.
|
|
15777
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
15778
|
+
* which is an `Office.AsyncResult` object.
|
|
15779
|
+
*
|
|
15780
|
+
* @beta
|
|
15781
|
+
*/
|
|
15782
|
+
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
15783
|
+
/**
|
|
15784
|
+
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
15785
|
+
*
|
|
15786
|
+
* @remarks
|
|
15787
|
+
* [Api set: Mailbox preview]
|
|
15788
|
+
*
|
|
15789
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15790
|
+
*
|
|
15791
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15792
|
+
*
|
|
15793
|
+
* **Important**:
|
|
15794
|
+
*
|
|
15795
|
+
* - To learn more about processing multiple selected messages, see
|
|
15796
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
15797
|
+
*
|
|
15798
|
+
* - When a selected mail item is loaded using `loadItemByIdAsync`, you must call `unloadAsync` after processing on it. This must be done before
|
|
15799
|
+
* calling `loadItemByIdAsync` on another selected item.
|
|
15800
|
+
*
|
|
15801
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
15802
|
+
* which is an `Office.AsyncResult` object.
|
|
15803
|
+
*
|
|
15804
|
+
* @beta
|
|
15805
|
+
*/
|
|
15806
|
+
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
15807
|
+
}
|
|
15808
|
+
/**
|
|
15809
|
+
* Represents a message in read mode that's currently loaded.
|
|
15810
|
+
* A `LoadedMessageRead` object is returned when `Office.context.mailbox.loadItemByIdAsync` is called on a message in read mode.
|
|
15811
|
+
*
|
|
15812
|
+
* @remarks
|
|
15813
|
+
* [Api set: Mailbox preview]
|
|
15814
|
+
*
|
|
15815
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15816
|
+
*
|
|
15817
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15818
|
+
*
|
|
15819
|
+
* **Important**:
|
|
15820
|
+
*
|
|
15821
|
+
* - When implementing the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select feature},
|
|
15822
|
+
* determine if you can already access the required properties of the selected item through the
|
|
15823
|
+
* `Office.context.mailbox.getSelectedItemsAsync` call. If you can, you don't need to call `loadItemByIdAsync`.
|
|
15824
|
+
*
|
|
15825
|
+
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
15826
|
+
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
15827
|
+
*
|
|
15828
|
+
* @beta
|
|
15829
|
+
*/
|
|
15830
|
+
interface LoadedMessageRead {
|
|
15831
|
+
/**
|
|
15832
|
+
* Gets the item's attachments as an array.
|
|
15833
|
+
*
|
|
15834
|
+
* @remarks
|
|
15835
|
+
*
|
|
15836
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15837
|
+
*
|
|
15838
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15839
|
+
*
|
|
15840
|
+
* **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
|
|
15841
|
+
* For more information, see
|
|
15842
|
+
* {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
|
|
15843
|
+
*
|
|
15844
|
+
*/
|
|
15845
|
+
attachments: AttachmentDetails[];
|
|
15846
|
+
/**
|
|
15847
|
+
* Gets the item's body and its format.
|
|
15848
|
+
*
|
|
15849
|
+
* @remarks
|
|
15850
|
+
* [Api set: Mailbox 1.1]
|
|
15851
|
+
*
|
|
15852
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15853
|
+
*
|
|
15854
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15855
|
+
*
|
|
15856
|
+
* **Important**: Only the `getAsync` and `getTypeAsync` methods of the Body object are supported.
|
|
15857
|
+
*/
|
|
15858
|
+
body: Body;
|
|
15859
|
+
/**
|
|
15860
|
+
* Gets an object that provides methods to manage the item's categories.
|
|
15861
|
+
*
|
|
15862
|
+
* @remarks
|
|
15863
|
+
* [Api set: Mailbox 1.8]
|
|
15864
|
+
*
|
|
15865
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15866
|
+
*
|
|
15867
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15868
|
+
*/
|
|
15869
|
+
categories: Categories;
|
|
15870
|
+
/**
|
|
15871
|
+
* Gets recipients on the **Cc** (carbon copy) line of a message.
|
|
15872
|
+
*
|
|
15873
|
+
* The `cc` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
15874
|
+
* each recipient listed on the **Cc** line of the message. The maximum number of recipients returned varies per Outlook client.
|
|
15875
|
+
*
|
|
15876
|
+
* - classic Windows: 500 recipients
|
|
15877
|
+
*
|
|
15878
|
+
* - Web browser, new Outlook: 20 recipients (collapsed view), 500 recipients (expanded view)
|
|
15879
|
+
*
|
|
15880
|
+
* @remarks
|
|
15881
|
+
*
|
|
15882
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15883
|
+
*
|
|
15884
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15885
|
+
*/
|
|
15886
|
+
cc: EmailAddressDetails[];
|
|
15887
|
+
/**
|
|
15888
|
+
* Gets an identifier for the email conversation that contains a particular message.
|
|
15889
|
+
*
|
|
15890
|
+
* You can get an integer for this property if your mail app is activated in read forms or responses in compose forms.
|
|
15891
|
+
* If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change
|
|
15892
|
+
* and that value you obtained earlier will no longer apply.
|
|
15893
|
+
*
|
|
15894
|
+
* @remarks
|
|
15895
|
+
*
|
|
15896
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15897
|
+
*
|
|
15898
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15899
|
+
*/
|
|
15900
|
+
conversationId: string;
|
|
15901
|
+
/**
|
|
15902
|
+
* Gets the date and time that an item was created.
|
|
15903
|
+
*
|
|
15904
|
+
* @remarks
|
|
15905
|
+
*
|
|
15906
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15907
|
+
*
|
|
15908
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15909
|
+
*/
|
|
15910
|
+
dateTimeCreated: Date;
|
|
15911
|
+
/**
|
|
15912
|
+
* Gets the date and time that an item was last modified.
|
|
15913
|
+
*
|
|
15914
|
+
* @remarks
|
|
15915
|
+
* [Api set: Mailbox 1.1]
|
|
15916
|
+
*
|
|
15917
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15918
|
+
*
|
|
15919
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
15920
|
+
*
|
|
15921
|
+
* **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
15922
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15923
|
+
*/
|
|
15924
|
+
dateTimeModified: Date;
|
|
15925
|
+
/**
|
|
15926
|
+
* Gets the date and time that the appointment is to end.
|
|
15927
|
+
*
|
|
15928
|
+
* The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value.
|
|
15929
|
+
* You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time.
|
|
15930
|
+
*
|
|
15931
|
+
* When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on
|
|
15932
|
+
* the client to UTC for the server.
|
|
15933
|
+
*
|
|
15934
|
+
* @remarks
|
|
15935
|
+
*
|
|
15936
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15937
|
+
*
|
|
15938
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15939
|
+
*/
|
|
15940
|
+
end: Date;
|
|
15941
|
+
/**
|
|
15942
|
+
* Gets the email address of the sender of a message.
|
|
15943
|
+
*
|
|
15944
|
+
* The `from` property returns an `EmailAddressDetails` object.
|
|
15945
|
+
*
|
|
15946
|
+
* @remarks
|
|
15947
|
+
*
|
|
15948
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15949
|
+
*
|
|
15950
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15951
|
+
*
|
|
15952
|
+
* **Important**:
|
|
15953
|
+
*
|
|
15954
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
15955
|
+
* In that case, the `from` property represents the delegator, and the `sender` property represents the delegate.
|
|
15956
|
+
*
|
|
15957
|
+
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
15958
|
+
*/
|
|
15959
|
+
from: EmailAddressDetails;
|
|
15960
|
+
/**
|
|
15961
|
+
* Gets the internet message identifier of a message.
|
|
15962
|
+
*
|
|
15963
|
+
* @remarks
|
|
15964
|
+
*
|
|
15965
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15966
|
+
*
|
|
15967
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15968
|
+
*
|
|
15969
|
+
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
15970
|
+
* consider using {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get this
|
|
15971
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | property from the server}.
|
|
15972
|
+
*/
|
|
15973
|
+
internetMessageId: string;
|
|
15974
|
+
/**
|
|
15975
|
+
* Gets the Exchange Web Services item class of the selected message.
|
|
15976
|
+
*
|
|
15977
|
+
* @remarks
|
|
15978
|
+
*
|
|
15979
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15980
|
+
*
|
|
15981
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15982
|
+
*
|
|
15983
|
+
* **Important**:
|
|
15984
|
+
*
|
|
15985
|
+
* The following table lists the default item classes for messages.
|
|
15986
|
+
*
|
|
15987
|
+
* <table>
|
|
15988
|
+
* <tr>
|
|
15989
|
+
* <th>Item class</th>
|
|
15990
|
+
* <th>Description</th>
|
|
15991
|
+
* </tr>
|
|
15992
|
+
* <tr>
|
|
15993
|
+
* <td>IPM.Note</td>
|
|
15994
|
+
* <td>New messages and message replies</td>
|
|
15995
|
+
* </tr>
|
|
15996
|
+
* <tr>
|
|
15997
|
+
* <td>IPM.Note.SMIME</td>
|
|
15998
|
+
* <td>Encrypted messages that can also be signed</td>
|
|
15999
|
+
* </tr>
|
|
16000
|
+
* <tr>
|
|
16001
|
+
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
16002
|
+
* <td>Clear-signed messages</td>
|
|
16003
|
+
* </tr>
|
|
16004
|
+
* <tr>
|
|
16005
|
+
* <td>IPM.Schedule.Meeting.Request</td>
|
|
16006
|
+
* <td>Meeting requests</td>
|
|
16007
|
+
* </tr>
|
|
16008
|
+
* <tr>
|
|
16009
|
+
* <td>IPM.Schedule.Meeting.Canceled</td>
|
|
16010
|
+
* <td>Meeting cancellations</td>
|
|
16011
|
+
* </tr>
|
|
16012
|
+
* <tr>
|
|
16013
|
+
* <td>IPM.Schedule.Meeting.Resp.Neg</td>
|
|
16014
|
+
* <td>Responses to decline meeting requests</td>
|
|
16015
|
+
* </tr>
|
|
16016
|
+
* <tr>
|
|
16017
|
+
* <td>IPM.Schedule.Meeting.Resp.Pos</td>
|
|
16018
|
+
* <td>Responses to accept meeting requests</td>
|
|
16019
|
+
* </tr>
|
|
16020
|
+
* <tr>
|
|
16021
|
+
* <td>IPM.Schedule.Meeting.Resp.Tent</td>
|
|
16022
|
+
* <td>Responses to tentatively accept meeting requests</td>
|
|
16023
|
+
* </tr>
|
|
16024
|
+
* </table>
|
|
16025
|
+
*
|
|
16026
|
+
* You can create custom classes that extend a default item class. For example, `IPM.Note.Contoso`.
|
|
16027
|
+
*/
|
|
16028
|
+
itemClass: string;
|
|
16029
|
+
/**
|
|
16030
|
+
* Gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
|
16031
|
+
* for the current item.
|
|
16032
|
+
*
|
|
16033
|
+
* @remarks
|
|
16034
|
+
*
|
|
16035
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16036
|
+
*
|
|
16037
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16038
|
+
*
|
|
16039
|
+
* **Important**:
|
|
16040
|
+
*
|
|
16041
|
+
* - The `itemId` property isn't available in compose mode.
|
|
16042
|
+
* If an item identifier is required, the `Office.context.mailbox.item.saveAsync` method can be used to save the item to the store, which will return the item identifier
|
|
16043
|
+
* in the `asyncResult.value` parameter in the callback function. If the item is already saved, you can call the `Office.context.mailbox.item.getItemIdAsync` method instead.
|
|
16044
|
+
*
|
|
16045
|
+
* - The identifier returned by the `itemId` property is the same as the
|
|
16046
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}.
|
|
16047
|
+
* The `itemId` property isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API.
|
|
16048
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
16049
|
+
*/
|
|
16050
|
+
itemId: string;
|
|
16051
|
+
/**
|
|
16052
|
+
* Gets the type of item that an instance represents.
|
|
16053
|
+
*
|
|
16054
|
+
* The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or
|
|
16055
|
+
* an appointment.
|
|
16056
|
+
*
|
|
16057
|
+
* @remarks
|
|
16058
|
+
*
|
|
16059
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16060
|
+
*
|
|
16061
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16062
|
+
*/
|
|
16063
|
+
itemType: MailboxEnums.ItemType | string;
|
|
16064
|
+
/**
|
|
16065
|
+
* Gets the location of a meeting request.
|
|
16066
|
+
*
|
|
16067
|
+
* The `location` property returns a string that contains the location of the appointment.
|
|
16068
|
+
*
|
|
16069
|
+
* @remarks
|
|
16070
|
+
*
|
|
16071
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16072
|
+
*
|
|
16073
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16074
|
+
*/
|
|
16075
|
+
location: string;
|
|
16076
|
+
/**
|
|
16077
|
+
* Gets the subject of an item, with all prefixes removed (including RE: and FWD:).
|
|
16078
|
+
*
|
|
16079
|
+
* The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by
|
|
16080
|
+
* email programs. To get the subject of the item with the prefixes intact, use the `subject` property.
|
|
16081
|
+
*
|
|
16082
|
+
* @remarks
|
|
16083
|
+
*
|
|
16084
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16085
|
+
*
|
|
16086
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16087
|
+
*/
|
|
16088
|
+
normalizedSubject: string;
|
|
16089
|
+
/**
|
|
16090
|
+
* Gets the notification messages of the item.
|
|
16091
|
+
*
|
|
16092
|
+
* @remarks
|
|
16093
|
+
* [Api set: Mailbox 1.3]
|
|
16094
|
+
*
|
|
16095
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16096
|
+
*
|
|
16097
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16098
|
+
*
|
|
16099
|
+
* **Important**:
|
|
16100
|
+
*
|
|
16101
|
+
* - Only the `getAllAsync` method of the NotificationMessages object is supported.
|
|
16102
|
+
*/
|
|
16103
|
+
notificationMessages: NotificationMessages;
|
|
16104
|
+
/**
|
|
16105
|
+
* Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request.
|
|
16106
|
+
* Read and compose modes for appointment items. Read mode for meeting request items.
|
|
16107
|
+
*
|
|
16108
|
+
* The `recurrence` property returns a `Recurrence` object for recurring appointments or meetings requests if an item is a series or an instance
|
|
16109
|
+
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
|
|
16110
|
+
* `undefined` is returned for messages that aren't meeting requests.
|
|
16111
|
+
*
|
|
16112
|
+
* @remarks
|
|
16113
|
+
* [Api set: Mailbox 1.7]
|
|
16114
|
+
*
|
|
16115
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16116
|
+
*
|
|
16117
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16118
|
+
*
|
|
16119
|
+
* **Important**:
|
|
16120
|
+
*
|
|
16121
|
+
* - Meeting requests have an itemClass value of `IPM.Schedule.Meeting.Request`.
|
|
16122
|
+
*
|
|
16123
|
+
* - If the `recurrence` object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
|
|
16124
|
+
* and *not* a part of a series.
|
|
16125
|
+
*
|
|
16126
|
+
* - Only the propeties and the `getAsync` method of the Recurrence object are supported.
|
|
16127
|
+
*/
|
|
16128
|
+
recurrence: Recurrence;
|
|
16129
|
+
/**
|
|
16130
|
+
* Gets the ID of the series that an instance belongs to.
|
|
16131
|
+
*
|
|
16132
|
+
* In Outlook on the web and on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic),
|
|
16133
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
16134
|
+
*
|
|
16135
|
+
* @remarks
|
|
16136
|
+
* [Api set: Mailbox 1.7]
|
|
16137
|
+
*
|
|
16138
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16139
|
+
*
|
|
16140
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16141
|
+
*
|
|
16142
|
+
* **Important**:
|
|
16143
|
+
*
|
|
16144
|
+
* - The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
16145
|
+
* The `seriesId` property isn't identical to the Outlook IDs used by the Outlook REST API.
|
|
16146
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
16147
|
+
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
16148
|
+
*
|
|
16149
|
+
* - The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
16150
|
+
* and returns `undefined` for any other items that aren't meeting requests.
|
|
16151
|
+
*/
|
|
16152
|
+
seriesId: string;
|
|
16153
|
+
/**
|
|
16154
|
+
* Gets the email address of the sender of an email message.
|
|
16155
|
+
*
|
|
16156
|
+
* @remarks
|
|
16157
|
+
*
|
|
16158
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16159
|
+
*
|
|
16160
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16161
|
+
*
|
|
16162
|
+
* **Important**:
|
|
16163
|
+
*
|
|
16164
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
16165
|
+
* In that case, the `from` property represents the delegator, and the `sender` property represents the delegate.
|
|
16166
|
+
*
|
|
16167
|
+
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
16168
|
+
*/
|
|
16169
|
+
sender: EmailAddressDetails;
|
|
16170
|
+
/**
|
|
16171
|
+
* Gets the date and time that the appointment is to begin.
|
|
16172
|
+
*
|
|
16173
|
+
* The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value.
|
|
16174
|
+
* You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time.
|
|
16175
|
+
*
|
|
16176
|
+
* @remarks
|
|
16177
|
+
*
|
|
16178
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16179
|
+
*
|
|
16180
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16181
|
+
*/
|
|
16182
|
+
start: Date;
|
|
16183
|
+
/**
|
|
16184
|
+
* Gets the description that appears in the subject field of an item.
|
|
16185
|
+
*
|
|
16186
|
+
* The `subject` property gets the entire subject of the item, as sent by the email server.
|
|
16187
|
+
*
|
|
16188
|
+
* The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:.
|
|
16189
|
+
*
|
|
16190
|
+
* @remarks
|
|
16191
|
+
*
|
|
16192
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16193
|
+
*
|
|
16194
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16195
|
+
*/
|
|
16196
|
+
subject: string;
|
|
16197
|
+
/**
|
|
16198
|
+
* Gets the recipients on the **To** line of a message.
|
|
16199
|
+
* Provides access to the recipients on the **To** line of a message. The type of object and level of access depend on the mode of the
|
|
16200
|
+
* current item.
|
|
16201
|
+
*
|
|
16202
|
+
* The `to` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
16203
|
+
* each recipient listed on the **To** line of the message. The maximum number of recipients returned varies per Outlook client.
|
|
16204
|
+
*
|
|
16205
|
+
* - classic Windows: 500 recipients
|
|
16206
|
+
*
|
|
16207
|
+
* - Web browser, new Outlook: 20 recipients (collapsed view), 500 recipients (expanded view)
|
|
16208
|
+
*
|
|
16209
|
+
* @remarks
|
|
16210
|
+
*
|
|
16211
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16212
|
+
*
|
|
16213
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16214
|
+
*/
|
|
16215
|
+
to: EmailAddressDetails[];
|
|
16216
|
+
/**
|
|
16217
|
+
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
16218
|
+
* selected appointment.
|
|
16219
|
+
*
|
|
16220
|
+
* @remarks
|
|
16221
|
+
* [Api set: Mailbox 1.9]
|
|
16222
|
+
*
|
|
16223
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16224
|
+
*
|
|
16225
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16226
|
+
*
|
|
16227
|
+
* **Important**:
|
|
16228
|
+
*
|
|
16229
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16230
|
+
* 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.
|
|
16231
|
+
*
|
|
16232
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
16233
|
+
*
|
|
16234
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16235
|
+
* 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.
|
|
16236
|
+
*
|
|
16237
|
+
* @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
|
|
16238
|
+
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16239
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16240
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16241
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16242
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16243
|
+
*/
|
|
16244
|
+
displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16245
|
+
/**
|
|
16246
|
+
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
16247
|
+
* selected appointment.
|
|
16248
|
+
*
|
|
16249
|
+
* @remarks
|
|
16250
|
+
* [Api set: Mailbox 1.9]
|
|
16251
|
+
*
|
|
16252
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16253
|
+
*
|
|
16254
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16255
|
+
*
|
|
16256
|
+
* **Important**:
|
|
16257
|
+
*
|
|
16258
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16259
|
+
* 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.
|
|
16260
|
+
*
|
|
16261
|
+
* - If any of the string parameters exceed their limits, `displayReplyAllFormAsync` throws an exception.
|
|
16262
|
+
*
|
|
16263
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16264
|
+
* 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.
|
|
16265
|
+
*
|
|
16266
|
+
* @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
|
|
16267
|
+
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16268
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16269
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16270
|
+
*/
|
|
16271
|
+
displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16272
|
+
/**
|
|
16273
|
+
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
16274
|
+
*
|
|
16275
|
+
* @remarks
|
|
16276
|
+
* [Api set: Mailbox 1.9]
|
|
16277
|
+
*
|
|
16278
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16279
|
+
*
|
|
16280
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16281
|
+
*
|
|
16282
|
+
* **Important**:
|
|
16283
|
+
*
|
|
16284
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16285
|
+
* 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.
|
|
16286
|
+
*
|
|
16287
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
16288
|
+
*
|
|
16289
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16290
|
+
* 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.
|
|
16291
|
+
*
|
|
16292
|
+
* @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
|
|
16293
|
+
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16294
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16295
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16296
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16297
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16298
|
+
*/
|
|
16299
|
+
displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16300
|
+
/**
|
|
16301
|
+
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
16302
|
+
*
|
|
16303
|
+
* @remarks
|
|
16304
|
+
* [Api set: Mailbox 1.9]
|
|
16305
|
+
*
|
|
16306
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16307
|
+
*
|
|
16308
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16309
|
+
*
|
|
16310
|
+
* **Important**:
|
|
16311
|
+
*
|
|
16312
|
+
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16313
|
+
* 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.
|
|
16314
|
+
*
|
|
16315
|
+
* - If any of the string parameters exceed their limits, `displayReplyFormAsync` throws an exception.
|
|
16316
|
+
*
|
|
16317
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16318
|
+
* 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.
|
|
16319
|
+
*
|
|
16320
|
+
* @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
|
|
16321
|
+
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16322
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16323
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16324
|
+
*/
|
|
16325
|
+
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
16326
|
+
/**
|
|
16327
|
+
* Gets all the internet headers for the message as a string.
|
|
16328
|
+
*
|
|
16329
|
+
* To learn more, see
|
|
16330
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
|
|
16331
|
+
*
|
|
16332
|
+
* @remarks
|
|
16333
|
+
* [Api set: Mailbox 1.8]
|
|
16334
|
+
*
|
|
16335
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16336
|
+
*
|
|
16337
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16338
|
+
*
|
|
16339
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16340
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16341
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16342
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16343
|
+
* On success, the internet headers data is provided in the `asyncResult.value` property as a string.
|
|
16344
|
+
* Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value.
|
|
16345
|
+
* If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
|
|
16346
|
+
*/
|
|
16347
|
+
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16348
|
+
/**
|
|
16349
|
+
* Gets all the internet headers for the message as a string.
|
|
16350
|
+
*
|
|
16351
|
+
* To learn more, see
|
|
16352
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
|
|
16353
|
+
*
|
|
16354
|
+
* @remarks
|
|
16355
|
+
* [Api set: Mailbox 1.8]
|
|
16356
|
+
*
|
|
16357
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16358
|
+
*
|
|
16359
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16360
|
+
*
|
|
16361
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16362
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16363
|
+
* On success, the internet headers data is provided in the `asyncResult.value` property as a string.
|
|
16364
|
+
* Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value.
|
|
16365
|
+
* If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
|
|
16366
|
+
*/
|
|
16367
|
+
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16368
|
+
/**
|
|
16369
|
+
* Gets the current message in EML format encoded in Base64.
|
|
16370
|
+
*
|
|
16371
|
+
* @remarks
|
|
16372
|
+
* [Api set: Mailbox 1.14]
|
|
16373
|
+
*
|
|
16374
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16375
|
+
*
|
|
16376
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16377
|
+
*
|
|
16378
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16379
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16380
|
+
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
16381
|
+
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
16382
|
+
* returned in the `asyncResult.error` property.
|
|
16383
|
+
*/
|
|
16384
|
+
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16385
|
+
/**
|
|
16386
|
+
* Gets the current message in EML format encoded in Base64.
|
|
16387
|
+
*
|
|
16388
|
+
* @remarks
|
|
16389
|
+
* [Api set: Mailbox 1.14]
|
|
16390
|
+
*
|
|
16391
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16392
|
+
*
|
|
16393
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16394
|
+
*
|
|
16395
|
+
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
|
|
16396
|
+
* `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
|
|
16397
|
+
* returned in the `asyncResult.error` property.
|
|
16398
|
+
*/
|
|
16399
|
+
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16400
|
+
/**
|
|
16401
|
+
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16402
|
+
*
|
|
16403
|
+
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16404
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16405
|
+
* to retrieve the attachment. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16406
|
+
* 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
|
|
16407
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
16408
|
+
*
|
|
16409
|
+
* @remarks
|
|
16410
|
+
* [Api set: Mailbox 1.8]
|
|
16411
|
+
*
|
|
16412
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16413
|
+
*
|
|
16414
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16415
|
+
*
|
|
16416
|
+
* **Errors**:
|
|
16417
|
+
*
|
|
16418
|
+
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
16419
|
+
* or item attachment types other than email or calendar items (such as a contact or task item).
|
|
16420
|
+
*
|
|
16421
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16422
|
+
*
|
|
16423
|
+
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16424
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16425
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16426
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16427
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
16428
|
+
* an error code with the reason for the failure.
|
|
16429
|
+
*/
|
|
16430
|
+
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
|
|
16431
|
+
/**
|
|
16432
|
+
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16433
|
+
*
|
|
16434
|
+
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16435
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16436
|
+
* to retrieve the attachment. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16437
|
+
* 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
|
|
16438
|
+
* inline form then subsequently pops out the form to continue in a separate window.
|
|
16439
|
+
*
|
|
16440
|
+
* @remarks
|
|
16441
|
+
* [Api set: Mailbox 1.8]
|
|
16442
|
+
*
|
|
16443
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16444
|
+
*
|
|
16445
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16446
|
+
*
|
|
16447
|
+
* **Errors**:
|
|
16448
|
+
*
|
|
16449
|
+
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
16450
|
+
* or item attachment types other than email or calendar items (such as a contact or task item).
|
|
16451
|
+
*
|
|
16452
|
+
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16453
|
+
*
|
|
16454
|
+
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16455
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16456
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
16457
|
+
* an error code with the reason for the failure.
|
|
16458
|
+
*/
|
|
16459
|
+
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
|
|
16460
|
+
/**
|
|
16461
|
+
* Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
|
|
16462
|
+
*
|
|
16463
|
+
* @remarks
|
|
16464
|
+
* [Api set: Mailbox 1.8]
|
|
16465
|
+
*
|
|
16466
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16467
|
+
*
|
|
16468
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16469
|
+
*
|
|
16470
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16471
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16472
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16473
|
+
* of type `Office.AsyncResult`.
|
|
16474
|
+
* On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
|
|
16475
|
+
* in the `asyncResult.value` property.
|
|
16476
|
+
*/
|
|
16477
|
+
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16478
|
+
/**
|
|
16479
|
+
* Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
|
|
16480
|
+
*
|
|
16481
|
+
* @remarks
|
|
16482
|
+
* [Api set: Mailbox 1.8]
|
|
16483
|
+
*
|
|
16484
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16485
|
+
*
|
|
16486
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16487
|
+
*
|
|
16488
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16489
|
+
* of type `Office.AsyncResult`.
|
|
16490
|
+
* On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
|
|
16491
|
+
* in the `asyncResult.value` property.
|
|
16492
|
+
*/
|
|
16493
|
+
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
16494
|
+
/**
|
|
16495
|
+
* Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
|
|
16496
|
+
*
|
|
16497
|
+
* @returns
|
|
16498
|
+
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
16499
|
+
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
16500
|
+
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
16501
|
+
* of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
16502
|
+
*
|
|
16503
|
+
* @remarks
|
|
16504
|
+
* [Api set: Mailbox 1.1]
|
|
16505
|
+
*
|
|
16506
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16507
|
+
*
|
|
16508
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16509
|
+
*
|
|
16510
|
+
* **Important**:
|
|
16511
|
+
*
|
|
16512
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
16513
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
16514
|
+
* For guidance on how to implement these rules, see
|
|
16515
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
16516
|
+
*
|
|
16517
|
+
* - This method is used with the {@link https://learn.microsoft.com/javascript/api/manifest/rule | activation rules feature for Outlook add-ins},
|
|
16518
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
16519
|
+
*
|
|
16520
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
16521
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
16522
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
16523
|
+
*/
|
|
16524
|
+
getRegExMatches(): any;
|
|
16525
|
+
/**
|
|
16526
|
+
* Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
|
|
16527
|
+
*
|
|
16528
|
+
* @returns
|
|
16529
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
|
|
16530
|
+
* with the specified `RegExName` element value.
|
|
16531
|
+
*
|
|
16532
|
+
* @remarks
|
|
16533
|
+
* [Api set: Mailbox 1.1]
|
|
16534
|
+
*
|
|
16535
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16536
|
+
*
|
|
16537
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16538
|
+
*
|
|
16539
|
+
* **Important**:
|
|
16540
|
+
*
|
|
16541
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
16542
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
16543
|
+
* For guidance on how to implement these rules, see
|
|
16544
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
16545
|
+
*
|
|
16546
|
+
* - This method is used with the {@link https://learn.microsoft.com/javascript/api/manifest/rule | activation rules feature for Outlook add-ins},
|
|
16547
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
16548
|
+
*
|
|
16549
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
16550
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
16551
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
16552
|
+
*
|
|
16553
|
+
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
16554
|
+
*/
|
|
16555
|
+
getRegExMatchesByName(name: string): string[];
|
|
16556
|
+
/**
|
|
16557
|
+
* Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
|
|
16558
|
+
* Highlighted matches apply to contextual add-ins.
|
|
16559
|
+
*
|
|
16560
|
+
* @returns
|
|
16561
|
+
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
16562
|
+
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
|
|
16563
|
+
* the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
|
|
16564
|
+
* in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
16565
|
+
*
|
|
16566
|
+
* @remarks
|
|
16567
|
+
* [Api set: Mailbox 1.6]
|
|
16568
|
+
*
|
|
16569
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16570
|
+
*
|
|
16571
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16572
|
+
*
|
|
16573
|
+
* **Important**:
|
|
16574
|
+
*
|
|
16575
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
16576
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
16577
|
+
* For guidance on how to implement these rules, see
|
|
16578
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
16579
|
+
*
|
|
16580
|
+
* - This method is used with the {@link https://learn.microsoft.com/javascript/api/manifest/rule | activation rules feature for Outlook add-ins},
|
|
16581
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
16582
|
+
*
|
|
16583
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
16584
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
|
|
16585
|
+
* expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
16586
|
+
*/
|
|
16587
|
+
getSelectedRegExMatches(): any;
|
|
16588
|
+
/**
|
|
16589
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16590
|
+
*
|
|
16591
|
+
* For more information around using this API, see
|
|
16592
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
16593
|
+
*
|
|
16594
|
+
* @remarks
|
|
16595
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16596
|
+
*
|
|
16597
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16598
|
+
*
|
|
16599
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16600
|
+
*
|
|
16601
|
+
* @param options - An object literal that contains one or more of the following properties:-
|
|
16602
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16603
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16604
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16605
|
+
*/
|
|
16606
|
+
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16607
|
+
/**
|
|
16608
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16609
|
+
*
|
|
16610
|
+
* For more information around using this API, see
|
|
16611
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
16612
|
+
*
|
|
16613
|
+
* @remarks
|
|
16614
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16615
|
+
*
|
|
16616
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16617
|
+
*
|
|
16618
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16619
|
+
*
|
|
16620
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16621
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16622
|
+
*/
|
|
16623
|
+
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16624
|
+
/**
|
|
16625
|
+
* Asynchronously loads custom properties for this add-in on the selected item.
|
|
16626
|
+
*
|
|
16627
|
+
* Custom properties are stored as key-value pairs on a per-app, per-item basis.
|
|
16628
|
+
* This method returns a {@link Office.CustomProperties | CustomProperties} object in the callback, which provides methods to access the custom properties specific to the
|
|
16629
|
+
* current item and the current add-in. Custom properties aren't encrypted on the item, so this shouldn't be used as secure storage.
|
|
16630
|
+
*
|
|
16631
|
+
* The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property.
|
|
16632
|
+
* This object can be used to get custom properties from the mail item.
|
|
16633
|
+
*
|
|
16634
|
+
* @remarks
|
|
16635
|
+
* [Api set: Mailbox 1.1]
|
|
14682
16636
|
*
|
|
14683
|
-
*
|
|
16637
|
+
* To learn more about custom properties, see
|
|
16638
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/metadata-for-an-outlook-add-in | Get and set add-in metadata for an Outlook add-in}.
|
|
16639
|
+
*
|
|
16640
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14684
16641
|
*
|
|
14685
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
16642
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14686
16643
|
*
|
|
14687
|
-
* **Important**:
|
|
14688
|
-
* To learn more about features supported in Outlook on mobile devices, see
|
|
14689
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16644
|
+
* **Important**: Only the `get` and `getAll` methods of the CustomProperties object are supported.
|
|
14690
16645
|
*
|
|
14691
|
-
* @param
|
|
14692
|
-
*
|
|
14693
|
-
*
|
|
16646
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16647
|
+
* type `Office.AsyncResult`.
|
|
16648
|
+
* @param userContext - Optional. Developers can provide any object they wish to access in the callback function.
|
|
16649
|
+
* This object can be accessed by the `asyncResult.asyncContext` property in the callback function.
|
|
14694
16650
|
*/
|
|
14695
|
-
|
|
16651
|
+
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
|
|
14696
16652
|
/**
|
|
14697
|
-
*
|
|
14698
|
-
*
|
|
14699
|
-
* The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with
|
|
14700
|
-
* the new value.
|
|
14701
|
-
*
|
|
14702
|
-
* **Note**: This method is intended to set the values of your custom headers.
|
|
16653
|
+
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
14703
16654
|
*
|
|
14704
16655
|
* @remarks
|
|
14705
|
-
* [Api set: Mailbox
|
|
16656
|
+
* [Api set: Mailbox preview]
|
|
14706
16657
|
*
|
|
14707
16658
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14708
16659
|
*
|
|
14709
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
16660
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14710
16661
|
*
|
|
14711
16662
|
* **Important**:
|
|
14712
16663
|
*
|
|
14713
|
-
* -
|
|
14714
|
-
*
|
|
14715
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16664
|
+
* - To learn more about processing multiple selected messages, see
|
|
16665
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14716
16666
|
*
|
|
14717
|
-
* -
|
|
14718
|
-
*
|
|
14719
|
-
* For further information on header limits, see
|
|
14720
|
-
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14721
|
-
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
16667
|
+
* - When a selected mail item is loaded using `loadItemByIdAsync`, you must call `unloadAsync` after processing on it. This must be done before
|
|
16668
|
+
* calling `loadItemByIdAsync` on another selected item.
|
|
14722
16669
|
*
|
|
14723
|
-
* @param
|
|
14724
|
-
*
|
|
14725
|
-
*
|
|
14726
|
-
*
|
|
14727
|
-
* @
|
|
14728
|
-
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
|
|
16670
|
+
* @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.
|
|
16671
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
16672
|
+
* which is an `Office.AsyncResult` object.
|
|
16673
|
+
*
|
|
16674
|
+
* @beta
|
|
14729
16675
|
*/
|
|
14730
|
-
|
|
16676
|
+
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14731
16677
|
/**
|
|
14732
|
-
*
|
|
14733
|
-
*
|
|
14734
|
-
* The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with
|
|
14735
|
-
* the new value.
|
|
14736
|
-
*
|
|
14737
|
-
* **Note**: This method is intended to set the values of your custom headers.
|
|
16678
|
+
* When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.
|
|
14738
16679
|
*
|
|
14739
16680
|
* @remarks
|
|
14740
|
-
* [Api set: Mailbox
|
|
16681
|
+
* [Api set: Mailbox preview]
|
|
14741
16682
|
*
|
|
14742
16683
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14743
16684
|
*
|
|
14744
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
16685
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14745
16686
|
*
|
|
14746
16687
|
* **Important**:
|
|
14747
16688
|
*
|
|
14748
|
-
* -
|
|
14749
|
-
*
|
|
14750
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16689
|
+
* - To learn more about processing multiple selected messages, see
|
|
16690
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14751
16691
|
*
|
|
14752
|
-
* -
|
|
14753
|
-
*
|
|
14754
|
-
* For further information on header limits, see
|
|
14755
|
-
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14756
|
-
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
16692
|
+
* - When a selected mail item is loaded using `loadItemByIdAsync`, you must call `unloadAsync` after processing on it. This must be done before
|
|
16693
|
+
* calling `loadItemByIdAsync` on another selected item.
|
|
14757
16694
|
*
|
|
14758
|
-
* @param
|
|
14759
|
-
*
|
|
14760
|
-
*
|
|
14761
|
-
*
|
|
16695
|
+
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`,
|
|
16696
|
+
* which is an `Office.AsyncResult` object.
|
|
16697
|
+
*
|
|
16698
|
+
* @beta
|
|
14762
16699
|
*/
|
|
14763
|
-
|
|
14764
|
-
}
|
|
14765
|
-
/**
|
|
14766
|
-
* The item namespace is used to access the currently selected message, meeting request, or appointment.
|
|
14767
|
-
* You can determine the type of the item by using the `itemType` property.
|
|
14768
|
-
*
|
|
14769
|
-
* To see the full member list, refer to the
|
|
14770
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14771
|
-
*
|
|
14772
|
-
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
14773
|
-
*
|
|
14774
|
-
* - {@link Office.AppointmentCompose | AppointmentCompose}
|
|
14775
|
-
*
|
|
14776
|
-
* - {@link Office.AppointmentRead | AppointmentRead}
|
|
14777
|
-
*
|
|
14778
|
-
* - {@link Office.MessageCompose | MessageCompose}
|
|
14779
|
-
*
|
|
14780
|
-
* - {@link Office.MessageRead | MessageRead}
|
|
14781
|
-
*
|
|
14782
|
-
* @remarks
|
|
14783
|
-
*
|
|
14784
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
14785
|
-
*
|
|
14786
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read
|
|
14787
|
-
*/
|
|
14788
|
-
interface Item {
|
|
14789
|
-
}
|
|
14790
|
-
/**
|
|
14791
|
-
* The compose mode of {@link Office.Item | Office.context.mailbox.item}.
|
|
14792
|
-
*
|
|
14793
|
-
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14794
|
-
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14795
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14796
|
-
*
|
|
14797
|
-
* Child interfaces:
|
|
14798
|
-
*
|
|
14799
|
-
* - {@link Office.AppointmentCompose | AppointmentCompose}
|
|
14800
|
-
*
|
|
14801
|
-
* - {@link Office.MessageCompose | MessageCompose}
|
|
14802
|
-
*/
|
|
14803
|
-
interface ItemCompose extends Item {
|
|
14804
|
-
}
|
|
14805
|
-
/**
|
|
14806
|
-
* The read mode of {@link Office.Item | Office.context.mailbox.item}.
|
|
14807
|
-
*
|
|
14808
|
-
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14809
|
-
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14810
|
-
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14811
|
-
*
|
|
14812
|
-
* Child interfaces:
|
|
14813
|
-
*
|
|
14814
|
-
* - {@link Office.AppointmentRead | AppointmentRead}
|
|
14815
|
-
*
|
|
14816
|
-
* - {@link Office.MessageRead | MessageRead}
|
|
14817
|
-
*/
|
|
14818
|
-
interface ItemRead extends Item {
|
|
16700
|
+
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14819
16701
|
}
|
|
14820
16702
|
/**
|
|
14821
16703
|
* Represents a date and time in the local client's time zone. Read mode only.
|
|
@@ -15931,6 +17813,76 @@ declare namespace Office {
|
|
|
15931
17813
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
15932
17814
|
*/
|
|
15933
17815
|
getUserIdentityTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
17816
|
+
/**
|
|
17817
|
+
* Loads a single mail item by its Exchange Web Services (EWS) ID.
|
|
17818
|
+
* Then, gets an object that provides the properties and methods of the loaded item.
|
|
17819
|
+
*
|
|
17820
|
+
* @remarks
|
|
17821
|
+
* [Api set: Mailbox preview]
|
|
17822
|
+
*
|
|
17823
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
17824
|
+
*
|
|
17825
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
17826
|
+
*
|
|
17827
|
+
* **Important**:
|
|
17828
|
+
*
|
|
17829
|
+
* - This method only applies to messages.
|
|
17830
|
+
*
|
|
17831
|
+
* - When implementing the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select feature},
|
|
17832
|
+
* call `Office.context.mailbox.getSelectedItemsAsync` to get the item IDs of each selected item, so that they can be loaded one at a time.
|
|
17833
|
+
*
|
|
17834
|
+
* - Before you implement the `loadItemByIdAsync` method with the item multi-select feature, determine if you can already access the required properties of the
|
|
17835
|
+
* selected item using the `Office.context.mailbox.getSelectedItemsAsync` call. If you can, you don't need to call `loadItemByIdAsync`.
|
|
17836
|
+
*
|
|
17837
|
+
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
17838
|
+
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
17839
|
+
*
|
|
17840
|
+
* - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
|
|
17841
|
+
*
|
|
17842
|
+
* @param itemId - The EWS ID of a selected item.
|
|
17843
|
+
* @param options - An object literal that contains the `asyncContext` property.
|
|
17844
|
+
* In this property, provide any object you wish to access in the callback function.
|
|
17845
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17846
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
|
|
17847
|
+
* in the `asyncResult.value` property. This object provides the properties of the selected item that's currently loaded.
|
|
17848
|
+
*
|
|
17849
|
+
* @beta
|
|
17850
|
+
*/
|
|
17851
|
+
loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
|
|
17852
|
+
/**
|
|
17853
|
+
* Loads a single mail item by its Exchange Web Services (EWS) ID.
|
|
17854
|
+
* Then, gets an object that provides the properties and methods of the loaded item.
|
|
17855
|
+
*
|
|
17856
|
+
* @remarks
|
|
17857
|
+
* [Api set: Mailbox preview]
|
|
17858
|
+
*
|
|
17859
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
17860
|
+
*
|
|
17861
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
|
|
17862
|
+
*
|
|
17863
|
+
* **Important**:
|
|
17864
|
+
*
|
|
17865
|
+
* - This method only applies to messages.
|
|
17866
|
+
*
|
|
17867
|
+
* - When implementing the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select feature},
|
|
17868
|
+
* call `Office.context.mailbox.getSelectedItemsAsync` to get the item IDs of each selected item, so that they can be loaded one at a time.
|
|
17869
|
+
*
|
|
17870
|
+
* - Before you implement the `loadItemByIdAsync` method with the item multi-select feature, determine if you can already access the required properties of the
|
|
17871
|
+
* selected item using the `Office.context.mailbox.getSelectedItemsAsync` call. If you can, you don't need to call `loadItemByIdAsync`.
|
|
17872
|
+
*
|
|
17873
|
+
* - Only one mail item can be loaded at a time. When you implement `loadItemByIdAsync`, you must call `unloadAsync` after processing the item.
|
|
17874
|
+
* This must be done before calling `loadItemByIdAsync` on another item.
|
|
17875
|
+
*
|
|
17876
|
+
* - The `loadItemByIdAsync` method can only be called on messages in the same mailbox.
|
|
17877
|
+
*
|
|
17878
|
+
* @param itemId - The EWS ID of a selected item.
|
|
17879
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17880
|
+
* `asyncResult`, which is an `Office.AsyncResult` object. A `LoadedMessageCompose` or `LoadedMessageRead` object is returned
|
|
17881
|
+
* in the `asyncResult.value` property. This object provides the properties of the selected item that's currently loaded.
|
|
17882
|
+
*
|
|
17883
|
+
* @beta
|
|
17884
|
+
*/
|
|
17885
|
+
loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void): void;
|
|
15934
17886
|
/**
|
|
15935
17887
|
* Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.
|
|
15936
17888
|
*
|
|
@@ -16342,15 +18294,15 @@ declare namespace Office {
|
|
|
16342
18294
|
/**
|
|
16343
18295
|
* Gets an object that provides methods for managing the item's categories.
|
|
16344
18296
|
*
|
|
16345
|
-
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16346
|
-
* you can't use the API to manage categories on a message in Compose mode.
|
|
16347
|
-
*
|
|
16348
18297
|
* @remarks
|
|
16349
18298
|
* [Api set: Mailbox 1.8]
|
|
16350
18299
|
*
|
|
16351
18300
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16352
18301
|
*
|
|
16353
18302
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
18303
|
+
*
|
|
18304
|
+
* **Important**: In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18305
|
+
* you can't use the API to manage categories on a message in Compose mode.
|
|
16354
18306
|
*/
|
|
16355
18307
|
categories: Categories;
|
|
16356
18308
|
/**
|
|
@@ -16498,20 +18450,20 @@ declare namespace Office {
|
|
|
16498
18450
|
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
16499
18451
|
* However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
16500
18452
|
*
|
|
16501
|
-
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
16502
|
-
* The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API.
|
|
16503
|
-
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
16504
|
-
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
16505
|
-
*
|
|
16506
|
-
* The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests
|
|
16507
|
-
* and returns `undefined` for any other items that are not meeting requests.
|
|
16508
|
-
*
|
|
16509
18453
|
* @remarks
|
|
16510
18454
|
* [Api set: Mailbox 1.7]
|
|
16511
18455
|
*
|
|
16512
18456
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16513
18457
|
*
|
|
16514
18458
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
18459
|
+
*
|
|
18460
|
+
* **Important**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
18461
|
+
* The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API.
|
|
18462
|
+
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
18463
|
+
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
18464
|
+
*
|
|
18465
|
+
* The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
18466
|
+
* and returns `undefined` for any other items that are not meeting requests.
|
|
16515
18467
|
*/
|
|
16516
18468
|
seriesId: string;
|
|
16517
18469
|
/**
|
|
@@ -16556,7 +18508,6 @@ declare namespace Office {
|
|
|
16556
18508
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16557
18509
|
*/
|
|
16558
18510
|
to: Recipients;
|
|
16559
|
-
|
|
16560
18511
|
/**
|
|
16561
18512
|
* Adds a file to a message or appointment as an attachment.
|
|
16562
18513
|
*
|
|
@@ -17216,6 +19167,14 @@ declare namespace Office {
|
|
|
17216
19167
|
* <td>New messages and message replies</td>
|
|
17217
19168
|
* </tr>
|
|
17218
19169
|
* <tr>
|
|
19170
|
+
* <td>IPM.Note.SMIME</td>
|
|
19171
|
+
* <td>Encrypted messages that can also be signed</td>
|
|
19172
|
+
* </tr>
|
|
19173
|
+
* <tr>
|
|
19174
|
+
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
19175
|
+
* <td>Clear-signed messages</td>
|
|
19176
|
+
* </tr>
|
|
19177
|
+
* <tr>
|
|
17219
19178
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
17220
19179
|
* <td>Meeting requests</td>
|
|
17221
19180
|
* </tr>
|
|
@@ -17267,6 +19226,14 @@ declare namespace Office {
|
|
|
17267
19226
|
* <td>New messages and message replies</td>
|
|
17268
19227
|
* </tr>
|
|
17269
19228
|
* <tr>
|
|
19229
|
+
* <td>IPM.Note.SMIME</td>
|
|
19230
|
+
* <td>Encrypted messages that can also be signed</td>
|
|
19231
|
+
* </tr>
|
|
19232
|
+
* <tr>
|
|
19233
|
+
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
19234
|
+
* <td>Clear-signed messages</td>
|
|
19235
|
+
* </tr>
|
|
19236
|
+
* <tr>
|
|
17270
19237
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
17271
19238
|
* <td>Meeting requests</td>
|
|
17272
19239
|
* </tr>
|
|
@@ -17432,7 +19399,7 @@ declare namespace Office {
|
|
|
17432
19399
|
*
|
|
17433
19400
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
17434
19401
|
*
|
|
17435
|
-
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
19402
|
+
* b. **Shared mailbox (applies to classic Outlook on Windows only)**
|
|
17436
19403
|
*
|
|
17437
19404
|
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
17438
19405
|
*
|
|
@@ -17475,7 +19442,7 @@ declare namespace Office {
|
|
|
17475
19442
|
*
|
|
17476
19443
|
* 3. The delegate opens the draft from the shared folder then continues composing.
|
|
17477
19444
|
*
|
|
17478
|
-
* b. **Shared mailbox (applies to Outlook on Windows only)**
|
|
19445
|
+
* b. **Shared mailbox (applies to classic Outlook on Windows only)**
|
|
17479
19446
|
*
|
|
17480
19447
|
* 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
|
|
17481
19448
|
*
|
|
@@ -19131,6 +21098,9 @@ declare namespace Office {
|
|
|
19131
21098
|
*
|
|
19132
21099
|
* - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
|
|
19133
21100
|
*
|
|
21101
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21102
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21103
|
+
*
|
|
19134
21104
|
* @param key - A developer-specified key used to reference this notification message.
|
|
19135
21105
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
19136
21106
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -19163,6 +21133,9 @@ declare namespace Office {
|
|
|
19163
21133
|
*
|
|
19164
21134
|
* - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
|
|
19165
21135
|
*
|
|
21136
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21137
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21138
|
+
*
|
|
19166
21139
|
* @param key - A developer-specified key used to reference this notification message.
|
|
19167
21140
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
19168
21141
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -19211,6 +21184,9 @@ declare namespace Office {
|
|
|
19211
21184
|
*
|
|
19212
21185
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
19213
21186
|
*
|
|
21187
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21188
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21189
|
+
*
|
|
19214
21190
|
* @param key - The key for the notification message to remove.
|
|
19215
21191
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19216
21192
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -19228,6 +21204,9 @@ declare namespace Office {
|
|
|
19228
21204
|
*
|
|
19229
21205
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
19230
21206
|
*
|
|
21207
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21208
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21209
|
+
*
|
|
19231
21210
|
* @param key - The key for the notification message to remove.
|
|
19232
21211
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
19233
21212
|
* of type `Office.AsyncResult`.
|
|
@@ -19245,6 +21224,9 @@ declare namespace Office {
|
|
|
19245
21224
|
*
|
|
19246
21225
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
19247
21226
|
*
|
|
21227
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21228
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21229
|
+
*
|
|
19248
21230
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
19249
21231
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
19250
21232
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -19266,6 +21248,9 @@ declare namespace Office {
|
|
|
19266
21248
|
*
|
|
19267
21249
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
19268
21250
|
*
|
|
21251
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21252
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21253
|
+
*
|
|
19269
21254
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
19270
21255
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
19271
21256
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -19425,7 +21410,9 @@ declare namespace Office {
|
|
|
19425
21410
|
*
|
|
19426
21411
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19427
21412
|
*
|
|
19428
|
-
* **Important**:
|
|
21413
|
+
* **Important**:
|
|
21414
|
+
*
|
|
21415
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
19429
21416
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19430
21417
|
* However, take note of the following:
|
|
19431
21418
|
*
|
|
@@ -19438,6 +21425,9 @@ declare namespace Office {
|
|
|
19438
21425
|
*
|
|
19439
21426
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
19440
21427
|
*
|
|
21428
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21429
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21430
|
+
*
|
|
19441
21431
|
* **Errors**:
|
|
19442
21432
|
*
|
|
19443
21433
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -19460,7 +21450,9 @@ declare namespace Office {
|
|
|
19460
21450
|
*
|
|
19461
21451
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19462
21452
|
*
|
|
19463
|
-
* **Important**:
|
|
21453
|
+
* **Important**:
|
|
21454
|
+
*
|
|
21455
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows,
|
|
19464
21456
|
* on Mac (classic UI), on Android, and on iOS. However, take note of the following:
|
|
19465
21457
|
*
|
|
19466
21458
|
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
@@ -19472,6 +21464,9 @@ declare namespace Office {
|
|
|
19472
21464
|
*
|
|
19473
21465
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
19474
21466
|
*
|
|
21467
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21468
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21469
|
+
*
|
|
19475
21470
|
* **Errors**:
|
|
19476
21471
|
*
|
|
19477
21472
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -19590,7 +21585,9 @@ declare namespace Office {
|
|
|
19590
21585
|
*
|
|
19591
21586
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19592
21587
|
*
|
|
19593
|
-
* **Important**:
|
|
21588
|
+
* **Important**:
|
|
21589
|
+
*
|
|
21590
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19594
21591
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19595
21592
|
* However, take note of the following:
|
|
19596
21593
|
*
|
|
@@ -19603,6 +21600,9 @@ declare namespace Office {
|
|
|
19603
21600
|
*
|
|
19604
21601
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
19605
21602
|
*
|
|
21603
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21604
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21605
|
+
*
|
|
19606
21606
|
* **Errors**:
|
|
19607
21607
|
*
|
|
19608
21608
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -19628,7 +21628,9 @@ declare namespace Office {
|
|
|
19628
21628
|
*
|
|
19629
21629
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19630
21630
|
*
|
|
19631
|
-
* **Important**:
|
|
21631
|
+
* **Important**:
|
|
21632
|
+
*
|
|
21633
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
19632
21634
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
19633
21635
|
* However, take note of the following:
|
|
19634
21636
|
*
|
|
@@ -19641,6 +21643,9 @@ declare namespace Office {
|
|
|
19641
21643
|
*
|
|
19642
21644
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
19643
21645
|
*
|
|
21646
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21647
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21648
|
+
*
|
|
19644
21649
|
* **Errors**:
|
|
19645
21650
|
*
|
|
19646
21651
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -19862,8 +21867,6 @@ declare namespace Office {
|
|
|
19862
21867
|
/**
|
|
19863
21868
|
* Sets the recurrence pattern of an appointment series.
|
|
19864
21869
|
*
|
|
19865
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
19866
|
-
*
|
|
19867
21870
|
* @remarks
|
|
19868
21871
|
* [Api set: Mailbox 1.7]
|
|
19869
21872
|
*
|
|
@@ -19871,6 +21874,13 @@ declare namespace Office {
|
|
|
19871
21874
|
*
|
|
19872
21875
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19873
21876
|
*
|
|
21877
|
+
* **Important**:
|
|
21878
|
+
*
|
|
21879
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
21880
|
+
*
|
|
21881
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21882
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21883
|
+
*
|
|
19874
21884
|
* **Errors**:
|
|
19875
21885
|
*
|
|
19876
21886
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -19885,8 +21895,6 @@ declare namespace Office {
|
|
|
19885
21895
|
/**
|
|
19886
21896
|
* Sets the recurrence pattern of an appointment series.
|
|
19887
21897
|
*
|
|
19888
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
19889
|
-
*
|
|
19890
21898
|
* @remarks
|
|
19891
21899
|
* [Api set: Mailbox 1.7]
|
|
19892
21900
|
*
|
|
@@ -19894,6 +21902,13 @@ declare namespace Office {
|
|
|
19894
21902
|
*
|
|
19895
21903
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19896
21904
|
*
|
|
21905
|
+
* **Important**:
|
|
21906
|
+
*
|
|
21907
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
21908
|
+
*
|
|
21909
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21910
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21911
|
+
*
|
|
19897
21912
|
* **Errors**:
|
|
19898
21913
|
*
|
|
19899
21914
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -20397,7 +22412,12 @@ declare namespace Office {
|
|
|
20397
22412
|
*
|
|
20398
22413
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20399
22414
|
*
|
|
20400
|
-
* **Important**:
|
|
22415
|
+
* **Important**:
|
|
22416
|
+
*
|
|
22417
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22418
|
+
*
|
|
22419
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22420
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
20401
22421
|
*
|
|
20402
22422
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
20403
22423
|
*
|
|
@@ -20422,7 +22442,12 @@ declare namespace Office {
|
|
|
20422
22442
|
*
|
|
20423
22443
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
20424
22444
|
*
|
|
20425
|
-
* **Important**:
|
|
22445
|
+
* **Important**:
|
|
22446
|
+
*
|
|
22447
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22448
|
+
*
|
|
22449
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22450
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
20426
22451
|
*
|
|
20427
22452
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
20428
22453
|
*
|
|
@@ -21341,10 +23366,15 @@ declare namespace Office {
|
|
|
21341
23366
|
*
|
|
21342
23367
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21343
23368
|
*
|
|
21344
|
-
* **Important**:
|
|
23369
|
+
* **Important**:
|
|
23370
|
+
*
|
|
23371
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
21345
23372
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
21346
23373
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
21347
23374
|
*
|
|
23375
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23376
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
23377
|
+
*
|
|
21348
23378
|
* **Errors**:
|
|
21349
23379
|
*
|
|
21350
23380
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
|
@@ -21369,10 +23399,15 @@ declare namespace Office {
|
|
|
21369
23399
|
*
|
|
21370
23400
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21371
23401
|
*
|
|
21372
|
-
* **Important**:
|
|
23402
|
+
* **Important**:
|
|
23403
|
+
*
|
|
23404
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
21373
23405
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
21374
23406
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
21375
23407
|
*
|
|
23408
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23409
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
23410
|
+
*
|
|
21376
23411
|
* **Errors**:
|
|
21377
23412
|
*
|
|
21378
23413
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|