@types/office-js-preview 1.0.685 → 1.0.686

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: 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
@@ -12202,180 +12202,113 @@ declare namespace Office {
12202
12202
  setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12203
12203
  }
12204
12204
  /**
12205
- * The `AppointmentForm` object is used to access the currently selected appointment.
12205
+ * Represents the details of the form for creating a new appointment.
12206
12206
  *
12207
12207
  * @remarks
12208
12208
  *
12209
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
12209
+ * [Api set: Mailbox 1.1]
12210
12210
  *
12211
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12211
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12212
+ *
12213
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12212
12214
  */
12213
12215
  interface AppointmentForm {
12214
12216
  /**
12215
- * Gets an object that provides methods for manipulating the body of an item.
12217
+ * Sets the body of the appointment.
12216
12218
  *
12217
12219
  * @remarks
12220
+ *
12218
12221
  * [Api set: Mailbox 1.1]
12219
12222
  *
12220
12223
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12221
12224
  *
12222
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12225
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12223
12226
  */
12224
- body: Body | string;
12227
+ body?: string;
12225
12228
  /**
12226
- * Gets or sets the date and time that the appointment is to end.
12227
- *
12228
- * The `end` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method to
12229
- * convert the `end` property value to the client's local date and time.
12230
- *
12231
- * *Read mode*
12232
- *
12233
- * The `end` property returns a `Date` object.
12234
- *
12235
- * *Compose mode*
12236
- *
12237
- * The `end` property returns a `Time` object.
12238
- *
12239
- * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on
12240
- * the client to UTC for the server.
12229
+ * Sets the date and time that the appointment is to end.
12241
12230
  *
12242
12231
  * @remarks
12243
12232
  *
12233
+ * [Api set: Mailbox 1.1]
12234
+ *
12244
12235
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12245
12236
  *
12246
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12237
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12247
12238
  */
12248
- end: Time | Date;
12239
+ end?: Date | number;
12249
12240
  /**
12250
- * Gets or sets the location of an appointment.
12251
- *
12252
- * *Read mode*
12253
- *
12254
- * The `location` property returns a string that contains the location of the appointment.
12255
- *
12256
- * *Compose mode*
12257
- *
12258
- * The `location` property returns a `Location` object that provides methods that are used to get and set the location of the appointment.
12241
+ * Sets the location of the appointment.
12259
12242
  *
12260
12243
  * @remarks
12261
12244
  *
12245
+ * [Api set: Mailbox 1.1]
12246
+ *
12262
12247
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12263
12248
  *
12264
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12249
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12265
12250
  */
12266
- location: Location | string;
12251
+ location?: string;
12267
12252
  /**
12268
- * 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.
12269
- *
12270
- * *Read mode*
12271
- *
12272
- * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
12273
- * each optional attendee to the meeting. Collection size limits:
12274
- *
12275
- * - Web browser, new Mac UI, Android: No limit
12276
- *
12277
- * - Windows (new and classic): 500 members
12278
- *
12279
- * - Windows (classic - in preview starting in Version 2511 (Build 19426.20000)): 1,000 members
12280
- *
12281
- * - Classic Mac UI: 100 members
12282
- *
12283
- * *Compose mode*
12284
- *
12285
- * The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the
12286
- * optional attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on how many
12287
- * recipients you can get or update. See the {@link Office.Recipients | Recipients} object for more details.
12253
+ * Sets the optional attendees of the appointment.
12288
12254
  *
12289
12255
  * @remarks
12290
12256
  *
12257
+ * [Api set: Mailbox 1.1]
12258
+ *
12291
12259
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12292
12260
  *
12293
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12261
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12294
12262
  */
12295
- optionalAttendees: Recipients[] | EmailAddressDetails[];
12263
+ optionalAttendees?: string[] | EmailAddressDetails[];
12296
12264
  /**
12297
- * Provides access to the resources of an event. Returns an array of strings containing the resources required for the appointment.
12265
+ * Sets the resources of the appointment.
12298
12266
  *
12299
12267
  * @remarks
12300
12268
  *
12269
+ * [Api set: Mailbox 1.1]
12270
+ *
12301
12271
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12302
12272
  *
12303
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12273
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12304
12274
  */
12305
- resources: string[];
12275
+ resources?: string[];
12306
12276
  /**
12307
- * 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.
12308
- *
12309
- * *Read mode*
12310
- *
12311
- * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
12312
- * each required attendee to the meeting. Collection size limits:
12313
- *
12314
- * - Web browser, new Mac UI, Android: No limit
12315
- *
12316
- * - Windows: 500 members
12317
- *
12318
- * - Windows (classic - in preview starting in Version 2511 (Build 19426.20000)): 1,000 members
12319
- *
12320
- * - Classic Mac UI: 100 members
12321
- *
12322
- * *Compose mode*
12323
- *
12324
- * The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the
12325
- * required attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on how many
12326
- * recipients you can get or update. See the {@link Office.Recipients | Recipients} object for more details.
12277
+ * Sets the required attendees of the appointment.
12327
12278
  *
12328
12279
  * @remarks
12329
12280
  *
12281
+ * [Api set: Mailbox 1.1]
12282
+ *
12330
12283
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12331
12284
  *
12332
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12285
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12333
12286
  */
12334
- requiredAttendees: Recipients[] | EmailAddressDetails[];
12287
+ requiredAttendees?: string[] | EmailAddressDetails[];
12335
12288
  /**
12336
- * Gets or sets the date and time that the appointment is to begin.
12337
- *
12338
- * The `start` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method
12339
- * to convert the value to the client's local date and time.
12340
- *
12341
- * *Read mode*
12342
- *
12343
- * The `start` property returns a `Date` object.
12344
- *
12345
- * *Compose mode*
12346
- *
12347
- * The `start` property returns a `Time` object.
12348
- *
12349
- * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on
12350
- * the client to UTC for the server.
12289
+ * Sets the date and time that the appointment is to begin.
12351
12290
  *
12352
12291
  * @remarks
12353
12292
  *
12293
+ * [Api set: Mailbox 1.1]
12294
+ *
12354
12295
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12355
12296
  *
12356
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12297
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12357
12298
  */
12358
- start: Time | Date;
12299
+ start?: Date | number;
12359
12300
  /**
12360
- * Gets or sets the description that appears in the subject field of an item.
12361
- *
12362
- * The `subject` property gets or sets the entire subject of the item, as sent by the email server.
12363
- *
12364
- * *Read mode*
12365
- *
12366
- * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:.
12367
- *
12368
- * *Compose mode*
12369
- *
12370
- * The `subject` property returns a `Subject` object that provides methods to get and set the subject.
12301
+ * Sets the description that appears in the Title field of the appointment.
12371
12302
  *
12372
12303
  * @remarks
12373
12304
  *
12305
+ * [Api set: Mailbox 1.1]
12306
+ *
12374
12307
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12375
12308
  *
12376
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12309
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12377
12310
  */
12378
- subject: Subject | string;
12311
+ subject?: string;
12379
12312
  }
