@types/office-js 1.0.573 → 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 +439 -306
  3. office-js/package.json +2 -2
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.
@@ -12160,183 +12165,120 @@ declare namespace Office {
12160
12165
  setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12161
12166
  }
12162
12167
  /**
12163
- * The `AppointmentForm` object is used to access the currently selected appointment.
12168
+ * Represents the details of the form for creating a new appointment.
12164
12169
  *
12165
12170
  * @remarks
12166
12171
  *
12167
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
12172
+ * [Api set: Mailbox 1.1]
12168
12173
  *
12169
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12174
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12175
+ *
12176
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12170
12177
  */
12171
12178
  interface AppointmentForm {
12172
12179
  /**
12173
- * Gets an object that provides methods for manipulating the body of an item.
12180
+ * Sets the body of the appointment.
12174
12181
  *
12175
12182
  * @remarks
12183
+ *
12176
12184
  * [Api set: Mailbox 1.1]
12177
12185
  *
12178
12186
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12179
12187
  *
12180
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12188
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12181
12189
  */
12182
- body: Body | string;
12190
+ body?: string;
12183
12191
  /**
12184
- * Gets or sets the date and time that the appointment is to end.
12185
- *
12186
- * The `end` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method to
12187
- * convert the `end` property value to the client's local date and time.
12188
- *
12189
- * *Read mode*
12190
- *
12191
- * The `end` property returns a `Date` object.
12192
- *
12193
- * *Compose mode*
12194
- *
12195
- * The `end` property returns a `Time` object.
12196
- *
12197
- * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on
12198
- * the client to UTC for the server.
12192
+ * Sets the date and time that the appointment is to end.
12199
12193
  *
12200
12194
  * @remarks
12201
12195
  *
12196
+ * [Api set: Mailbox 1.1]
12197
+ *
12202
12198
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12203
12199
  *
12204
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12200
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12205
12201
  */
12206
- end: Time | Date;
12202
+ end?: Date | number;
12207
12203
  /**
12208
- * Gets or sets the location of an appointment.
12209
- *
12210
- * *Read mode*
12211
- *
12212
- * The `location` property returns a string that contains the location of the appointment.
12213
- *
12214
- * *Compose mode*
12215
- *
12216
- * The `location` property returns a `Location` object that provides methods that are used to get and set the location of the appointment.
12204
+ * Sets the location of the appointment.
12217
12205
  *
12218
12206
  * @remarks
12219
12207
  *
12208
+ * [Api set: Mailbox 1.1]
12209
+ *
12220
12210
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12221
12211
  *
12222
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12212
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12223
12213
  */
12224
- location: Location | string;
12214
+ location?: string;
12225
12215
  /**
12226
- * Provides access to the optional attendees of an event. The type of object and level of access depend on the mode of the current item.
12227
- *
12228
- * *Read mode*
12229
- *
12230
- * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
12231
- * each optional attendee to the meeting. Collection size limits:
12232
- *
12233
- * - Web browser, new Mac UI, Android: No limit
12234
- *
12235
- * - Windows: 500 members
12236
- *
12237
- * - Classic Mac UI: 100 members
12238
- *
12239
- * *Compose mode*
12240
- *
12241
- * The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the
12242
- * optional attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on how many
12243
- * recipients you can get or update. See the {@link Office.Recipients | Recipients} object for more details.
12216
+ * Sets the optional attendees of the appointment.
12244
12217
  *
12245
12218
  * @remarks
12246
12219
  *
12220
+ * [Api set: Mailbox 1.1]
12221
+ *
12247
12222
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12248
12223
  *
12249
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12224
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12250
12225
  */
12251
- optionalAttendees: Recipients[] | EmailAddressDetails[];
12226
+ optionalAttendees?: string[] | EmailAddressDetails[];
12252
12227
  /**
12253
- * Provides access to the resources of an event. Returns an array of strings containing the resources required for the appointment.
12228
+ * Sets the resources of the appointment.
12254
12229
  *
12255
12230
  * @remarks
12256
12231
  *
12232
+ * [Api set: Mailbox 1.1]
12233
+ *
12257
12234
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12258
12235
  *
12259
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12236
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12260
12237
  */
12261
- resources: string[];
12238
+ resources?: string[];
12262
12239
  /**
12263
- * Provides access to the required attendees of an event. The type of object and level of access depend on the mode of the current item.
12264
- *
12265
- * *Read mode*
12266
- *
12267
- * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
12268
- * each required attendee to the meeting. Collection size limits:
12269
- *
12270
- * - Web browser, new Mac UI, Android: No limit
12271
- *
12272
- * - Windows: 500 members
12273
- *
12274
- * - Classic Mac UI: 100 members
12275
- *
12276
- * *Compose mode*
12277
- *
12278
- * The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the
12279
- * required attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on how many
12280
- * recipients you can get or update. See the {@link Office.Recipients | Recipients} object for more details.
12240
+ * Sets the required attendees of the appointment.
12281
12241
  *
12282
12242
  * @remarks
12283
12243
  *
12244
+ * [Api set: Mailbox 1.1]
12245
+ *
12284
12246
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12285
12247
  *
12286
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12248
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12287
12249
  */
12288
- requiredAttendees: Recipients[] | EmailAddressDetails[];
12250
+ requiredAttendees?: string[] | EmailAddressDetails[];
12289
12251
  /**
12290
- * Gets or sets the date and time that the appointment is to begin.
12291
- *
12292
- * The `start` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method
12293
- * to convert the value to the client's local date and time.
12294
- *
12295
- * *Read mode*
12296
- *
12297
- * The `start` property returns a `Date` object.
12298
- *
12299
- * *Compose mode*
12300
- *
12301
- * The `start` property returns a `Time` object.
12302
- *
12303
- * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on
12304
- * the client to UTC for the server.
12252
+ * Sets the date and time that the appointment is to begin.
12305
12253
  *
12306
12254
  * @remarks
12307
12255
  *
12256
+ * [Api set: Mailbox 1.1]
12257
+ *
12308
12258
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12309
12259
  *
12310
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12260
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12311
12261
  */
12312
- start: Time | Date;
12262
+ start?: Date | number;
12313
12263
  /**
12314
- * Gets or sets the description that appears in the subject field of an item.
12315
- *
12316
- * The `subject` property gets or sets the entire subject of the item, as sent by the email server.
12317
- *
12318
- * *Read mode*
12319
- *
12320
- * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:.
12321
- *
12322
- * *Compose mode*
12323
- *
12324
- * The `subject` property returns a `Subject` object that provides methods to get and set the subject.
12264
+ * Sets the description that appears in the Title field of the appointment.
12325
12265
  *
12326
12266
  * @remarks
12327
12267
  *
12268
+ * [Api set: Mailbox 1.1]
12269
+ *
12328
12270
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12329
12271
  *
12330
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12272
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12331
12273
  */
12332
- subject: Subject | string;
12274
+ subject?: string;
12333
12275
  }
