@types/office-js 1.0.574 → 1.0.575

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +123 -102
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
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
office-js/index.d.ts CHANGED
@@ -4738,10 +4738,17 @@ declare namespace Office {
4738
4738
  * - `item`: Provides methods and properties for accessing a message or appointment in an Outlook add-in.
4739
4739
  *
4740
4740
  * - `userProfile`: Provides information about the user in an Outlook add-in.
4741
+ *
4742
+ * 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}.
4741
4743
  */
4742
4744
  mailbox: Office.Mailbox;
4743
4745
  /**
4744
4746
  * Provides access to the properties for Office theme colors.
4747
+ *
4748
+ * @remarks
4749
+ *
4750
+ * **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}.
4751
+ * 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}.
4745
4752
  */
4746
4753
  officeTheme: OfficeTheme;
4747
4754
  /**
@@ -4780,6 +4787,8 @@ declare namespace Office {
4780
4787
  *
4781
4788
  * @remarks
4782
4789
  *
4790
+ * [Api set: Mailbox 1.1]
4791
+ *
4783
4792
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
4784
4793
  *
4785
4794
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -7614,7 +7623,7 @@ declare namespace Office {
7614
7623
  * </table>
7615
7624
  *
7616
7625
  * **Important**: In Outlook, the Office theme API is supported starting in
7617
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7626
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7618
7627
  * 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}.
7619
7628
  */