12380
12313
  /**
12381
12314
  * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
@@ -18947,39 +18880,9 @@ declare namespace Office {
18947
18880
  *
18948
18881
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18949
18882
  *
18950
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
18951
- *
18952
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18953
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
18954
- *
18955
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18956
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
18957
- *
18958
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
18959
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
18960
- *
18961
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
18962
- *
18963
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
18964
- *
18965
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
18966
- *
18967
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
18968
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
18969
- *
18970
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
18971
- *
18972
- * `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
18973
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
18974
- * be accessible on a private network as long as it doesn't need further authentication.
18975
- *
18976
- * `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
18977
- * in the message body and won't be displayed in the attachment list.
18978
- *
18979
- * `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.
18980
- * This is a string up to 100 characters.
18883
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
18981
18884
  */
18982
- displayNewMessageForm(parameters: any): void;
18885
+ displayNewMessageForm(parameters: MessageForm): void;
18983
18886
  /**
18984
18887
  * Displays a form for creating a new message.
18985
18888
  *
@@ -18995,43 +18898,13 @@ declare namespace Office {
18995
18898
  *
18996
18899
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18997
18900
  *
18998
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
18999
- *
19000
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19001
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
19002
- *
19003
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19004
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
19005
- *
19006
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19007
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
19008
- *
19009
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
19010
- *
19011
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
19012
- *
19013
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
19014
- *
19015
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
19016
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
19017
- *
19018
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
19019
- *
19020
- * `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
19021
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
19022
- * be accessible on a private network as long as it doesn't need further authentication.
19023
- *
19024
- * `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
19025
- * in the message body and won't be displayed in the attachment list.
19026
- *
19027
- * `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.
19028
- * This is a string up to 100 characters.
18901
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
19029
18902
  * @param options - An object literal that contains one or more of the following properties:-
19030
18903
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
19031
18904
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
19032
18905
  * `asyncResult`, which is an `Office.AsyncResult` object.
19033
18906
  */