12334
12276
  /**
12335
12277
  * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
12336
12278
  *
12337
12279
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
12338
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
12339
- * {@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}.
12340
12282
  *
12341
12283
  * Parent interfaces:
12342
12284
  *
@@ -12672,10 +12614,7 @@ declare namespace Office {
12672
12614
  */
12673
12615
  sensitivity: MailboxEnums.AppointmentSensitivityType;
12674
12616
  /**
12675
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12676
- *
12677
- * For supported events, refer to the Item object model
12678
- * {@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.
12679
12618
  *
12680
12619
  * @remarks
12681
12620
  * [Api set: Mailbox 1.7]
@@ -12684,6 +12623,8 @@ declare namespace Office {
12684
12623
  *
12685
12624
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12686
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
+ *
12687
12628
  * @param eventType - The event that should invoke the handler.
12688
12629
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12689
12630
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -12694,10 +12635,7 @@ declare namespace Office {
12694
12635
  */
12695
12636
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12696
12637
  /**
12697
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
12698
- *
12699
- * For supported events, refer to the Item object model
12700
- * {@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.
12701
12639
  *
12702
12640
  * @remarks
12703
12641
  * [Api set: Mailbox 1.7]
@@ -12706,6 +12644,8 @@ declare namespace Office {
12706
12644
  *
12707
12645
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12708
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
+ *
12709
12649
  * @param eventType - The event that should invoke the handler.
12710
12650
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
12711
12651
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -13244,10 +13184,7 @@ declare namespace Office {
13244
13184
  */
