Skip to content

Commit 73dca17

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents 4b42370 + cf25be2 commit 73dca17

File tree

203 files changed

+1025
-710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

203 files changed

+1025
-710
lines changed

docs/docs-ref-autogen/office/office/office.context.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,9 @@ properties:
205205
fullName: diagnostics
206206
summary: Gets information about the environment in which the add-in is running.
207207
remarks: >-
208-
**Important**: In Outlook, this property is available from Mailbox
209-
requirement set 1.5. For all Mailbox requirement sets, you can use the
208+
**Important**: In Outlook, this property is available starting with
209+
Mailbox requirement set 1.5. For all Mailbox requirement sets, you can use
210+
the
210211
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member)
211212
property to get similar information.
212213
@@ -348,10 +349,10 @@ properties:
348349
fullName: host
349350
summary: Contains the Office application in which the add-in is running.
350351
remarks: >-
351-
**Important**: In Outlook, this property is available from Mailbox
352-
requirement set 1.5. You can also use the `Office.context.diagnostics`
353-
property to get the application starting with requirement set 1.5. For all
354-
Mailbox requirement sets, you can use the
352+
**Important**: In Outlook, this property is available starting with
353+
Mailbox requirement set 1.5. You can also use the
354+
`Office.context.diagnostics` property to get the application starting with
355+
requirement set 1.5. For all Mailbox requirement sets, you can use the
355356
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member)
356357
property to get similar information.
357358
@@ -569,10 +570,10 @@ properties:
569570
**Important**:
570571
571572
572-
- In Outlook, this property is available from Mailbox requirement set 1.5.
573-
You can also use the `Office.context.diagnostics` property to get the
574-
platform starting with requirement set 1.5. For all Mailbox requirement
575-
sets, you can use the
573+
- In Outlook, this property is available starting with Mailbox requirement
574+
set 1.5. You can also use the `Office.context.diagnostics` property to get
575+
the platform starting with requirement set 1.5. For all Mailbox
576+
requirement sets, you can use the
576577
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member)
577578
property to get similar information.
578579

docs/docs-ref-autogen/office/office/office.contextinformation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package: office!
55
fullName: Office.ContextInformation
66
summary: Provides information about the environment in which the add-in is running.
77
remarks: >-
8-
**Important**: In Outlook, this object is available from Mailbox
8+
**Important**: In Outlook, this object is available starting with Mailbox
99
requirement set 1.5. For all Mailbox requirement sets, you can use the
1010
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member)
1111
property to get similar information.

docs/docs-ref-autogen/office/office/office.hosttype.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ package: office!
55
fullName: Office.HostType
66
summary: Specifies the Office application in which the add-in is running.
77
remarks: >-
8-
**Important**: In Outlook, this enum is available from Mailbox requirement
9-
set 1.5.
8+
**Important**: In Outlook, this enum is available starting with Mailbox
9+
requirement set 1.5.
1010
1111
1212
#### Examples

docs/docs-ref-autogen/office/office/office.platformtype.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ package: office!
55
fullName: Office.PlatformType
66
summary: Specifies the OS or other platform on which the Office application is running.
77
remarks: >-
8-
**Important**: In Outlook, this enum is available from Mailbox requirement
9-
set 1.5.
8+
**Important**: In Outlook, this enum is available starting with Mailbox
9+
requirement set 1.5.
1010
1111
1212
#### Examples

docs/docs-ref-autogen/office_release/office/office.context.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,9 @@ properties:
174174
fullName: diagnostics
175175
summary: Gets information about the environment in which the add-in is running.
176176
remarks: >-
177-
**Important**: In Outlook, this property is available from Mailbox
178-
requirement set 1.5. For all Mailbox requirement sets, you can use the
177+
**Important**: In Outlook, this property is available starting with
178+
Mailbox requirement set 1.5. For all Mailbox requirement sets, you can use
179+
the
179180
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member)
180181
property to get similar information.
181182
@@ -317,10 +318,10 @@ properties:
317318
fullName: host
318319
summary: Contains the Office application in which the add-in is running.
319320
remarks: >-
320-
**Important**: In Outlook, this property is available from Mailbox
321-
requirement set 1.5. You can also use the `Office.context.diagnostics`
322-
property to get the application starting with requirement set 1.5. For all
323-
Mailbox requirement sets, you can use the
321+
**Important**: In Outlook, this property is available starting with
322+
Mailbox requirement set 1.5. You can also use the
323+
`Office.context.diagnostics` property to get the application starting with
324+
requirement set 1.5. For all Mailbox requirement sets, you can use the
324325
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member)
325326
property to get similar information.
326327
@@ -538,10 +539,10 @@ properties:
538539
**Important**:
539540
540541
541-
- In Outlook, this property is available from Mailbox requirement set 1.5.
542-
You can also use the `Office.context.diagnostics` property to get the
543-
platform starting with requirement set 1.5. For all Mailbox requirement
544-
sets, you can use the
542+
- In Outlook, this property is available starting with Mailbox requirement
543+
set 1.5. You can also use the `Office.context.diagnostics` property to get
544+
the platform starting with requirement set 1.5. For all Mailbox
545+
requirement sets, you can use the
545546
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member)
546547
property to get similar information.
547548

