@@ -339,10 +339,7 @@ methods:
339
339
package : outlook!
340
340
fullName : getAsync(coercionType, options, callback)
341
341
summary : >-
342
- Returns the current body in a specified format.
343
-
344
-
345
- This method returns the entire current body in the format specified by
342
+ Returns the entire current body in the format specified by
346
343
`coercionType`<!-- -->.
347
344
remarks : >-
348
345
\[ [API set: Mailbox
@@ -377,6 +374,29 @@ methods:
377
374
Otherwise, you may receive an unexpected value, such as an empty string.
378
375
379
376
377
+ - In Outlook on the web and new Outlook on Windows, users can organize
378
+ their messages as conversations or individual messages in **Settings**
379
+ > **Mail** > **Layout** > **Message organization**
380
+ (see [Change how the message list is displayed in
381
+ Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
382
+ -->). This setting affects how much of a message's body is displayed to
383
+ the user (that is, the entire conversation thread of a message or just the
384
+ current message). In Message Compose mode, particulary for replies to a
385
+ conversation thread with more than one message, if you want the returned
386
+ body to reflect the user's setting, specify the `bodyMode:
387
+ Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync`
388
+ call. If messages are grouped by conversation, only the body of the
389
+ current reply is returned. Conversely, if messages are displayed
390
+ individually, the entire conversation thread is returned.
391
+
392
+
393
+ - The `bodyMode` option isn't supported on a message that's loaded using
394
+ the `loadItemByIdAsync` method. For more information, see [Activate your
395
+ Outlook add-in on multiple
396
+ messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!--
397
+ -->.
398
+
399
+
380
400
#### Examples
381
401
382
402
@@ -407,18 +427,28 @@ methods:
407
427
syntax :
408
428
content : >-
409
429
getAsync(coercionType: Office.CoercionType | string, options:
410
- Office.AsyncContextOptions, callback ?: (asyncResult:
411
- Office.AsyncResult<string>) => void): void;
430
+ Office.AsyncContextOptions & { bodyMode ?: MailboxEnums.BodyMode },
431
+ callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
412
432
parameters :
413
433
- id : coercionType
414
434
description : The format for the returned body.
415
435
type : <xref uid="office!Office.CoercionType:enum" /> | string
416
436
- id : options
417
437
description : >-
418
438
An object literal that contains one or more of the following
419
- properties:- `asyncContext`<!-- -->: Developers can provide any
420
- object they wish to access in the callback function.
421
- type : <xref uid="office!Office.AsyncContextOptions:interface" />
439
+ properties. `asyncContext`<!-- -->: Any data you want to access in
440
+ the callback function. `bodyMode`<!-- -->: In Outlook on the web and
441
+ new Outlook on Windows, specifies whether only the body of the
442
+ current message or the entire body of a message conversation is
443
+ returned. If a value isn't specified, `bodyMode` defaults to
444
+ `Office.MailboxEnums.BodyMode.FullBody`<!-- -->, which returns the
445
+ entire body of a message conversation. The `bodyMode` property only
446
+ applies to replies on the Message Compose surface. It's ignored in
447
+ Outlook on Windows (classic), on Mac, and on mobile devices.
448
+ type : >-
449
+ <xref uid="office!Office.AsyncContextOptions:interface" /> & {
450
+ bodyMode?: <xref uid="outlook!Office.MailboxEnums.BodyMode:enum" />
451
+ }
422
452
- id : callback
423
453
description : >-
424
454
Optional. When the method completes, the function passed in the
@@ -436,10 +466,7 @@ methods:
436
466
package : outlook!
437
467
fullName : getAsync(coercionType, callback)
438
468
summary : >-
439
- Returns the current body in a specified format.
440
-
441
-
442
- This method returns the entire current body in the format specified by
469
+ Returns the entire current body in the format specified by
443
470
`coercionType`<!-- -->.
444
471
remarks : >-
445
472
\[ [API set: Mailbox
@@ -474,6 +501,22 @@ methods:
474
501
Otherwise, you may receive an unexpected value, such as an empty string.
475
502
476
503
504
+ - In Outlook on the web and new Outlook on Windows, users can organize
505
+ their messages as conversations or individual messages in **Settings**
506
+ > **Mail** > **Layout** > **Message organization**
507
+ (see [Change how the message list is displayed in
508
+ Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
509
+ -->). This setting affects how much of a message's body is displayed to
510
+ the user (that is, the entire conversation thread of a message or just the
511
+ current message). In Message Compose mode, particulary for replies to a
512
+ conversation thread with more than one message, if you want the returned
513
+ body to reflect the user's setting, specify the `bodyMode:
514
+ Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync`
515
+ call. If messages are grouped by conversation, only the body of the
516
+ current reply is returned. Conversely, if messages are displayed
517
+ individually, the entire conversation thread is returned.
518
+
519
+
477
520
#### Examples
478
521
479
522
@@ -1265,6 +1308,35 @@ methods:
1265
1308
-->.
1266
1309
1267
1310
1311
+ - In Outlook on the web and new Outlook on Windows, users can organize
1312
+ their messages as conversations or individual messages in **Settings**
1313
+ > **Mail** > **Layout** > **Message organization**
1314
+ (see [Change how the message list is displayed in
1315
+ Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
1316
+ -->). This setting affects how much of a message's body is displayed to
1317
+ the user (that is, the entire conversation thread of a message or just the
1318
+ current message). In Message Compose mode, particulary for replies to a
1319
+ conversation thread with more than one message, if you want to honor the
1320
+ user's settings when setting the body of a message, specify the `bodyMode:
1321
+ Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync`
1322
+ call. If messages are grouped by conversation, only the body of the
1323
+ current reply is set. Conversely, if messages are displayed individually,
1324
+ the entire body, including previous messages in the conversation thread,
1325
+ is replaced.
1326
+
1327
+
1328
+ - In Outlook on the web and new Outlook on Windows, if the `bodyMode`
1329
+ property isn't specified or is set to
1330
+ `Office.MailboxEnums.BodyMode.FullBody`<!-- -->, the entire body of a
1331
+ message, including previous messages from the conversation thread, is
1332
+ replaced. This applies even if a user's messages are organized by
1333
+ conversation. In this scenario, the user's setting is temporarily changed
1334
+ to **Individual messages: Do not group messages** > **Only a
1335
+ single message** or **Show email as individual messages** during the
1336
+ `setAsync` call. A notification is shown to the user to alert them to this
1337
+ change. Once the call completes, the user's setting is reinstated.
1338
+
1339
+
1268
1340
**Errors**:
1269
1341
1270
1342
@@ -1353,24 +1425,33 @@ methods:
1353
1425
syntax :
1354
1426
content : >-
1355
1427
setAsync(data: string, options: Office.AsyncContextOptions &
1356
- CoercionTypeOptions, callback ?: (asyncResult: Office.AsyncResult<void>)
1357
- => void): void;
1428
+ CoercionTypeOptions & { bodyMode ?: MailboxEnums.BodyMode }, callback?:
1429
+ (asyncResult: Office.AsyncResult<void>) => void): void;
1358
1430
parameters :
1359
1431
- id : data
1360
1432
description : >-
1361
- The string that will replace the existing body. The string is
1362
- limited to 1,000,000 characters.
1433
+ The string that replaces the existing body. The string is limited to
1434
+ 1,000,000 characters.
1363
1435
type : string
1364
1436
- id : options
1365
1437
description : >-
1366
1438
An object literal that contains one or more of the following
1367
- properties:- `asyncContext`<!-- -->: Developers can provide any
1368
- object they wish to access in the callback function.
1369
- `coercionType`<!-- -->: The desired format for the body. The string
1370
- in the `data` parameter will be converted to this format.
1439
+ properties. `asyncContext`<!-- -->: Any data you want to access in
1440
+ the callback function. `coercionType`<!-- -->: The desired format
1441
+ for the body. The string in the `data` parameter is converted to
1442
+ this format. `bodyMode`<!-- -->: In Outlook on the web and new
1443
+ Outlook on Windows, specifies whether only the body of the current
1444
+ message or the entire body of a message conversation is set. If a
1445
+ value isn't specified, `bodyMode` defaults to
1446
+ `Office.MailboxEnums.BodyMode.FullBody`<!-- -->, which replaces the
1447
+ entire body, including previous messages in the conversation thread.
1448
+ The `bodyMode` property only applies to replies on the Message
1449
+ Compose surface. It's ignored in Outlook on Windows (classic), on
1450
+ Mac, and on mobile devices.
1371
1451
type : >-
1372
1452
<xref uid="office!Office.AsyncContextOptions:interface" /> & <xref
1373
- uid="outlook!Office.CoercionTypeOptions:interface" />
1453
+ uid="outlook!Office.CoercionTypeOptions:interface" /> & { bodyMode?:
1454
+ <xref uid="outlook!Office.MailboxEnums.BodyMode:enum" /> }
1374
1455
- id : callback
1375
1456
description : >-
1376
1457
Optional. When the method completes, the function passed in the
@@ -1461,6 +1542,35 @@ methods:
1461
1542
-->.
1462
1543
1463
1544
1545
+ - In Outlook on the web and new Outlook on Windows, users can organize
1546
+ their messages as conversations or individual messages in **Settings**
1547
+ > **Mail** > **Layout** > **Message organization**
1548
+ (see [Change how the message list is displayed in
1549
+ Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
1550
+ -->). This setting affects how much of a message's body is displayed to
1551
+ the user (that is, the entire conversation thread of a message or just the
1552
+ current message). In Message Compose mode, particulary for replies in a
1553
+ conversation thread with more than one message, if you want to honor the
1554
+ user's settings when setting the body of a message, specify the `bodyMode:
1555
+ Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync`
1556
+ call. If messages are grouped by conversation, only the body of the
1557
+ current reply is set. Conversely, if messages are displayed individually,
1558
+ the entire body, including previous messages in the conversation thread,
1559
+ is replaced.
1560
+
1561
+
1562
+ - In Outlook on the web and new Outlook on Windows, if the `bodyMode`
1563
+ property isn't specified or is set to
1564
+ `Office.MailboxEnums.BodyMode.FullBody`<!-- -->, the entire body of a
1565
+ message, including previous messages from the conversation thread, is
1566
+ replaced. This applies even if a user's messages are organized by
1567
+ conversation. In this scenario, the user's setting is temporarily changed
1568
+ to **Individual messages: Do not group messages** > **Only a
1569
+ single message** or **Show email as individual messages** during the
1570
+ `setAsync` call. A notification is shown to the user to alert them to this
1571
+ change. Once the call completes, the user's setting is reinstated.
1572
+
1573
+
1464
1574
**Errors**:
1465
1575
1466
1576
0 commit comments