13245
13185
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
13246
13186
  /**
13247
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13248
- *
13249
- * For supported events, refer to the Item object model
13250
- * {@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.
13251
13188
  *
13252
13189
  * @remarks
13253
13190
  * [Api set: Mailbox 1.7]
@@ -13256,6 +13193,8 @@ declare namespace Office {
13256
13193
  *
13257
13194
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13258
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
+ *
13259
13198
  * @param eventType - The event that should revoke the handler.
13260
13199
  * @param options - An object literal that contains one or more of the following properties:-
13261
13200
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13264,11 +13203,7 @@ declare namespace Office {
13264
13203
  */
13265
13204
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13266
13205
  /**
13267
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
13268
- *
13269
- * For supported events, refer to the Item object model
13270
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item#events | events section}.
13271
- *
13206
+ * Removes the event handlers for a supported event type. Events are only available in task pane add-ins.
13272
13207
  * @remarks
13273
13208
  * [Api set: Mailbox 1.7]
13274
13209
  *
@@ -13276,6 +13211,8 @@ declare namespace Office {
13276
13211
  *
13277
13212
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
13278
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
+ *
13279
13216
  * @param eventType - The event that should revoke the handler.
13280
13217
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13281
13218
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -15791,9 +15728,6 @@ declare namespace Office {
15791
15728
  * The item namespace is used to access the currently selected message, meeting request, or appointment.
15792
15729
  * You can determine the type of the item by using the `itemType` property.
15793
15730
  *
15794
- * To see the full member list, refer to the
15795
- * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item | Object Model} page.
15796
- *
15797
15731
  * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
15798
15732
  *
15799
15733
  * - {@link Office.AppointmentCompose | AppointmentCompose}
@@ -15816,8 +15750,8 @@ declare namespace Office {
15816
15750
  * The compose mode of {@link Office.Item | Office.context.mailbox.item}.
15817
15751
  *
15818
15752
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15819
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15820
- * {@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}.
15821
15755
  *
15822
15756
  * Child interfaces:
15823
15757
  *
@@ -15831,8 +15765,8 @@ declare namespace Office {
15831
15765
  * The read mode of {@link Office.Item | Office.context.mailbox.item}.
15832
15766
  *
15833
15767
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15834
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15835
- * {@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}.
15836
15770
  *
15837
15771
  * Child interfaces:
15838
15772
  *
@@ -17979,10 +17913,7 @@ declare namespace Office {
17979
17913
  userProfile: UserProfile;
17980
17914
 
17981
17915
  /**
17982
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
17983
- *
17984
- * For supported events, refer to the Mailbox object model
17985
- * {@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.
17986
17917
  *
17987
17918
  * @remarks
17988
17919
  * [Api set: Mailbox 1.5]
@@ -17991,6 +17922,17 @@ declare namespace Office {
17991
17922
  *
17992
17923
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
17993
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
+ *
17994
17936
  * @param eventType - The event that should invoke the handler.
17995
17937
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
17996
17938
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -18000,10 +17942,7 @@ declare namespace Office {
18000
17942
  */
18001
17943
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18002
17944
  /**
18003
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
18004
- *
18005
- * For supported events, refer to the Mailbox object model
18006
- * {@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.
18007
17946
  *
18008
17947
  * @remarks
18009
17948
  * [Api set: Mailbox 1.5]
@@ -18012,6 +17951,17 @@ declare namespace Office {
18012
17951
  *
18013
17952
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18014
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
+ *
18015
17965
  * @param eventType - The event that should invoke the handler.
18016
17966
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
18017
17967
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -18398,39 +18348,9 @@ declare namespace Office {
18398
18348
  *
18399
18349
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18400
18350
  *
18401
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
18402
- *
18403
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18404
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
18405
- *
18406
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18407
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
18408
- *
18409
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18410
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
18411
- *
18412
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
18413
- *
18414
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
18415
- *
18416
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
18417
- *
18418
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
18419
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
18420
- *
18421
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
18422
- *
18423
- * `attachments.url`: Only used if the attachment type is set to `file`. The URI of the location for the file. **Important**: This link must be
18424
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
18425
- * be accessible on a private network as long as it doesn't need further authentication.
18426
- *
18427
- * `attachments.isInline`: Only used if the attachment type is set to `file`. If true, indicates that the attachment will be shown inline as an image
18428
- * in the message body and won't be displayed in the attachment list.
18429
- *
18430
- * `attachments.itemId`: Only used if the attachment type is set to `item`. The EWS item ID of the existing e-mail you want to attach to the new message.
18431
- * This is a string up to 100 characters.
18351
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18432
18352
  */