docs/docs-ref-autogen/office_release/office/office.contextinformation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package: office!
55
fullName: Office.ContextInformation
66
summary: Provides information about the environment in which the add-in is running.
77
remarks: >-
8-
**Important**: In Outlook, this object is available from Mailbox
8+
**Important**: In Outlook, this object is available starting with Mailbox
99
requirement set 1.5. For all Mailbox requirement sets, you can use the
1010
[Office.context.mailbox.diagnostics](https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member)
1111
property to get similar information.

docs/docs-ref-autogen/office_release/office/office.hosttype.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ package: office!
55
fullName: Office.HostType
66
summary: Specifies the Office application in which the add-in is running.
77
remarks: >-
8-
**Important**: In Outlook, this enum is available from Mailbox requirement
9-
set 1.5.
8+
**Important**: In Outlook, this enum is available starting with Mailbox
9+
requirement set 1.5.
1010
1111
1212
#### Examples

docs/docs-ref-autogen/office_release/office/office.platformtype.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ package: office!
55
fullName: Office.PlatformType
66
summary: Specifies the OS or other platform on which the Office application is running.
77
remarks: >-
8-
**Important**: In Outlook, this enum is available from Mailbox requirement
9-
set 1.5.
8+
**Important**: In Outlook, this enum is available starting with Mailbox
9+
requirement set 1.5.
1010
1111
1212
#### Examples

docs/docs-ref-autogen/outlook/outlook/office.attachmentdetailscompose.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,61 @@ remarks: >-
2323
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
2424
-->**: Compose
2525
26+
27+
#### Examples
28+
29+
30+
```TypeScript
31+
32+
// Link to full sample:
33+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
34+
35+
36+
Office.context.mailbox.item.getAttachmentsAsync((result) => {
37+
if (result.status === Office.AsyncResultStatus.Failed) {
38+
console.error(result.error.message);
39+
return;
40+
}
41+
42+
if (result.value.length > 0) {
43+
for (let i = 0; i < result.value.length; i++) {
44+
const attachment = result.value[i];
45+
let attachmentType;
46+
switch (attachment.attachmentType) {
47+
case Office.MailboxEnums.AttachmentType.Cloud:
48+
attachmentType = "Attachment is stored in a cloud location";
49+
break;
50+
case Office.MailboxEnums.AttachmentType.File:
51+
attachmentType = "Attachment is a file";
52+
break;
53+
case Office.MailboxEnums.AttachmentType.Item:
54+
attachmentType = "Attachment is an Exchange item";
55+
break;
56+
}
57+
console.log(
58+
"ID: " +
59+
attachment.id +
60+
"\n" +
61+
"Type: " +
62+
attachmentType +
63+
"\n" +
64+
"Name: " +
65+
attachment.name +
66+
"\n" +
67+
"Size: " +
68+
attachment.size +
69+
"\n" +
70+
"isInline: " +
71+
attachment.isInline
72+
);
73+
}
74+
} else {
75+
console.log("No attachments on this message.");
76+
}
77+
});
78+
79+
```
80+
2681
isPreview: false
2782
isDeprecated: false
2883
type: interface

docs/docs-ref-autogen/outlook/outlook/office.body.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -375,9 +375,10 @@ methods:
375375
376376
- In Outlook on the web and [new Outlook on
377377
Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!--
378-
-->, if the body contains formatted elements, such as tables, lists, and
379-
links, specify `Office.CoercionType.Html` in the `getAsync` call.
380-
Otherwise, you may receive an unexpected value, such as an empty string.
378+
-->, specifying `Office.CoercionType.Text` in the `getAsync` call may not
379+
always provide reliable formatting. Specify `Office.CoercionType.Html`
380+
instead especially if the body contains formatted elements, such as
381+
tables, lists, and links.
381382
382383
383384
- In Outlook on the web and new Outlook on Windows, users can organize
@@ -476,9 +477,10 @@ methods:
476477
477478
- In Outlook on the web and [new Outlook on
478479
Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!--
479-
-->, if the body contains formatted elements, such as tables, lists, and
480-
links, specify `Office.CoercionType.Html` in the `getAsync` call.
481-
Otherwise, you may receive an unexpected value, such as an empty string.
480+
-->, specifying `Office.CoercionType.Text` in the `getAsync` call may not
481+
always provide reliable formatting. Specify `Office.CoercionType.Html`
482+
instead especially if the body contains formatted elements, such as
483+
tables, lists, and links.
482484
483485
484486
- In Outlook on the web and new Outlook on Windows, users can organize

0 commit comments

Comments
 (0)