@types/office-js-preview 1.0.686 → 1.0.687

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.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Sat, 14 Feb 2026 00:52:50 GMT
11
+ * Last updated: Mon, 23 Feb 2026 19:24:54 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -4742,10 +4742,17 @@ declare namespace Office {
4742
4742
  * - `item`: Provides methods and properties for accessing a message or appointment in an Outlook add-in.
4743
4743
  *
4744
4744
  * - `userProfile`: Provides information about the user in an Outlook add-in.
4745
+ *
4746
+ * To learn more about the `Mailbox` object, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/apis#mailbox-object | Outlook add-in APIs}.
4745
4747
  */
4746
4748
  mailbox: Office.Mailbox;
4747
4749
  /**
4748
4750
  * Provides access to the properties for Office theme colors.
4751
+ *
4752
+ * @remarks
4753
+ *
4754
+ * **Important**: In Outlook, `officeTheme` is supported starting in {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
4755
+ * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}.
4749
4756
  */
4750
4757
  officeTheme: OfficeTheme;
4751
4758
  /**
@@ -4784,6 +4791,8 @@ declare namespace Office {
4784
4791
  *
4785
4792
  * @remarks
4786
4793
  *
4794
+ * [Api set: Mailbox 1.1]
4795
+ *
4787
4796
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
4788
4797
  *
4789
4798
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -7618,7 +7627,7 @@ declare namespace Office {
7618
7627
  * </table>
7619
7628
  *
7620
7629
  * **Important**: In Outlook, the Office theme API is supported starting in
7621
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7630
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7622
7631
  * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}.
7623
7632
  */
7624
7633
  interface OfficeTheme {
@@ -10859,8 +10868,8 @@ declare namespace Office {
10859
10868
  * The subclass of {@link Office.Item | Item} dealing with appointments.
10860
10869
  *
10861
10870
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10862
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10863
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
10871
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
10872
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
10864
10873
  *
10865
10874
  * Child interfaces:
10866
10875
  *
@@ -10874,8 +10883,8 @@ declare namespace Office {
10874
10883
  * The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}.
10875
10884
  *
10876
10885
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10877
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10878
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
10886
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
10887
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
10879
10888
  *
10880
10889
  * Parent interfaces:
10881
10890
  *
@@ -11349,10 +11358,7 @@ declare namespace Office {
11349
11358
  */
11350
11359
  addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
11351
11360
  /**
11352
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11353
- *
11354
- * For supported events, refer to the Item object model
11355
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
11361
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
11356
11362
  *
11357
11363
  * @remarks
11358
11364
  * [Api set: Mailbox 1.7]
@@ -11361,6 +11367,8 @@ declare namespace Office {
11361
11367
  *
11362
11368
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11363
11369
  *
11370
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
11371
+ *
11364
11372
  * @param eventType - The event that should invoke the handler.
11365
11373
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
11366
11374
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -11371,10 +11379,7 @@ declare namespace Office {
11371
11379
  */
11372
11380
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11373
11381
  /**
11374
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11375
- *
11376
- * For supported events, refer to the Item object model
11377
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
11382
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
11378
11383
  *
11379
11384
  * @remarks
11380
11385
  * [Api set: Mailbox 1.7]
@@ -11383,6 +11388,8 @@ declare namespace Office {
11383
11388
  *
11384
11389
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11385
11390
  *
11391
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
11392
+ *
11386
11393
  * @param eventType - The event that should invoke the handler.
11387
11394
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
11388
11395
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -11949,10 +11956,7 @@ declare namespace Office {
11949
11956
  */
11950
11957
  removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11951
11958
  /**
11952
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11953
- *
11954
- * For supported events, refer to the Item object model
11955
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
11959
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
11956
11960
  *
11957
11961
  * @remarks
11958
11962
  * [Api set: Mailbox 1.7]
@@ -11961,6 +11965,8 @@ declare namespace Office {
11961
11965
  *
11962
11966
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11963
11967
  *
11968
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
11969
+ *
11964
11970
  * @param eventType - The event that should revoke the handler.
11965
11971
  * @param options - An object literal that contains one or more of the following properties:-
11966
11972
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -11969,10 +11975,7 @@ declare namespace Office {
11969
11975
  */
11970
11976
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11971
11977
  /**
11972
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11973
- *
11974
- * For supported events, refer to the Item object model
11975
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
11978
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
11976
11979
  *
11977
11980
  * @remarks
11978
11981
  * [Api set: Mailbox 1.7]
@@ -11981,6 +11984,8 @@ declare namespace Office {
11981
11984
  *
11982
11985
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11983
11986
  *
11987
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
11988
+ *
11984
11989
  * @param eventType - The event that should revoke the handler.
11985
11990
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11986
11991
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -12314,8 +12319,8 @@ declare namespace Office {
12314
12319
  * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
12315
12320
  *
12316
12321
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
12317
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
12318
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
12322
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
12323
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
12319
12324
  *
12320
12325
  * Parent interfaces:
12321
12326
  *
@@ -12668,10 +12673,7 @@ declare namespace Office {
12668
12673
  */
12669
12674
  sensitivity: MailboxEnums.AppointmentSensitivityType;
12670
12675
  /**
12671
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12672
- *
12673
- * For supported events, refer to the Item object model
12674
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
12676
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
12675
12677
  *
12676
12678
  * @remarks
12677
12679
  * [Api set: Mailbox 1.7]
@@ -12680,6 +12682,8 @@ declare namespace Office {
12680
12682
  *
12681
12683
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12682
12684
  *
12685
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
12686
+ *
12683
12687
  * @param eventType - The event that should invoke the handler.
12684
12688
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12685
12689
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -12690,10 +12694,7 @@ declare namespace Office {
12690
12694
  */
12691
12695
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12692
12696
  /**
12693
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12694
- *
12695
- * For supported events, refer to the Item object model
12696
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
12697
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
12697
12698
  *
12698
12699
  * @remarks
12699
12700
  * [Api set: Mailbox 1.7]
@@ -12702,6 +12703,8 @@ declare namespace Office {
12702
12703
  *
12703
12704
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12704
12705
  *
12706
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
12707
+ *
12705
12708
  * @param eventType - The event that should invoke the handler.
12706
12709
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12707
12710
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -13253,10 +13256,7 @@ declare namespace Office {
13253
13256
  */
13254
13257
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
13255
13258
  /**
13256
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13257
- *
13258
- * For supported events, refer to the Item object model
13259
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
13259
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
13260
13260
  *
13261
13261
  * @remarks
13262
13262
  * [Api set: Mailbox 1.7]
@@ -13265,6 +13265,8 @@ declare namespace Office {
13265
13265
  *
13266
13266
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13267
13267
  *
13268
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
13269
+ *
13268
13270
  * @param eventType - The event that should revoke the handler.
13269
13271
  * @param options - An object literal that contains one or more of the following properties:-
13270
13272
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13273,10 +13275,7 @@ declare namespace Office {
13273
13275
  */
13274
13276
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13275
13277
  /**
13276
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13277
- *
13278
- * For supported events, refer to the Item object model
13279
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
13278
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
13280
13279
  *
13281
13280
  * @remarks
13282
13281
  * [Api set: Mailbox 1.7]
@@ -13285,6 +13284,8 @@ declare namespace Office {
13285
13284
  *
13286
13285
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13287
13286
  *
13287
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
13288
+ *
13288
13289
  * @param eventType - The event that should revoke the handler.
13289
13290
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13290
13291
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -16235,9 +16236,6 @@ declare namespace Office {
16235
16236
  * The item namespace is used to access the currently selected message, meeting request, or appointment.
16236
16237
  * You can determine the type of the item by using the `itemType` property.
16237
16238
  *
16238
- * To see the full member list, refer to the
16239
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
16240
- *
16241
16239
  * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
16242
16240
  *
16243
16241
  * - {@link Office.AppointmentCompose | AppointmentCompose}
@@ -16260,8 +16258,8 @@ declare namespace Office {
16260
16258
  * The compose mode of {@link Office.Item | Office.context.mailbox.item}.
16261
16259
  *
16262
16260
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
16263
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
16264
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
16261
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
16262
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
16265
16263
  *
16266
16264
  * Child interfaces:
16267
16265
  *
@@ -16275,8 +16273,8 @@ declare namespace Office {
16275
16273
  * The read mode of {@link Office.Item | Office.context.mailbox.item}.
16276
16274
  *
16277
16275
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
16278
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
16279
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
16276
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
16277
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
16280
16278
  *
16281
16279
  * Child interfaces:
16282
16280
  *
@@ -18461,10 +18459,7 @@ declare namespace Office {
18461
18459
  userProfile: UserProfile;
18462
18460
 
18463
18461
  /**
18464
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
18465
- *
18466
- * For supported events, refer to the Mailbox object model
18467
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
18462
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
18468
18463
  *
18469
18464
  * @remarks
18470
18465
  * [Api set: Mailbox 1.5]
@@ -18473,6 +18468,17 @@ declare namespace Office {
18473
18468
  *
18474
18469
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18475
18470
  *
18471
+ * **Important**: The following events are supported on the `Mailbox` object.
18472
+ *
18473
+ * <table>
18474
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
18475
+ * <tr><td>`DragAndDropEvent`</td><td>A message or file attachment in the Outlook client window is dragged then dropped into the task pane of an add-in.
18476
+ * This event is only supported in Outlook on the web and the new Outlook on Windows.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
18477
+ * <tr><td>`ItemChanged`</td><td>A different Outlook item is selected for viewing while the task pane is pinned.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
18478
+ * <tr><td>`OfficeThemeChanged`</td><td>The OfficeTheme is changed in Outlook.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14 | 1.14}</td></tr>
18479
+ * <tr><td>`SelectedItemsChanged`</td><td>One or more messages are selected or deselected.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-13 | 1.13}</td></tr>
18480
+ * </table>
18481
+ *
18476
18482
  * @param eventType - The event that should invoke the handler.
18477
18483
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
18478
18484
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -18482,10 +18488,7 @@ declare namespace Office {
18482
18488
  */
18483
18489
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18484
18490
  /**
18485
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
18486
- *
18487
- * For supported events, refer to the Mailbox object model
18488
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
18491
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
18489
18492
  *
18490
18493
  * @remarks
18491
18494
  * [Api set: Mailbox 1.5]
@@ -18494,6 +18497,17 @@ declare namespace Office {
18494
18497
  *
18495
18498
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18496
18499
  *
18500
+ * **Important**: The following events are supported on the `Mailbox` object.
18501
+ *
18502
+ * <table>
18503
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
18504
+ * <tr><td>`DragAndDropEvent`</td><td>A message or file attachment in the Outlook client window is dragged then dropped into the task pane of an add-in.
18505
+ * This event is only supported in Outlook on the web and the new Outlook on Windows.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
18506
+ * <tr><td>`ItemChanged`</td><td>A different Outlook item is selected for viewing while the task pane is pinned.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
18507
+ * <tr><td>`OfficeThemeChanged`</td><td>The OfficeTheme is changed in Outlook.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14 | 1.14}</td></tr>
18508
+ * <tr><td>`SelectedItemsChanged`</td><td>One or more messages are selected or deselected.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-13 | 1.13}</td></tr>
18509
+ * </table>
18510
+ *
18497
18511
  * @param eventType - The event that should invoke the handler.
18498
18512
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
18499
18513
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -19376,10 +19390,7 @@ declare namespace Office {
19376
19390
  */
19377
19391
  makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
19378
19392
  /**
19379
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
19380
- *
19381
- * For supported events, refer to the Mailbox object model
19382
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
19393
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
19383
19394
  *
19384
19395
  * @remarks
19385
19396
  * [Api set: Mailbox 1.5]
@@ -19388,6 +19399,17 @@ declare namespace Office {
19388
19399
  *
19389
19400
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
19390
19401
  *
19402
+ * **Important**: The following events are supported on the `Mailbox` object.
19403
+ *
19404
+ * <table>
19405
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
19406
+ * <tr><td>`DragAndDropEvent`</td><td>A message or file attachment in the Outlook client window is dragged then dropped into the task pane of an add-in.
19407
+ * This event is only supported in Outlook on the web and the new Outlook on Windows.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
19408
+ * <tr><td>`ItemChanged`</td><td>A different Outlook item is selected for viewing while the task pane is pinned.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
19409
+ * <tr><td>`OfficeThemeChanged`</td><td>The OfficeTheme is changed in Outlook.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14 | 1.14}</td></tr>
19410
+ * <tr><td>`SelectedItemsChanged`</td><td>One or more messages are selected or deselected.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-13 | 1.13}</td></tr>
19411
+ * </table>
19412
+ *
19391
19413
  * @param eventType - The event that should revoke the handler.
19392
19414
  * @param options - Provides an option for preserving context data of any type, unchanged, for use in a callback.
19393
19415
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -19395,10 +19417,7 @@ declare namespace Office {
19395
19417
  */
19396
19418
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
19397
19419
  /**
19398
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
19399
- *
19400
- * For supported events, refer to the Mailbox object model
19401
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
19420
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
19402
19421
  *
19403
19422
  * @remarks
19404
19423
  * [Api set: Mailbox 1.5]
@@ -19407,6 +19426,17 @@ declare namespace Office {
19407
19426
  *
19408
19427
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
19409
19428
  *
19429
+ * **Important**: The following events are supported on the `Mailbox` object.
19430
+ *
19431
+ * <table>
19432
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
19433
+ * <tr><td>`DragAndDropEvent`</td><td>A message or file attachment in the Outlook client window is dragged then dropped into the task pane of an add-in.
19434
+ * This event is only supported in Outlook on the web and the new Outlook on Windows.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
19435
+ * <tr><td>`ItemChanged`</td><td>A different Outlook item is selected for viewing while the task pane is pinned.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-5 | 1.5}</td></tr>
19436
+ * <tr><td>`OfficeThemeChanged`</td><td>The OfficeTheme is changed in Outlook.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14 | 1.14}</td></tr>
19437
+ * <tr><td>`SelectedItemsChanged`</td><td>One or more messages are selected or deselected.</td><td>{@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-13 | 1.13}</td></tr>
19438
+ * </table>
19439
+ *
19410
19440
  * @param eventType - The event that should revoke the handler.
19411
19441
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
19412
19442
  * type `Office.AsyncResult`.
@@ -19684,8 +19714,8 @@ declare namespace Office {
19684
19714
  * A subclass of {@link Office.Item | Item} for messages.
19685
19715
  *
19686
19716
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
19687
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19688
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
19717
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
19718
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
19689
19719
  *
19690
19720
  * Child interfaces:
19691
19721
  *
@@ -19701,8 +19731,8 @@ declare namespace Office {
19701
19731
  * **Important**:
19702
19732
  *
19703
19733
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
19704
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19705
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
19734
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
19735
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
19706
19736
  *
19707
19737
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
19708
19738
  * For guidance on how to configure the Reading Pane, see
@@ -20147,10 +20177,7 @@ declare namespace Office {
20147
20177
  */
20148
20178
  addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
20149
20179
  /**
20150
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
20151
- *
20152
- * For supported events, refer to the Item object model
20153
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
20180
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
20154
20181
  *
20155
20182
  * @remarks
20156
20183
  * [Api set: Mailbox 1.7]
@@ -20159,6 +20186,8 @@ declare namespace Office {
20159
20186
  *
20160
20187
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20161
20188
  *
20189
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
20190
+ *
20162
20191
  * @param eventType - The event that should invoke the handler.
20163
20192
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
20164
20193
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -20169,10 +20198,7 @@ declare namespace Office {
20169
20198
  */
20170
20199
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20171
20200
  /**
20172
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
20173
- *
20174
- * For supported events, refer to the Item object model
20175
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
20201
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
20176
20202
  *
20177
20203
  * @remarks
20178
20204
  * [Api set: Mailbox 1.7]
@@ -20181,6 +20207,8 @@ declare namespace Office {
20181
20207
  *
20182
20208
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20183
20209
  *
20210
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
20211
+ *
20184
20212
  * @param eventType - The event that should invoke the handler.
20185
20213
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
20186
20214
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -21090,10 +21118,7 @@ declare namespace Office {
21090
21118
  */
21091
21119
  removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
21092
21120
  /**
21093
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
21094
- *
21095
- * For supported events, refer to the Item object model
21096
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
21121
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
21097
21122
  *
21098
21123
  * @remarks
21099
21124
  * [Api set: Mailbox 1.7]
@@ -21102,6 +21127,8 @@ declare namespace Office {
21102
21127
  *
21103
21128
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
21104
21129
  *
21130
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
21131
+ *
21105
21132
  * @param eventType - The event that should revoke the handler.
21106
21133
  * @param options - An object literal that contains one or more of the following properties:-
21107
21134
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -21110,10 +21137,7 @@ declare namespace Office {
21110
21137
  */
21111
21138
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
21112
21139
  /**
21113
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
21114
- *
21115
- * For supported events, refer to the Item object model
21116
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
21140
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
21117
21141
  *
21118
21142
  * @remarks
21119
21143
  * [Api set: Mailbox 1.7]
@@ -21122,6 +21146,8 @@ declare namespace Office {
21122
21146
  *
21123
21147
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
21124
21148
  *
21149
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
21150
+ *
21125
21151
  * @param eventType - The event that should revoke the handler.
21126
21152
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
21127
21153
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -21613,8 +21639,8 @@ declare namespace Office {
21613
21639
  * **Important**:
21614
21640
  *
21615
21641
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
21616
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
21617
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
21642
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
21643
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
21618
21644
  *
21619
21645
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
21620
21646
  * For guidance on how to configure the Reading Pane, see
@@ -22035,10 +22061,7 @@ declare namespace Office {
22035
22061
  */
22036
22062
  to: EmailAddressDetails[];
22037
22063
  /**
22038
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
22039
- *
22040
- * For supported events, refer to the Item object model
22041
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
22064
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
22042
22065
  *
22043
22066
  * @remarks
22044
22067
  * [Api set: Mailbox 1.7]
@@ -22047,6 +22070,8 @@ declare namespace Office {
22047
22070
  *
22048
22071
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22049
22072
  *
22073
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
22074
+ *
22050
22075
  * @param eventType - The event that should invoke the handler.
22051
22076
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
22052
22077
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -22057,10 +22082,7 @@ declare namespace Office {
22057
22082
  */
22058
22083
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
22059
22084
  /**
22060
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
22061
- *
22062
- * For supported events, refer to the Item object model
22063
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
22085
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
22064
22086
  *
22065
22087
  * @remarks
22066
22088
  * [Api set: Mailbox 1.7]
@@ -22069,6 +22091,8 @@ declare namespace Office {
22069
22091
  *
22070
22092
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22071
22093
  *
22094
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
22095
+ *
22072
22096
  * @param eventType - The event that should invoke the handler.
22073
22097
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
22074
22098
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -22694,10 +22718,7 @@ declare namespace Office {
22694
22718
  */
22695
22719
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
22696
22720
  /**
22697
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22698
- *
22699
- * For supported events, refer to the Item object model
22700
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
22721
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
22701
22722
  *
22702
22723
  * @remarks
22703
22724
  * [Api set: Mailbox 1.7]
@@ -22706,6 +22727,8 @@ declare namespace Office {
22706
22727
  *
22707
22728
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22708
22729
  *
22730
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
22731
+ *
22709
22732
  * @param eventType - The event that should revoke the handler.
22710
22733
  * @param options - An object literal that contains one or more of the following properties:-
22711
22734
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -22714,10 +22737,7 @@ declare namespace Office {
22714
22737
  */
22715
22738
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
22716
22739
  /**
22717
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22718
- *
22719
- * For supported events, refer to the Item object model
22720
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
22740
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
22721
22741
  *
22722
22742
  * @remarks
22723
22743
  * [Api set: Mailbox 1.7]
@@ -22726,6 +22746,8 @@ declare namespace Office {
22726
22746
  *
22727
22747
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22728
22748
  *
22749
+ * **Important**: For a list of events supported on a mail item, see {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model#events | Outlook Item object model}.
22750
+ *
22729
22751
  * @param eventType - The event that should revoke the handler.
22730
22752
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
22731
22753
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -24057,7 +24079,7 @@ declare namespace Office {
24057
24079
  *
24058
24080
  * @remarks
24059
24081
  *
24060
- * [Api set: Mailbox 1.1]
24082
+ * [Api set: Mailbox 1.2]
24061
24083
  *
24062
24084
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24063
24085
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.686",
3
+ "version": "1.0.687",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "e5fd2616557bfbf57c649c5db1382eef343781695212d3c2db2ca45ed85ccd5f",
49
+ "typesPublisherContentHash": "c0dc5a735033bc99f54e4f115285b9c86a1f3b07e9391062503e1d98b4ad8d92",
50
50
  "typeScriptVersion": "5.2",
51
51
  "nonNpm": true
52
52
  }