18433
- displayNewMessageForm(parameters: any): void;
18353
+ displayNewMessageForm(parameters: MessageForm): void;
18434
18354
  /**
18435
18355
  * Displays a form for creating a new message.
18436
18356
  *
@@ -18446,43 +18366,13 @@ declare namespace Office {
18446
18366
  *
18447
18367
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18448
18368
  *
18449
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
18450
- *
18451
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18452
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
18453
- *
18454
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18455
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
18456
- *
18457
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18458
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
18459
- *
18460
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
18461
- *
18462
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
18463
- *
18464
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
18465
- *
18466
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
18467
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
18468
- *
18469
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
18470
- *
18471
- * `attachments.url`: Only used if the attachment type is set to `file`. The URI of the location for the file. **Important**: This link must be
18472
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
18473
- * be accessible on a private network as long as it doesn't need further authentication.
18474
- *
18475
- * `attachments.isInline`: Only used if the attachment type is set to `file`. If true, indicates that the attachment will be shown inline as an image
18476
- * in the message body and won't be displayed in the attachment list.
18477
- *
18478
- * `attachments.itemId`: Only used if the attachment type is set to `item`. The EWS item ID of the existing e-mail you want to attach to the new message.
18479
- * This is a string up to 100 characters.
18369
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18480
18370
  * @param options - An object literal that contains one or more of the following properties:-
18481
18371
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18482
18372
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18483
18373
  * `asyncResult`, which is an `Office.AsyncResult` object.
18484
18374
  */
