@types/office-js 1.0.573 → 1.0.574

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 +317 -205
  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: Fri, 13 Feb 2026 16:11:57 GMT
11
+ * Last updated: Sat, 14 Feb 2026 00:52:50 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -12160,176 +12160,113 @@ declare namespace Office {
12160
12160
  setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12161
12161
  }
12162
12162
  /**
12163
- * The `AppointmentForm` object is used to access the currently selected appointment.
12163
+ * Represents the details of the form for creating a new appointment.
12164
12164
  *
12165
12165
  * @remarks
12166
12166
  *
12167
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
12167
+ * [Api set: Mailbox 1.1]
12168
12168
  *
12169
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12169
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12170
+ *
12171
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12170
12172
  */
12171
12173
  interface AppointmentForm {
12172
12174
  /**
12173
- * Gets an object that provides methods for manipulating the body of an item.
12175
+ * Sets the body of the appointment.
12174
12176
  *
12175
12177
  * @remarks
12178
+ *
12176
12179
  * [Api set: Mailbox 1.1]
12177
12180
  *
12178
12181
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12179
12182
  *
12180
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12183
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12181
12184
  */
12182
- body: Body | string;
12185
+ body?: string;
12183
12186
  /**
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.
12187
+ * Sets the date and time that the appointment is to end.
12199
12188
  *
12200
12189
  * @remarks
12201
12190
  *
12191
+ * [Api set: Mailbox 1.1]
12192
+ *
12202
12193
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12203
12194
  *
12204
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12195
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12205
12196
  */
12206
- end: Time | Date;
12197
+ end?: Date | number;
12207
12198
  /**
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.
12199
+ * Sets the location of the appointment.
12217
12200
  *
12218
12201
  * @remarks
12219
12202
  *
12203
+ * [Api set: Mailbox 1.1]
12204
+ *
12220
12205
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12221
12206
  *
12222
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12207
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12223
12208
  */
12224
- location: Location | string;
12209
+ location?: string;
12225
12210
  /**
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.
12211
+ * Sets the optional attendees of the appointment.
12244
12212
  *
12245
12213
  * @remarks
12246
12214
  *
12215
+ * [Api set: Mailbox 1.1]
12216
+ *
12247
12217
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12248
12218
  *
12249
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12219
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12250
12220
  */
12251
- optionalAttendees: Recipients[] | EmailAddressDetails[];
12221
+ optionalAttendees?: string[] | EmailAddressDetails[];
12252
12222
  /**
12253
- * Provides access to the resources of an event. Returns an array of strings containing the resources required for the appointment.
12223
+ * Sets the resources of the appointment.
12254
12224
  *
12255
12225
  * @remarks
12256
12226
  *
12227
+ * [Api set: Mailbox 1.1]
12228
+ *
12257
12229
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12258
12230
  *
12259
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12231
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12260
12232
  */
12261
- resources: string[];
12233
+ resources?: string[];
12262
12234
  /**
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.
12235
+ * Sets the required attendees of the appointment.
12281
12236
  *
12282
12237
  * @remarks
12283
12238
  *
12239
+ * [Api set: Mailbox 1.1]
12240
+ *
12284
12241
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12285
12242
  *
12286
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12243
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12287
12244
  */
12288
- requiredAttendees: Recipients[] | EmailAddressDetails[];
12245
+ requiredAttendees?: string[] | EmailAddressDetails[];
12289
12246
  /**
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.
12247
+ * Sets the date and time that the appointment is to begin.
12305
12248
  *
12306
12249
  * @remarks
12307
12250
  *
12251
+ * [Api set: Mailbox 1.1]
12252
+ *
12308
12253
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12309
12254
  *
12310
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12255
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12311
12256
  */
12312
- start: Time | Date;
12257
+ start?: Date | number;
12313
12258
  /**
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.
12259
+ * Sets the description that appears in the Title field of the appointment.
12325
12260
  *
12326
12261
  * @remarks
12327
12262
  *
12263
+ * [Api set: Mailbox 1.1]
12264
+ *
12328
12265
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12329
12266
  *
12330
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12267
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12331
12268
  */
12332
- subject: Subject | string;
12269
+ subject?: string;
12333
12270
  }