19034
- displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18907
+ displayNewMessageFormAsync(parameters: MessageForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
19035
18908
  /**
19036
18909
  * Displays a form for creating a new message.
19037
18910
  *
@@ -19047,41 +18920,11 @@ declare namespace Office {
19047
18920
  *
19048
18921
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
19049
18922
  *
19050
- * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional.
19051
- *
19052
- * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19053
- * for each of the recipients on the **To** line. The array is limited to a maximum of 100 entries.
19054
- *
19055
- * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19056
- * for each of the recipients on the **Cc** line. The array is limited to a maximum of 100 entries.
19057
- *
19058
- * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object
19059
- * for each of the recipients on the **Bcc** line. The array is limited to a maximum of 100 entries.
19060
- *
19061
- * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters.
19062
- *
19063
- * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB.
19064
- *
19065
- * `attachments`: An array of JSON objects that are either file or Exchange item attachments.
19066
- *
19067
- * `attachments.type`: Indicates the type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` for a file attachment or
19068
- * `Office.MailboxEnums.AttachmentType.Item` for an Exchange item attachment.
19069
- *
19070
- * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length.
19071
- *
19072
- * `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
19073
- * publicly accessible, without need for authentication by Exchange Online servers. However, with on-premises Exchange, the link can
19074
- * be accessible on a private network as long as it doesn't need further authentication.
19075
- *
19076
- * `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
19077
- * in the message body and won't be displayed in the attachment list.
19078
- *
19079
- * `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.
19080
- * This is a string up to 100 characters.
18923
+ * @param parameters - A `MessageForm` object containing the content to be added to the new message form. All properties are optional.
19081
18924
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
19082
18925
  * `asyncResult`, which is an `Office.AsyncResult` object.
19083
18926
  */
19084
- displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18927
+ displayNewMessageFormAsync(parameters: MessageForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
19085
18928
  /**
19086
18929
  * Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).
19087
18930
  *
@@ -21588,6 +21431,182 @@ declare namespace Office {
21588
21431
  */
21589
21432
  emailBody?: DecryptedMessageBody;
21590
21433
  }
21434
+ /**
21435
+ * Represents the details of the form for composing a new message.
21436
+ *
21437
+ * @remarks
21438
+ *
21439
+ * [Api set: Mailbox 1.6]
21440
+ *
21441
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21442
+ *
21443
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21444
+ */
21445
+ interface MessageForm {
21446
+ /**
21447
+ * Sets the attachments of the message. An attachment must be a file attachment (`Office.MailboxEnums.AttachmentType.File`) or an Outlook item attachment
21448
+ * (`Office.MailboxEnums.AttachmentType.Item`).
21449
+ *
21450
+ * @remarks
21451
+ *
21452
+ * [Api set: Mailbox 1.6]
21453
+ *
21454
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21455
+ *
21456
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21457
+ */
21458
+ attachments?: MessageFormAttachment[];
21459
+ /**
21460
+ * Sets the recipients in the Bcc field of the message.
21461
+ *
21462
+ * @remarks
21463
+ *
21464
+ * [Api set: Mailbox 1.6]
21465
+ *
21466
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21467
+ *
21468
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21469
+ *
21470
+ * **Important**: The `bccRecipients` array is limited to a maximum of 100 recipients.
21471
+ */
21472
+ bccRecipients?: string[] | EmailAddressDetails[];
21473
+ /**
21474
+ * Sets the recipients in the Cc field of the message.
21475
+ *
21476
+ * @remarks
21477
+ *
21478
+ * [Api set: Mailbox 1.6]
21479
+ *
21480
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21481
+ *
21482
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21483
+ *
21484
+ * **Important**: The `ccRecipients` array is limited to a maximum of 100 recipients.
21485
+ */
21486
+ ccRecipients?: string[] | EmailAddressDetails[];
21487
+ /**
21488
+ * Sets the body of the message.
21489
+ *
21490
+ * @remarks
21491
+ *
21492
+ * [Api set: Mailbox 1.6]
21493
+ *
21494
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21495
+ *
21496
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21497
+ *
21498
+ * **Important**: The body content is limited to a maximum size of 32 KB.
21499
+ */
21500
+ htmlBody?: string;
21501
+ /**
21502
+ * Sets the subject of the message.
21503
+ *
21504
+ * @remarks
21505
+ *
21506
+ * [Api set: Mailbox 1.6]
21507
+ *
21508
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21509
+ *
21510
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21511
+ *
21512
+ * **Important**: The subject is limited to a maximum of 255 characters.
21513
+ */
21514
+ subject?: string;
21515
+ /**
21516
+ * Sets the recipients in the To field of the message.
21517
+ *
21518
+ * @remarks
21519
+ *
21520
+ * [Api set: Mailbox 1.6]
21521
+ *
21522
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21523
+ *
21524
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21525
+ *
21526
+ * **Important**: The `toRecipients` array is limited to a maximum of 100 recipients.
21527
+ */
21528
+ toRecipients?: string[] | EmailAddressDetails[];
21529
+ }
21530
+ /**
21531
+ * A file or Outlook item attachment. Used when displaying a new message form.
21532
+ *
21533
+ * @remarks
21534
+ *
21535
+ * [Api set: Mailbox 1.6]
21536
+ *
21537
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21538
+ *
21539
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21540
+ */
21541
+ interface MessageFormAttachment {
21542
+ /**
21543
+ * The type of attachment. Must be `Office.MailboxEnums.AttachmentType.File` or `Office.MailboxEnums.AttachmentType.Item`.
21544
+ *
21545
+ * @remarks
21546
+ *
21547
+ * [Api set: Mailbox 1.6]
21548
+ *
21549
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21550
+ *
21551
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21552
+ *
21553
+ * **Important**: The `base64` and `cloud` attachment types aren't supported.
21554
+ */
21555
+ type: MailboxEnums.AttachmentType | string;
21556
+ /**
21557
+ * The name of the attachment. The name can be up to 255 characters in length.
21558
+ *
21559
+ * @remarks
21560
+ *
21561
+ * [Api set: Mailbox 1.6]
21562
+ *
21563
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21564
+ *
21565
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21566
+ */
21567
+ name: string;
21568
+ /**
21569
+ * The URI of the location for the file. Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
21570
+ *
21571
+ * @remarks
21572
+ *
21573
+ * [Api set: Mailbox 1.6]
21574
+ *
21575
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21576
+ *
21577
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21578
+ *
21579
+ * **Important**: The link must be publicly accessible without need for authentication by Exchange Online servers. However, with
21580
+ * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
21581
+ */
21582
+ url?: string;
21583
+ /**
21584
+ * If true, indicates that the attachment will be shown inline in the message body and won't be displayed in the attachment list.
21585
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.File`.
21586
+ *
21587
+ * @remarks
21588
+ *
21589
+ * [Api set: Mailbox 1.6]
21590
+ *
21591
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21592
+ *
21593
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21594
+ */
21595
+ isInline?: boolean;
21596
+ /**
21597
+ * The Exchange Web Services (EWS) item ID of the attachment. The item ID is a string of up to 100 characters.
21598
+ * Only specify if the `type` property is set to `Office.MailboxEnums.AttachmentType.Item`.
21599
+ *
21600
+ * @remarks
21601
+ *
21602
+ * [Api set: Mailbox 1.6]
21603
+ *
21604
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21605
+ *
21606
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
21607
+ */
21608
+ itemId?: string;
21609
+ }
21591
21610
  /**
21592
21611
  * The message read mode of {@link Office.Item | Office.context.mailbox.item}.
21593
21612
  *
@@ -23914,6 +23933,14 @@ declare namespace Office {
23914
23933
  }
23915
23934
  /**
23916
23935
  * A file or item attachment. Used when displaying a reply form.
23936
+ *
23937
+ * @remarks
23938
+ *
23939
+ * [Api set: Mailbox 1.1]
23940
+ *
23941
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23942
+ *
23943
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23917
23944
  */
23918
23945
  interface ReplyFormAttachment {
23919
23946
  /**
@@ -23921,6 +23948,12 @@ declare namespace Office {
23921
23948
  *
23922
23949
  * @remarks
23923
23950
  *
23951
+ * [Api set: Mailbox 1.1]
23952
+ *
23953
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23954
+ *
23955
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23956
+ *
23924
23957
  * **Important**:
23925
23958
  *
23926
23959
  * - The `base64` attachment type was introduced in Mailbox requirement set 1.15. It's only supported by the `displayReplyAllForm`, `displayReplyAllFormAsync`, `displayReplyForm`, and
@@ -23932,6 +23965,14 @@ declare namespace Office {
23932
23965
  type: MailboxEnums.AttachmentType;
23933
23966
  /**
23934
23967
  * A string that contains the name of the attachment, up to 255 characters in length.
23968
+ *
23969
+ * @remarks
23970
+ *
23971
+ * [Api set: Mailbox 1.1]
23972
+ *
23973
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23974
+ *
23975
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23935
23976
  */
23936
23977
  name: string;
23937
23978
  /**
@@ -23939,6 +23980,12 @@ declare namespace Office {
23939
23980
  *
23940
23981
  * @remarks
23941
23982
  *
23983
+ * [Api set: Mailbox 1.1]
23984
+ *
23985
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
23986
+ *
23987
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23988
+ *
23942
23989
  * **Important**: This link must be publicly accessible without need for authentication by Exchange Online servers. However, with
23943
23990
  * on-premises Exchange, the link can be accessible on a private network as long as it doesn't need further authentication.
23944
23991
  */
@@ -23946,10 +23993,26 @@ declare namespace Office {
23946
23993
  /**
23947
23994
  * If true, indicates that the attachment will be shown inline in the message body and shouldn't be displayed in the attachment list.
23948
23995
  * Only use if `type` is set to `base64` or `file`.
23996
+ *
23997
+ * @remarks
23998
+ *
23999
+ * [Api set: Mailbox 1.1]
24000
+ *
24001
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24002
+ *
24003
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23949
24004
  */
23950
24005
  inLine?: boolean;
23951
24006
  /**
23952
24007
  * The EWS item ID of the attachment. This is a string up to 100 characters. Only use if `type` is set to `item`.
24008
+ *
24009
+ * @remarks
24010
+ *
24011
+ * [Api set: Mailbox 1.1]
24012
+ *
24013
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24014
+ *
24015
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23953
24016
  */
23954
24017
  itemId?: string;
23955
24018
  /**
@@ -23958,29 +24021,72 @@ declare namespace Office {
23958
24021
  * @remarks
23959
24022
  *
23960
24023
  * [Api set: Mailbox 1.15]
24024
+ *
24025
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24026
+ *
24027
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23961
24028
  */
23962
24029
  base64file?: string;
23963
24030
  }
23964
24031
  /**
23965
24032
  * A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.
24033
+ *
24034
+ * @remarks
24035
+ *
24036
+ * [Api set: Mailbox 1.1]
24037
+ *
24038
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24039
+ *
24040
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23966
24041
  */
23967
24042
  interface ReplyFormData {
23968
24043
  /**
23969
24044
  * A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
24045
+ *
24046
+ * @remarks
24047
+ *
24048
+ * [Api set: Mailbox 1.1]
24049
+ *
24050
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24051
+ *
24052
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23970
24053
  */
23971
24054
  htmlBody?: string;
23972
24055
  /**
23973
24056
  * An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are Base64-encoded files, Exchange items, or file attachments.
24057
+ *
24058
+ * @remarks
24059
+ *
24060
+ * [Api set: Mailbox 1.1]
24061
+ *
24062
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24063
+ *
24064
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23974
24065
  */
23975
24066
  attachments?: ReplyFormAttachment[];
23976
24067
  /**
23977
24068
  * When the reply display call completes, the function passed in the callback parameter is called with a single parameter,
23978
24069
  * `asyncResult`, which is an `Office.AsyncResult` object.
24070
+ *
24071
+ * @remarks
24072
+ *
24073
+ * [Api set: Mailbox 1.1]
24074
+ *
24075
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24076
+ *
24077
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23979
24078
  */
23980
24079
  callback?: (asyncResult: Office.AsyncResult<any>) => void;
23981
24080
  /**
23982
- * An object literal that contains the following property:-
23983
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
24081
+ * 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.
24082
+ *
24083
+ * @remarks
24084
+ *
24085
+ * [Api set: Mailbox 1.1]
24086
+ *
24087
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
24088
+ *
24089
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
23984
24090
  */
23985
24091
  options?: Office.AsyncContextOptions;
23986
24092
  }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.685",
3
+ "version": "1.0.686",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "3d0fe4933eea41c3ab121084041931407c0fd95111a23bed541ca6ab45d61171",
49
+ "typesPublisherContentHash": "e5fd2616557bfbf57c649c5db1382eef343781695212d3c2db2ca45ed85ccd5f",
50
50
  "typeScriptVersion": "5.2",
51
51
  "nonNpm": true
52
52
  }