7620
7629
  interface OfficeTheme {
@@ -10826,8 +10835,8 @@ declare namespace Office {
10826
10835
  * The subclass of {@link Office.Item | Item} dealing with appointments.
10827
10836
  *
10828
10837
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10829
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10830
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
10838
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
10839
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
10831
10840
  *
10832
10841
  * Child interfaces:
10833
10842
  *
@@ -10841,8 +10850,8 @@ declare namespace Office {
10841
10850
  * The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}.
10842
10851
  *
10843
10852
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10844
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10845
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
10853
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
10854
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
10846
10855
  *
10847
10856
  * Parent interfaces:
10848
10857
  *
@@ -11303,10 +11312,7 @@ declare namespace Office {
11303
11312
  */
11304
11313
  addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
11305
11314
  /**
11306
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11307
- *
11308
- * For supported events, refer to the Item object model
11309
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
11315
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
11310
11316
  *
11311
11317
  * @remarks
11312
11318
  * [Api set: Mailbox 1.7]
@@ -11315,6 +11321,8 @@ declare namespace Office {
11315
11321
  *
11316
11322
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11317
11323
  *
11324
+ * **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}.
11325
+ *
11318
11326
  * @param eventType - The event that should invoke the handler.
11319
11327
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
11320
11328
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -11325,10 +11333,7 @@ declare namespace Office {
11325
11333
  */
11326
11334
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11327
11335
  /**
11328
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11329
- *
11330
- * For supported events, refer to the Item object model
11331
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
11336
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
11332
11337
  *
11333
11338
  * @remarks
11334
11339
  * [Api set: Mailbox 1.7]
@@ -11337,6 +11342,8 @@ declare namespace Office {
11337
11342
  *
11338
11343
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11339
11344
  *
11345
+ * **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}.
11346
+ *
11340
11347
  * @param eventType - The event that should invoke the handler.
11341
11348
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
11342
11349
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -11907,10 +11914,7 @@ declare namespace Office {
11907
11914
  */
11908
11915
  removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11909
11916
  /**
11910
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11911
- *
11912
- * For supported events, refer to the Item object model
11913
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
11917
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
11914
11918
  *
11915
11919
  * @remarks
11916
11920
  * [Api set: Mailbox 1.7]
@@ -11919,6 +11923,8 @@ declare namespace Office {
11919
11923
  *
11920
11924
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11921
11925
  *
11926
+ * **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}.
11927
+ *
11922
11928
  * @param eventType - The event that should revoke the handler.
11923
11929
  * @param options - An object literal that contains one or more of the following properties:-
11924
11930
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -11927,10 +11933,7 @@ declare namespace Office {
11927
11933
  */
11928
11934
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
11929
11935
  /**
11930
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11931
- *
11932
- * For supported events, refer to the Item object model
11933
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
11936
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
11934
11937
  *
11935
11938
  * @remarks
11936
11939
  * [Api set: Mailbox 1.7]
@@ -11939,6 +11942,8 @@ declare namespace Office {
11939
11942
  *
11940
11943
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11941
11944
  *
11945
+ * **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}.
11946
+ *
11942
11947
  * @param eventType - The event that should revoke the handler.
11943
11948
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11944
11949
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -12272,8 +12277,8 @@ declare namespace Office {
12272
12277
  * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
12273
12278
  *
12274
12279
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
12275
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
12276
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
12280
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
12281
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
12277
12282
  *
12278
12283
  * Parent interfaces:
12279
12284
  *
@@ -12609,10 +12614,7 @@ declare namespace Office {
12609
12614
  */
12610
12615
  sensitivity: MailboxEnums.AppointmentSensitivityType;
12611
12616
  /**
12612
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12613
- *
12614
- * For supported events, refer to the Item object model
12615
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
12617
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
12616
12618
  *
12617
12619
  * @remarks
12618
12620
  * [Api set: Mailbox 1.7]
@@ -12621,6 +12623,8 @@ declare namespace Office {
12621
12623
  *
12622
12624
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12623
12625
  *
12626
+ * **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}.
12627
+ *
12624
12628
  * @param eventType - The event that should invoke the handler.
12625
12629
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12626
12630
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -12631,10 +12635,7 @@ declare namespace Office {
12631
12635
  */
12632
12636
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12633
12637
  /**
12634
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12635
- *
12636
- * For supported events, refer to the Item object model
12637
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
12638
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
12638
12639
  *
12639
12640
  * @remarks
12640
12641
  * [Api set: Mailbox 1.7]
@@ -12643,6 +12644,8 @@ declare namespace Office {
12643
12644
  *
12644
12645
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12645
12646
  *
12647
+ * **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}.
12648
+ *
12646
12649
  * @param eventType - The event that should invoke the handler.
12647
12650
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12648
12651
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -13181,10 +13184,7 @@ declare namespace Office {
13181
13184
  */
13182
13185
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
13183
13186
  /**
13184
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13185
- *
13186
- * For supported events, refer to the Item object model
13187
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
13187
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
13188
13188
  *
13189
13189
  * @remarks
13190
13190
  * [Api set: Mailbox 1.7]
@@ -13193,6 +13193,8 @@ declare namespace Office {
13193
13193
  *
13194
13194
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13195
13195
  *
13196
+ * **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}.
13197
+ *
13196
13198
  * @param eventType - The event that should revoke the handler.
13197
13199
  * @param options - An object literal that contains one or more of the following properties:-
13198
13200
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13201,11 +13203,7 @@ declare namespace Office {
13201
13203
  */
13202
13204
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13203
13205
  /**
13204
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13205
- *
13206
- * For supported events, refer to the Item object model
13207
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
13208
- *
13206
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
13209
13207
  * @remarks
13210
13208
  * [Api set: Mailbox 1.7]
13211
13209
  *
@@ -13213,6 +13211,8 @@ declare namespace Office {
13213
13211
  *
13214
13212
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13215
13213
  *
13214
+ * **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}.
13215
+ *
13216
13216
  * @param eventType - The event that should revoke the handler.
13217
13217
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13218
13218
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -15728,9 +15728,6 @@ declare namespace Office {
15728
15728
  * The item namespace is used to access the currently selected message, meeting request, or appointment.
15729
15729
  * You can determine the type of the item by using the `itemType` property.
15730
15730
  *
15731
- * To see the full member list, refer to the
15732
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
15733
- *
15734
15731
  * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
15735
15732
  *
15736
15733
  * - {@link Office.AppointmentCompose | AppointmentCompose}
@@ -15753,8 +15750,8 @@ declare namespace Office {
15753
15750
  * The compose mode of {@link Office.Item | Office.context.mailbox.item}.
15754
15751
  *
15755
15752
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15756
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15757
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
15753
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
15754
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
15758
15755
  *
15759
15756
  * Child interfaces:
15760
15757
  *
@@ -15768,8 +15765,8 @@ declare namespace Office {
15768
15765
  * The read mode of {@link Office.Item | Office.context.mailbox.item}.
15769
15766
  *
15770
15767
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15771
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15772
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
15768
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
15769
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
15773
15770
  *
15774
15771
  * Child interfaces:
15775
15772
  *
@@ -17916,10 +17913,7 @@ declare namespace Office {
17916
17913
  userProfile: UserProfile;
17917
17914
 
17918
17915
  /**
17919
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
17920
- *
17921
- * For supported events, refer to the Mailbox object model
17922
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox#events | events section}.
17916
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
17923
17917
  *
17924
17918
  * @remarks
17925
17919
  * [Api set: Mailbox 1.5]
@@ -17928,6 +17922,17 @@ declare namespace Office {
17928
17922
  *
17929
17923
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
17930
17924
  *
17925
+ * **Important**: The following events are supported on the `Mailbox` object.
17926
+ *
17927
+ * <table>
17928
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
17929
+ * <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.
17930
+ * 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>
17931
+ * <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>
17932
+ * <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>
17933
+ * <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>
17934
+ * </table>
17935
+ *
17931
17936
  * @param eventType - The event that should invoke the handler.
17932
17937
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
17933
17938
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -17937,10 +17942,7 @@ declare namespace Office {
17937
17942
  */
17938
17943
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
17939
17944
  /**
17940
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
17941
- *
17942
- * For supported events, refer to the Mailbox object model
17943
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox#events | events section}.
17945
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
17944
17946
  *
17945
17947
  * @remarks
17946
17948
  * [Api set: Mailbox 1.5]
@@ -17949,6 +17951,17 @@ declare namespace Office {
17949
17951
  *
17950
17952
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
17951
17953
  *
17954
+ * **Important**: The following events are supported on the `Mailbox` object.
17955
+ *
17956
+ * <table>
17957
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
17958
+ * <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.
17959
+ * 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>
17960
+ * <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>
17961
+ * <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>
17962
+ * <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>
17963
+ * </table>
17964
+ *
17952
17965
  * @param eventType - The event that should invoke the handler.
17953
17966
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
17954
17967
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -18825,10 +18838,7 @@ declare namespace Office {
18825
18838
  */
18826
18839
  makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
18827
18840
  /**
18828
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
18829
- *
18830
- * For supported events, refer to the Mailbox object model
18831
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox#events | events section}.
18841
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
18832
18842
  *
18833
18843
  * @remarks
18834
18844
  * [Api set: Mailbox 1.5]
@@ -18837,6 +18847,17 @@ declare namespace Office {
18837
18847
  *
18838
18848
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18839
18849
  *
18850
+ * **Important**: The following events are supported on the `Mailbox` object.
18851
+ *
18852
+ * <table>
18853
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
18854
+ * <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.
18855
+ * 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>
18856
+ * <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>
18857
+ * <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>
18858
+ * <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>
18859
+ * </table>
18860
+ *
18840
18861
  * @param eventType - The event that should revoke the handler.
18841
18862
  * @param options - Provides an option for preserving context data of any type, unchanged, for use in a callback.
18842
18863
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -18844,10 +18865,7 @@ declare namespace Office {
18844
18865
  */
18845
18866
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18846
18867
  /**
18847
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
18848
- *
18849
- * For supported events, refer to the Mailbox object model
18850
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox#events | events section}.
18868
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
18851
18869
  *
18852
18870
  * @remarks
18853
18871
  * [Api set: Mailbox 1.5]
@@ -18856,6 +18874,17 @@ declare namespace Office {
18856
18874
  *
18857
18875
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18858
18876
  *
18877
+ * **Important**: The following events are supported on the `Mailbox` object.
18878
+ *
18879
+ * <table>
18880
+ * <tr><th>Event</th><th>Description</th><th>Minimum requirement set</th></tr>
18881
+ * <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.
18882
+ * 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>
18883
+ * <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>
18884
+ * <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>
18885
+ * <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>
18886
+ * </table>
18887
+ *
18859
18888
  * @param eventType - The event that should revoke the handler.
18860
18889
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
18861
18890
  * type `Office.AsyncResult`.
@@ -19132,8 +19161,8 @@ declare namespace Office {
19132
19161
  * A subclass of {@link Office.Item | Item} for messages.
19133
19162
  *
19134
19163
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
19135
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19136
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
19164
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
19165
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
19137
19166
  *
19138
19167
  * Child interfaces:
19139
19168
  *
@@ -19149,8 +19178,8 @@ declare namespace Office {
19149
19178
  * **Important**:
19150
19179
  *
19151
19180
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
19152
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19153
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
19181
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
19182
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
19154
19183
  *
19155
19184
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
19156
19185
  * For guidance on how to configure the Reading Pane, see
@@ -19596,10 +19625,7 @@ declare namespace Office {
19596
19625
  */
19597
19626
  addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
19598
19627
  /**
19599
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
19600
- *
19601
- * For supported events, refer to the Item object model
19602
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
19628
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
19603
19629
  *
19604
19630
  * @remarks
19605
19631
  * [Api set: Mailbox 1.7]
@@ -19608,6 +19634,8 @@ declare namespace Office {
19608
19634
  *
19609
19635
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19610
19636
  *
19637
+ * **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}.
19638
+ *
19611
19639
  * @param eventType - The event that should invoke the handler.
19612
19640
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
19613
19641
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -19618,10 +19646,7 @@ declare namespace Office {
19618
19646
  */
19619
19647
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
19620
19648
  /**
19621
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
19622
- *
19623
- * For supported events, refer to the Item object model
19624
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
19649
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
19625
19650
  *
19626
19651
  * @remarks
19627
19652
  * [Api set: Mailbox 1.7]
@@ -19630,6 +19655,8 @@ declare namespace Office {
19630
19655
  *
19631
19656
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19632
19657
  *
19658
+ * **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}.
19659
+ *
19633
19660
  * @param eventType - The event that should invoke the handler.
19634
19661
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
19635
19662
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -20539,10 +20566,7 @@ declare namespace Office {
20539
20566
  */
20540
20567
  removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20541
20568
  /**
20542
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
20543
- *
20544
- * For supported events, refer to the Item object model
20545
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
20569
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
20546
20570
  *
20547
20571
  * @remarks
20548
20572
  * [Api set: Mailbox 1.7]
@@ -20551,6 +20575,8 @@ declare namespace Office {
20551
20575
  *
20552
20576
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20553
20577
  *
20578
+ * **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}.
20579
+ *
20554
20580
  * @param eventType - The event that should revoke the handler.
20555
20581
  * @param options - An object literal that contains one or more of the following properties:-
20556
20582
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -20559,10 +20585,7 @@ declare namespace Office {
20559
20585
  */
20560
20586
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20561
20587
  /**
20562
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
20563
- *
20564
- * For supported events, refer to the Item object model
20565
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
20588
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
20566
20589
  *
20567
20590
  * @remarks
20568
20591
  * [Api set: Mailbox 1.7]
@@ -20571,6 +20594,8 @@ declare namespace Office {
20571
20594
  *
20572
20595
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20573
20596
  *
20597
+ * **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}.
20598
+ *
20574
20599
  * @param eventType - The event that should revoke the handler.
20575
20600
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
20576
20601
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -20969,8 +20994,8 @@ declare namespace Office {
20969
20994
  * **Important**:
20970
20995
  *
20971
20996
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
20972
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
20973
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
20997
+ * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to
20998
+ * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-item-object-model | Outlook Item object model}.
20974
20999
  *
20975
21000
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
20976
21001
  * For guidance on how to configure the Reading Pane, see
@@ -21375,10 +21400,7 @@ declare namespace Office {
21375
21400
  */
21376
21401
  to: EmailAddressDetails[];
21377
21402
  /**
21378
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
21379
- *
21380
- * For supported events, refer to the Item object model
21381
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
21403
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
21382
21404
  *
21383
21405
  * @remarks
21384
21406
  * [Api set: Mailbox 1.7]
@@ -21387,6 +21409,8 @@ declare namespace Office {
21387
21409
  *
21388
21410
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
21389
21411
  *
21412
+ * **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}.
21413
+ *
21390
21414
  * @param eventType - The event that should invoke the handler.
21391
21415
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
21392
21416
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -21397,10 +21421,7 @@ declare namespace Office {
21397
21421
  */
21398
21422
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
21399
21423
  /**
21400
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
21401
- *
21402
- * For supported events, refer to the Item object model
21403
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
21424
+ * Adds an event handler for a supported event. Events are only available in task pane add-ins.
21404
21425
  *
21405
21426
  * @remarks
21406
21427
  * [Api set: Mailbox 1.7]
@@ -21409,6 +21430,8 @@ declare namespace Office {
21409
21430
  *
21410
21431
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
21411
21432
  *
21433
+ * **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}.
21434
+ *
21412
21435
  * @param eventType - The event that should invoke the handler.
21413
21436
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
21414
21437
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -22034,10 +22057,7 @@ declare namespace Office {
22034
22057
  */
22035
22058
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
22036
22059
  /**
22037
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22038
- *
22039
- * For supported events, refer to the Item object model
22040
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
22060
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
22041
22061
  *
22042
22062
  * @remarks
22043
22063
  * [Api set: Mailbox 1.7]
@@ -22046,6 +22066,8 @@ declare namespace Office {
22046
22066
  *
22047
22067
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22048
22068
  *
22069
+ * **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}.
22070
+ *
22049
22071
  * @param eventType - The event that should revoke the handler.
22050
22072
  * @param options - An object literal that contains one or more of the following properties:-
22051
22073
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -22054,10 +22076,7 @@ declare namespace Office {
22054
22076
  */
22055
22077
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
22056
22078
  /**
22057
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22058
- *
22059
- * For supported events, refer to the Item object model
22060
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
22079
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
22061
22080
  *
22062
22081
  * @remarks
22063
22082
  * [Api set: Mailbox 1.7]
@@ -22066,6 +22085,8 @@ declare namespace Office {
22066
22085
  *
22067
22086
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22068
22087
  *
22088
+ * **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}.
22089
+ *
22069
22090
  * @param eventType - The event that should revoke the handler.
22070
22091
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
22071
22092
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -23288,7 +23309,7 @@ declare namespace Office {
23288
23309
  *
23289
23310
  * @remarks
23290
23311
  *
23291
- * [Api set: Mailbox 1.1]
23312
+ * [Api set: Mailbox 1.2]
23292
23313
  *
23293
23314
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23294
23315
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.574",
3
+ "version": "1.0.575",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "d62efe8dd5ce859af944eaa5768d6a5611ea5110069636de620edb245354c439",
49
+ "typesPublisherContentHash": "79824ebc6d1a1c3a83ddae29d0d6aa8a874ab1fa58043c82c7745e65857c44b6",
50
50
  "typeScriptVersion": "5.2"
51
51
  }