12334
12271
  /**
12335
12272
  * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
@@ -18398,39 +18335,9 @@ declare namespace Office {
18398
18335
  *
18399
18336
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18400
18337
  *
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.
18338
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18432
18339
  */
18433
- displayNewMessageForm(parameters: any): void;
18340
+ displayNewMessageForm(parameters: MessageForm): void;
18434
18341
  /**
18435
18342
  * Displays a form for creating a new message.
18436
18343
  *
@@ -18446,43 +18353,13 @@ declare namespace Office {
18446
18353
  *
18447
18354
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18448
18355
  *
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.
18356
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18480
18357
  * @param options - An object literal that contains one or more of the following properties:-
18481
18358
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18482
18359
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18483
18360
  * `asyncResult`, which is an `Office.AsyncResult` object.
18484
18361
  */
18485
- displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18362
+ displayNewMessageFormAsync(parameters: MessageForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18486
18363
  /**
18487
18364
  * Displays a form for creating a new message.
18488
18365
  *
@@ -18498,41 +18375,11 @@ declare namespace Office {
18498
18375
  *
18499
18376
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18500
18377
  *
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.
18378
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18532
18379
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18533
18380
  * `asyncResult`, which is an `Office.AsyncResult` object.
18534
18381
  */
18535
- displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18382
+ displayNewMessageFormAsync(parameters: MessageForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18536
18383
  /**
18537
18384
  * Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).
18538
18385
  *
@@ -20940,6 +20787,182 @@ declare namespace Office {
20940
20787
  */
20941
20788
  setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
20942
20789
  }
20790
+ /**
20791
+ * Represents the details of the form for composing a new message.
20792
+ *
20793
+ * @remarks
20794
+ *
20795
+ * [Api set: Mailbox 1.6]
20796
+ *
20797
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20798
+ *
20799
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20800
+ */
20801
+ interface MessageForm {
20802
+ /**
20803
+ * Sets the attachments of the message. An attachment must be a file attachment (`Office.MailboxEnums.AttachmentType.File`) or an Outlook item attachment
20804
+ * (`Office.MailboxEnums.AttachmentType.Item`).
20805
+ *
20806
+ * @remarks
20807
+ *
20808
+ * [Api set: Mailbox 1.6]
20809
+ *
20810
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20811
+ *
20812
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20813
+ */
20814
+ attachments?: MessageFormAttachment[];
20815
+ /**
20816
+ * Sets the recipients in the Bcc field of the 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
+ * **Important**: The `bccRecipients` array is limited to a maximum of 100 recipients.
20827
+ */
20828
+ bccRecipients?: string[] | EmailAddressDetails[];
20829
+ /**
20830
+ * Sets the recipients in the Cc field of the message.
20831
+ *
20832
+ * @remarks
20833
+ *
20834
+ * [Api set: Mailbox 1.6]
20835
+ *
20836
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20837
+ *
20838
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20839
+ *
20840
+ * **Important**: The `ccRecipients` array is limited to a maximum of 100 recipients.
20841
+ */
20842
+ ccRecipients?: string[] | EmailAddressDetails[];
20843
+ /**
20844
+ * Sets the body of the message.
20845
+ *
20846
+ * @remarks
20847
+ *
20848
+ * [Api set: Mailbox 1.6]
20849
+ *
20850
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20851
+ *
20852
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20853
+ *
20854
+ * **Important**: The body content is limited to a maximum size of 32 KB.
20855
+ */
20856
+ htmlBody?: string;
20857
+ /**
20858
+ * Sets the subject of the message.
20859
+ *
20860
+ * @remarks
20861
+ *
20862
+ * [Api set: Mailbox 1.6]
20863
+ *
20864
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20865
+ *
20866
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20867
+ *
20868
+ * **Important**: The subject is limited to a maximum of 255 characters.
20869
+ */
20870
+ subject?: string;
20871
+ /**
20872
+ * Sets the recipients in the To field of the message.
20873
+ *
20874
+ * @remarks
20875
+ *
20876
+ * [Api set: Mailbox 1.6]
20877
+ *
20878
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20879
+ *
20880
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20881
+ *
20882
+ * **Important**: The `toRecipients` array is limited to a maximum of 100 recipients.
20883
+ */
20884
+ toRecipients?: string[] | EmailAddressDetails[];
20885
+ }
20886
+ /**
20887
+ * A file or Outlook item attachment. Used when displaying a new message form.
20888
+ *
20889
+ * @remarks
20890
+ *
20891
+ * [Api set: Mailbox 1.6]
20892
+ *
20893
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20894
+ *
20895
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20896
+ */
20897
+ interface MessageFormAttachment {
20898
+ /**
20899
+ * The type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` or `Office.MailboxEnums.AttachmentType.Item`.
20900
+ *
20901
+ * @remarks
20902
+ *
20903
+ * [Api set: Mailbox 1.6]
20904
+ *
20905
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20906
+ *
20907
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20908
+ *
20909
+ * **Important**: The `base64` and `cloud` attachment types aren't supported.
20910
+ */
20911
+ type: MailboxEnums.AttachmentType | string;
20912
+ /**
20913
+ * The name of the attachment. The name can be up to 255 characters in length.
20914
+ *
20915
+ * @remarks
20916
+ *
20917
+ * [Api set: Mailbox 1.6]
20918
+ *
20919
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20920
+ *
20921
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20922
+ */
20923
+ name: string;
20924
+ /**
20925
+ * The URI of the location for the file. Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
20926
+ *
20927
+ * @remarks
20928
+ *
20929
+ * [Api set: Mailbox 1.6]
20930
+ *
20931
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20932
+ *
20933
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20934
+ *
20935
+ * **Important**: The link must be publicly accessible without need for authentication by Exchange Online servers. However, with
20936
+ * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
20937
+ */
20938
+ url?: string;
20939
+ /**
20940
+ * If true, indicates that the attachment will be shown inline in the message body and won't be displayed in the attachment list.
20941
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
20942
+ *
20943
+ * @remarks
20944
+ *
20945
+ * [Api set: Mailbox 1.6]
20946
+ *
20947
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20948
+ *
20949
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20950
+ */
20951
+ isInline?: boolean;
20952
+ /**
20953
+ * The Exchange Web Services (EWS) item ID of the attachment. The item ID is a string of up to 100 characters.
20954
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.Item`.
20955
+ *
20956
+ * @remarks
20957
+ *
20958
+ * [Api set: Mailbox 1.6]
20959
+ *
20960
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20961
+ *
20962
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
20963
+ */
20964
+ itemId?: string;
20965
+ }
20943
20966
  /**
20944
20967
  * The message read mode of {@link Office.Item | Office.context.mailbox.item}.
20945
20968
  *
@@ -23141,6 +23164,14 @@ declare namespace Office {
23141
23164
  }
23142
23165
  /**
23143
23166
  * A file or item attachment. Used when displaying a reply form.
23167
+ *
23168
+ * @remarks
23169
+ *
23170
+ * [Api set: Mailbox 1.1]
23171
+ *
23172
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23173
+ *
23174
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23144
23175
  */
23145
23176
  interface ReplyFormAttachment {
23146
23177
  /**
@@ -23148,6 +23179,12 @@ declare namespace Office {
23148
23179
  *
23149
23180
  * @remarks
23150
23181
  *
23182
+ * [Api set: Mailbox 1.1]
23183
+ *
23184
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23185
+ *
23186
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23187
+ *
23151
23188
  * **Important**:
23152
23189
  *
23153
23190
  * - The `base64` attachment type was introduced in Mailbox requirement set 1.15. It's only supported by the `displayReplyAllForm`, `displayReplyAllFormAsync`, `displayReplyForm`, and
@@ -23159,11 +23196,27 @@ declare namespace Office {
23159
23196
  type: MailboxEnums.AttachmentType;
23160
23197
  /**
23161
23198
  * A string that contains the name of the attachment, up to 255 characters in length.
23199
+ *
23200
+ * @remarks
23201
+ *
23202
+ * [Api set: Mailbox 1.1]
23203
+ *
23204
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23205
+ *
23206
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23162
23207
  */
23163
23208
  name: string;
23164
23209
  /**
23165
23210
  * The URI of the location for the file. Only use if `type` is set to `file`.
23166
23211
  *
23212
+ * @remarks
23213
+ *
23214
+ * [Api set: Mailbox 1.1]
23215
+ *
23216
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23217
+ *
23218
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23219
+ *
23167
23220
  * **Important**: This link must be publicly accessible without need for authentication by Exchange Online servers. However, with
23168
23221
  * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
23169
23222
  */
@@ -23171,10 +23224,26 @@ declare namespace Office {
23171
23224
  /**
23172
23225
  * If true, indicates that the attachment will be shown inline in the message body and shouldn't be displayed in the attachment list.
23173
23226
  * Only use if `type` is set to `base64` or `file`.
23227
+ *
23228
+ * @remarks
23229
+ *
23230
+ * [Api set: Mailbox 1.1]
23231
+ *
23232
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23233
+ *
23234
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23174
23235
  */
23175
23236
  inLine?: boolean;
23176
23237
  /**
23177
23238
  * The EWS item ID of the attachment. This is a string up to 100 characters. Only use if `type` is set to `item`.
23239
+ *
23240
+ * @remarks
23241
+ *
23242
+ * [Api set: Mailbox 1.1]
23243
+ *
23244
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23245
+ *
23246
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23178
23247
  */
23179
23248
  itemId?: string;
23180
23249
  /**
@@ -23183,29 +23252,72 @@ declare namespace Office {
23183
23252
  * @remarks
23184
23253
  *
23185
23254
  * [Api set: Mailbox 1.15]
23255
+ *
23256
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23257
+ *
23258
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23186
23259
  */
23187
23260
  base64file?: string;
23188
23261
  }
23189
23262
  /**
23190
23263
  * A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.
23264
+ *
23265
+ * @remarks
23266
+ *
23267
+ * [Api set: Mailbox 1.1]
23268
+ *
23269
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23270
+ *
23271
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23191
23272
  */
23192
23273
  interface ReplyFormData {
23193
23274
  /**
23194
23275
  * A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
23276
+ *
23277
+ * @remarks
23278
+ *
23279
+ * [Api set: Mailbox 1.1]
23280
+ *
23281
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23282
+ *
23283
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23195
23284
  */
23196
23285
  htmlBody?: string;
23197
23286
  /**
23198
23287
  * An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are Base64-encoded files, Exchange items, or file attachments.
23288
+ *
23289
+ * @remarks
23290
+ *
23291
+ * [Api set: Mailbox 1.1]
23292
+ *
23293
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23294
+ *
23295
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23199
23296
  */
23200
23297
  attachments?: ReplyFormAttachment[];
23201
23298
  /**
23202
23299
  * When the reply display call completes, the function passed in the callback parameter is called with a single parameter,
23203
23300
  * `asyncResult`, which is an `Office.AsyncResult` object.
23301
+ *
23302
+ * @remarks
23303
+ *
23304
+ * [Api set: Mailbox 1.1]
23305
+ *
23306
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23307
+ *
23308
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23204
23309
  */
23205
23310
  callback?: (asyncResult: Office.AsyncResult<any>) => void;
23206
23311
  /**
23207
- * An object literal that contains the following property:-
23208
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
23312
+ * 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.
23313
+ *
23314
+ * @remarks
23315
+ *
23316
+ * [Api set: Mailbox 1.1]
23317
+ *
23318
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23319
+ *
23320
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23209
23321
  */
23210
23322
  options?: Office.AsyncContextOptions;
23211
23323
  }
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.573",
3
+ "version": "1.0.574",
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": "e97504d8f851b9ad36f5e238449bef7b1e287b4f6906ab1fb9d00d89b55cb144",
49
+ "typesPublisherContentHash": "d62efe8dd5ce859af944eaa5768d6a5611ea5110069636de620edb245354c439",
50
50
  "typeScriptVersion": "5.2"
51
51
  }