18485
- displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18375
+ displayNewMessageFormAsync(parameters: MessageForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18486
18376
  /**
18487
18377
  * Displays a form for creating a new message.
18488
18378
  *
@@ -18498,41 +18388,11 @@ declare namespace Office {
18498
18388
  *
18499
18389
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18500
18390
  *
18501
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
18502
- *
18503
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18504
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
18505
- *
18506
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18507
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
18508
- *
18509
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18510
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
18511
- *
18512
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
18513
- *
18514
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
18515
- *
18516
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
18517
- *
18518
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
18519
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
18520
- *
18521
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
18522
- *
18523
- * `attachments.url`: Only used if the attachment type is set to `file`. The URI of the location for the file. **Important**: This link must be
18524
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
18525
- * be accessible on a private network as long as it doesn't need further authentication.
18526
- *
18527
- * `attachments.isInline`: Only used if the attachment type is set to `file`. If true, indicates that the attachment will be shown inline as an image
18528
- * in the message body and won't be displayed in the attachment list.
18529
- *
18530
- * `attachments.itemId`: Only used if the attachment type is set to `item`. The EWS item ID of the existing e-mail you want to attach to the new message.
18531
- * This is a string up to 100 characters.
18391
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18532
18392
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18533
18393
  * `asyncResult`, which is an `Office.AsyncResult` object.
18534
18394
  */
18535
- displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18395
+ displayNewMessageFormAsync(parameters: MessageForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18536
18396
  /**
18537
18397
  * Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).
18538
18398
  *
@@ -18978,10 +18838,7 @@ declare namespace Office {
18978
18838
  */
18979
18839
  makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
18980
18840
  /**
18981
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
18982
- *
18983
- * For supported events, refer to the Mailbox object model
18984
- * {@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.
18985
18842
  *
18986
18843
  * @remarks
18987
18844
  * [Api set: Mailbox 1.5]
@@ -18990,6 +18847,17 @@ declare namespace Office {
18990
18847
  *
18991
18848
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
18992
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
+ *
18993
18861
  * @param eventType - The event that should revoke the handler.
18994
18862
  * @param options - Provides an option for preserving context data of any type, unchanged, for use in a callback.
18995
18863
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -18997,10 +18865,7 @@ declare namespace Office {
18997
18865
  */
18998
18866
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18999
18867
  /**
19000
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
19001
- *
19002
- * For supported events, refer to the Mailbox object model
19003
- * {@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.
19004
18869
  *
19005
18870
  * @remarks
19006
18871
  * [Api set: Mailbox 1.5]
@@ -19009,6 +18874,17 @@ declare namespace Office {
19009
18874
  *
19010
18875
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
19011
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
+ *
19012
18888
  * @param eventType - The event that should revoke the handler.
19013
18889
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
19014
18890
  * type `Office.AsyncResult`.
@@ -19285,8 +19161,8 @@ declare namespace Office {
19285
19161
  * A subclass of {@link Office.Item | Item} for messages.
19286
19162
  *
19287
19163
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
19288
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19289
- * {@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}.
19290
19166
  *
19291
19167
  * Child interfaces:
19292
19168
  *
@@ -19302,8 +19178,8 @@ declare namespace Office {
19302
19178
  * **Important**:
19303
19179
  *
19304
19180
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
19305
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
19306
- * {@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}.
19307
19183
  *
19308
19184
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
19309
19185
  * For guidance on how to configure the Reading Pane, see
@@ -19749,10 +19625,7 @@ declare namespace Office {
19749
19625
  */
19750
19626
  addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
19751
19627
  /**
19752
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
19753
- *
19754
- * For supported events, refer to the Item object model
19755
- * {@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.
19756
19629
  *
19757
19630
  * @remarks
19758
19631
  * [Api set: Mailbox 1.7]
@@ -19761,6 +19634,8 @@ declare namespace Office {
19761
19634
  *
19762
19635
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19763
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
+ *
19764
19639
  * @param eventType - The event that should invoke the handler.
19765
19640
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
19766
19641
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -19771,10 +19646,7 @@ declare namespace Office {
19771
19646
  */
19772
19647
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
19773
19648
  /**
19774
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
19775
- *
19776
- * For supported events, refer to the Item object model
19777
- * {@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.
19778
19650
  *
19779
19651
  * @remarks
19780
19652
  * [Api set: Mailbox 1.7]
@@ -19783,6 +19655,8 @@ declare namespace Office {
19783
19655
  *
19784
19656
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19785
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
+ *
19786
19660
  * @param eventType - The event that should invoke the handler.
19787
19661
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
19788
19662
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
@@ -20692,10 +20566,7 @@ declare namespace Office {
20692
20566
  */
20693
20567
  removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20694
20568
  /**
20695
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
20696
- *
20697
- * For supported events, refer to the Item object model
20698
- * {@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.
20699
20570
  *
20700
20571
  * @remarks
20701
20572
  * [Api set: Mailbox 1.7]
@@ -20704,6 +20575,8 @@ declare namespace Office {
20704
20575
  *
20705
20576
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20706
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
+ *
20707
20580
  * @param eventType - The event that should revoke the handler.
20708
20581
  * @param options - An object literal that contains one or more of the following properties:-
20709
20582
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -20712,10 +20585,7 @@ declare namespace Office {
20712
20585
  */
20713
20586
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20714
20587
  /**
20715
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
20716
- *
20717
- * For supported events, refer to the Item object model
20718
- * {@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.
20719
20589
  *
20720
20590
  * @remarks
20721
20591
  * [Api set: Mailbox 1.7]
@@ -20724,6 +20594,8 @@ declare namespace Office {
20724
20594
  *
20725
20595
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
20726
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
+ *
20727
20599
  * @param eventType - The event that should revoke the handler.
20728
20600
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
20729
20601
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -20940,14 +20812,190 @@ declare namespace Office {
20940
20812
  */
20941
20813
  setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20942
20814
  }
20815
+ /**
20816
+ * Represents the details of the form for composing a new message.
20817
+ *
20818
+ * @remarks
20819
+ *
20820
+ * [Api set: Mailbox 1.6]
20821
+ *
20822
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20823
+ *
20824
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20825
+ */
20826
+ interface MessageForm {
20827
+ /**
20828
+ * Sets the attachments of the message. An attachment must be a file attachment (`Office.MailboxEnums.AttachmentType.File`) or an Outlook item attachment
20829
+ * (`Office.MailboxEnums.AttachmentType.Item`).
20830
+ *
20831
+ * @remarks
20832
+ *
20833
+ * [Api set: Mailbox 1.6]
20834
+ *
20835
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20836
+ *
20837
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20838
+ */
20839
+ attachments?: MessageFormAttachment[];
20840
+ /**
20841
+ * Sets the recipients in the Bcc field of the message.
20842
+ *
20843
+ * @remarks
20844
+ *
20845
+ * [Api set: Mailbox 1.6]
20846
+ *
20847
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20848
+ *
20849
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20850
+ *
20851
+ * **Important**: The `bccRecipients` array is limited to a maximum of 100 recipients.
20852
+ */
20853
+ bccRecipients?: string[] | EmailAddressDetails[];
20854
+ /**
20855
+ * Sets the recipients in the Cc field of the message.
20856
+ *
20857
+ * @remarks
20858
+ *
20859
+ * [Api set: Mailbox 1.6]
20860
+ *
20861
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20862
+ *
20863
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20864
+ *
20865
+ * **Important**: The `ccRecipients` array is limited to a maximum of 100 recipients.
20866
+ */
20867
+ ccRecipients?: string[] | EmailAddressDetails[];
20868
+ /**
20869
+ * Sets the body of the message.
20870
+ *
20871
+ * @remarks
20872
+ *
20873
+ * [Api set: Mailbox 1.6]
20874
+ *
20875
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20876
+ *
20877
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20878
+ *
20879
+ * **Important**: The body content is limited to a maximum size of 32 KB.
20880
+ */
20881
+ htmlBody?: string;
20882
+ /**
20883
+ * Sets the subject of the message.
20884
+ *
20885
+ * @remarks
20886
+ *
20887
+ * [Api set: Mailbox 1.6]
20888
+ *
20889
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20890
+ *
20891
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20892
+ *
20893
+ * **Important**: The subject is limited to a maximum of 255 characters.
20894
+ */
20895
+ subject?: string;
20896
+ /**
20897
+ * Sets the recipients in the To field of the message.
20898
+ *
20899
+ * @remarks
20900
+ *
20901
+ * [Api set: Mailbox 1.6]
20902
+ *
20903
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20904
+ *
20905
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20906
+ *
20907
+ * **Important**: The `toRecipients` array is limited to a maximum of 100 recipients.
20908
+ */
20909
+ toRecipients?: string[] | EmailAddressDetails[];
20910
+ }
20911
+ /**
20912
+ * A file or Outlook item attachment. Used when displaying a new message form.
20913
+ *
20914
+ * @remarks
20915
+ *
20916
+ * [Api set: Mailbox 1.6]
20917
+ *
20918
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20919
+ *
20920
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20921
+ */
20922
+ interface MessageFormAttachment {
20923
+ /**
20924
+ * The type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` or `Office.MailboxEnums.AttachmentType.Item`.
20925
+ *
20926
+ * @remarks
20927
+ *
20928
+ * [Api set: Mailbox 1.6]
20929
+ *
20930
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20931
+ *
20932
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20933
+ *
20934
+ * **Important**: The `base64` and `cloud` attachment types aren't supported.
20935
+ */
20936
+ type: MailboxEnums.AttachmentType | string;
20937
+ /**
20938
+ * The name of the attachment. The name can be up to 255 characters in length.
20939
+ *
20940
+ * @remarks
20941
+ *
20942
+ * [Api set: Mailbox 1.6]
20943
+ *
20944
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20945
+ *
20946
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20947
+ */
20948
+ name: string;
20949
+ /**
20950
+ * The URI of the location for the file. Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
20951
+ *
20952
+ * @remarks
20953
+ *
20954
+ * [Api set: Mailbox 1.6]
20955
+ *
20956
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20957
+ *
20958
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20959
+ *
20960
+ * **Important**: The link must be publicly accessible without need for authentication by Exchange Online servers. However, with
20961
+ * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
20962
+ */
20963
+ url?: string;
20964
+ /**
20965
+ * If true, indicates that the attachment will be shown inline in the message body and won't be displayed in the attachment list.
20966
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
20967
+ *
20968
+ * @remarks
20969
+ *
20970
+ * [Api set: Mailbox 1.6]
20971
+ *
20972
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20973
+ *
20974
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20975
+ */
20976
+ isInline?: boolean;
20977
+ /**
20978
+ * The Exchange Web Services (EWS) item ID of the attachment. The item ID is a string of up to 100 characters.
20979
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.Item`.
20980
+ *
20981
+ * @remarks
20982
+ *
20983
+ * [Api set: Mailbox 1.6]
20984
+ *
20985
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20986
+ *
20987
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20988
+ */
20989
+ itemId?: string;
20990
+ }
20943
20991
  /**
20944
20992
  * The message read mode of {@link Office.Item | Office.context.mailbox.item}.
20945
20993
  *
20946
20994
  * **Important**:
20947
20995
  *
20948
20996
  * - This is an internal Outlook object, not directly exposed through existing interfaces.
20949
- * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
20950
- * {@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}.
20951
20999
  *
20952
21000
  * - When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on.
20953
21001
  * For guidance on how to configure the Reading Pane, see
@@ -21352,10 +21400,7 @@ declare namespace Office {
21352
21400
  */
21353
21401
  to: EmailAddressDetails[];
21354
21402
  /**
21355
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
21356
- *
21357
- * For supported events, refer to the Item object model
21358
- * {@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.
21359
21404
  *
21360
21405
  * @remarks
21361
21406
  * [Api set: Mailbox 1.7]
@@ -21364,6 +21409,8 @@ declare namespace Office {
21364
21409
  *
21365
21410
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
21366
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
+ *
21367
21414
  * @param eventType - The event that should invoke the handler.
21368
21415
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
21369
21416
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -21374,10 +21421,7 @@ declare namespace Office {
21374
21421
  */
21375
21422
  addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
21376
21423
  /**
21377
- * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
21378
- *
21379
- * For supported events, refer to the Item object model
21380
- * {@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.
21381
21425
  *
21382
21426
  * @remarks
21383
21427
  * [Api set: Mailbox 1.7]
@@ -21386,6 +21430,8 @@ declare namespace Office {
21386
21430
  *
21387
21431
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
21388
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
+ *
21389
21435
  * @param eventType - The event that should invoke the handler.
21390
21436
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
21391
21437
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
@@ -22011,10 +22057,7 @@ declare namespace Office {
22011
22057
  */
22012
22058
  loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
22013
22059
  /**
22014
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22015
- *
22016
- * For supported events, refer to the Item object model
22017
- * {@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.
22018
22061
  *
22019
22062
  * @remarks
22020
22063
  * [Api set: Mailbox 1.7]
@@ -22023,6 +22066,8 @@ declare namespace Office {
22023
22066
  *
22024
22067
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22025
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
+ *
22026
22071
  * @param eventType - The event that should revoke the handler.
22027
22072
  * @param options - An object literal that contains one or more of the following properties:-
22028
22073
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -22031,10 +22076,7 @@ declare namespace Office {
22031
22076
  */
22032
22077
  removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
22033
22078
  /**
22034
- * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
22035
- *
22036
- * For supported events, refer to the Item object model
22037
- * {@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.
22038
22080
  *
22039
22081
  * @remarks
22040
22082
  * [Api set: Mailbox 1.7]
@@ -22043,6 +22085,8 @@ declare namespace Office {
22043
22085
  *
22044
22086
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
22045
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
+ *
22046
22090
  * @param eventType - The event that should revoke the handler.
22047
22091
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
22048
22092
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -23141,6 +23185,14 @@ declare namespace Office {
23141
23185
  }
23142
23186
  /**
23143
23187
  * A file or item attachment. Used when displaying a reply form.
23188
+ *
23189
+ * @remarks
23190
+ *
23191
+ * [Api set: Mailbox 1.1]
23192
+ *
23193
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23194
+ *
23195
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23144
23196
  */
23145
23197
  interface ReplyFormAttachment {
23146
23198
  /**
@@ -23148,6 +23200,12 @@ declare namespace Office {
23148
23200
  *
23149
23201
  * @remarks
23150
23202
  *
23203
+ * [Api set: Mailbox 1.1]
23204
+ *
23205
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23206
+ *
23207
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23208
+ *
23151
23209
  * **Important**:
23152
23210
  *
23153
23211
  * - The `base64` attachment type was introduced in Mailbox requirement set 1.15. It's only supported by the `displayReplyAllForm`, `displayReplyAllFormAsync`, `displayReplyForm`, and
@@ -23159,11 +23217,27 @@ declare namespace Office {
23159
23217
  type: MailboxEnums.AttachmentType;
23160
23218
  /**
23161
23219
  * A string that contains the name of the attachment, up to 255 characters in length.
23220
+ *
23221
+ * @remarks
23222
+ *
23223
+ * [Api set: Mailbox 1.1]
23224
+ *
23225
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23226
+ *
23227
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23162
23228
  */
23163
23229
  name: string;
23164
23230
  /**
23165
23231
  * The URI of the location for the file. Only use if `type` is set to `file`.
23166
23232
  *
23233
+ * @remarks
23234
+ *
23235
+ * [Api set: Mailbox 1.1]
23236
+ *
23237
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23238
+ *
23239
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23240
+ *
23167
23241
  * **Important**: This link must be publicly accessible without need for authentication by Exchange Online servers. However, with
23168
23242
  * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
23169
23243
  */
@@ -23171,10 +23245,26 @@ declare namespace Office {
23171
23245
  /**
23172
23246
  * If true, indicates that the attachment will be shown inline in the message body and shouldn't be displayed in the attachment list.
23173
23247
  * Only use if `type` is set to `base64` or `file`.
23248
+ *
23249
+ * @remarks
23250
+ *
23251
+ * [Api set: Mailbox 1.1]
23252
+ *
23253
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23254
+ *
23255
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23174
23256
  */
23175
23257
  inLine?: boolean;
23176
23258
  /**
23177
23259
  * The EWS item ID of the attachment. This is a string up to 100 characters. Only use if `type` is set to `item`.
23260
+ *
23261
+ * @remarks
23262
+ *
23263
+ * [Api set: Mailbox 1.1]
23264
+ *
23265
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23266
+ *
23267
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23178
23268
  */
23179
23269
  itemId?: string;
23180
23270
  /**
@@ -23183,29 +23273,72 @@ declare namespace Office {
23183
23273
  * @remarks
23184
23274
  *
23185
23275
  * [Api set: Mailbox 1.15]
23276
+ *
23277
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23278
+ *
23279
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23186
23280
  */
23187
23281
  base64file?: string;
23188
23282
  }
23189
23283
  /**
23190
23284
  * A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.
23285
+ *
23286
+ * @remarks
23287
+ *
23288
+ * [Api set: Mailbox 1.1]
23289
+ *
23290
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23291
+ *
23292
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23191
23293
  */
23192
23294
  interface ReplyFormData {
23193
23295
  /**
23194
23296
  * A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
23297
+ *
23298
+ * @remarks
23299
+ *
23300
+ * [Api set: Mailbox 1.1]
23301
+ *
23302
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23303
+ *
23304
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23195
23305
  */
23196
23306
  htmlBody?: string;
23197
23307
  /**
23198
23308
  * An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are Base64-encoded files, Exchange items, or file attachments.
23309
+ *
23310
+ * @remarks
23311
+ *
23312
+ * [Api set: Mailbox 1.2]
23313
+ *
23314
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23315
+ *
23316
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23199
23317
  */
23200
23318
  attachments?: ReplyFormAttachment[];
23201
23319
  /**
23202
23320
  * When the reply display call completes, the function passed in the callback parameter is called with a single parameter,
23203
23321
  * `asyncResult`, which is an `Office.AsyncResult` object.
23322
+ *
23323
+ * @remarks
23324
+ *
23325
+ * [Api set: Mailbox 1.1]
23326
+ *
23327
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23328
+ *
23329
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23204
23330
  */
23205
23331
  callback?: (asyncResult: Office.AsyncResult<any>) => void;
23206
23332
  /**
23207
- * An object literal that contains the following property:-
23208
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
23333
+ * An object literal that contains the `asyncContext` property. Use the `asyncContext` property to specify any object that you want to access in the callback function.
23334
+ *
23335
+ * @remarks
23336
+ *
23337
+ * [Api set: Mailbox 1.1]
23338
+ *
23339
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23340
+ *
23341
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23209
23342
  */
23210
23343
  options?: Office.AsyncContextOptions;
23211
23344
  }