Skip to content

Commit 04be8c2

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2450)
Co-authored-by: github-actions <[email protected]>
1 parent 3aa1f40 commit 04be8c2

File tree

125 files changed

+3508
-796
lines changed

Some content is hidden

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

125 files changed

+3508
-796
lines changed

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,42 @@ properties:
7070
type: >-
7171
<xref uid="outlook!Office.MailboxEnums.AttachmentType:enum" /> |
7272
string
73+
- name: contentId
74+
uid: outlook!Office.AttachmentDetails#contentId:member
75+
package: outlook!
76+
fullName: contentId
77+
summary: Gets the content identifier of an inline attachment.
78+
remarks: >-
79+
**Important**:
80+
81+
82+
- The `contentId` property is only supported in Outlook on the web, the
83+
new Outlook on Windows, and classic Outlook on Windows (preview). To
84+
preview the `contentId` property in classic Outlook on Windows, your
85+
Outlook client must run Version 2510 (Build 19312.20000) or later and must
86+
be on the Beta Channel. For more information, see [Microsoft 365 Insider
87+
Program](https://aka.ms/Msft365InsiderProgram)<!-- -->.
88+
89+
90+
- Changes to how inline images are represented in the HTML body of Outlook
91+
emails in Outlook on the web and the new Outlook on Windows released on
92+
November 15, 2025. Previously, the attachment ID of the image appeared in
93+
the `src` attribute of the applicable `<img>` element. Now, the image is
94+
represented by a content ID (`cid`<!-- -->) in the `src` attribute
95+
instead. If you parse the attachment ID from the HTML editor or get the
96+
Base64-encoded value of the image from the URL in the `src` attribute, you
97+
must update your add-in's parsing logic. For more information, see
98+
[Changes to inline image representation in Outlook on the web and new
99+
Outlook for
100+
Windows](https://devblogs.microsoft.com/microsoft365dev/changes-to-inline-images-in-outlook)<!--
101+
-->.
102+
103+
isPreview: false
104+
isDeprecated: false
105+
syntax:
106+
content: 'contentId: string;'
107+
return:
108+
type: string
73109
- name: contentType
74110
uid: outlook!Office.AttachmentDetails#contentType:member
75111
package: outlook!

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

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -129,24 +129,23 @@ properties:
129129
**Important**:
130130
131131
132-
- The `contentId` property is only supported in Outlook on the web and
133-
Outlook on Windows (new and classic (preview)). To preview the `contentId`
134-
property in classic Outlook on Windows, your Outlook client must run
135-
Version 2510 (Build 19312.20000) or later and must be on the Beta Channel.
136-
For more information, see [Microsoft 365 Insider
132+
- The `contentId` property is only supported in Outlook on the web, the
133+
new Outlook on Windows, and classic Outlook on Windows (preview). To
134+
preview the `contentId` property in classic Outlook on Windows, your
135+
Outlook client must run Version 2510 (Build 19312.20000) or later and must
136+
be on the Beta Channel. For more information, see [Microsoft 365 Insider
137137
Program](https://aka.ms/Msft365InsiderProgram)<!-- -->.
138138
139139
140-
- Starting November 15, 2025, changes to how inline images are represented
141-
in the HTML body of Outlook emails in Outlook on the web and the new
142-
Outlook on Windows will begin rolling out to production users. Previously,
143-
the attachment ID of the image appeared in the `src` attribute of the
144-
applicable `<img>` element. After the change, the image will be
140+
- Changes to how inline images are represented in the HTML body of Outlook
141+
emails in Outlook on the web and the new Outlook on Windows released on
142+
November 15, 2025. Previously, the attachment ID of the image appeared in
143+
the `src` attribute of the applicable `<img>` element. Now, the image is
145144
represented by a content ID (`cid`<!-- -->) in the `src` attribute
146-
instead. As a result, you'll need to update your add-in's parsing logic if
147-
you parse the attachment ID from the HTML editor or get the Base64 value
148-
of the image from the URL in the `src` attribute. For more information,
149-
see [Changes to inline image representation in Outlook on the web and new
145+
instead. If you parse the attachment ID from the HTML editor or get the
146+
Base64-encoded value of the image from the URL in the `src` attribute, you
147+
must update your add-in's parsing logic. For more information, see
148+
[Changes to inline image representation in Outlook on the web and new
150149
Outlook for
151150
Windows](https://devblogs.microsoft.com/microsoft365dev/changes-to-inline-images-in-outlook)<!--
152151
-->.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ remarks: >-
3434
3535
const eventData = event.dragAndDropEventData;
3636
console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
37+
console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);
3738
3839
if (eventData.type == "drop") {
3940
console.log("Items dropped into task pane.");

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ remarks: >-
3333
3434
const eventData = event.dragAndDropEventData;
3535
console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
36+
console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);
3637
3738
if (eventData.type == "drop") {
3839
console.log("Items dropped into task pane.");
@@ -93,6 +94,44 @@ properties:
9394
content: 'pageY: number;'
9495
return:
9596
type: number
97+
- name: taskPaneX
98+
uid: outlook!Office.DragoverEventData#taskPaneX:member
99+
package: outlook!
100+
fullName: taskPaneX
101+
summary: >-
102+
Gets the x-coordinate of the mouse pointer that represents the horizontal
103+
position in pixels. The position is relative to the left edge of the
104+
add-in's task pane.
105+
remarks: >-
106+
\[ [API set: Mailbox
107+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
108+
\]
109+
110+
isPreview: false
111+
isDeprecated: false
112+
syntax:
113+
content: 'taskPaneX: number;'
114+
return:
115+
type: number
116+
- name: taskPaneY
117+
uid: outlook!Office.DragoverEventData#taskPaneY:member
118+
package: outlook!
119+
fullName: taskPaneY
120+
summary: >-
121+
Gets the y-coordinate of the mouse pointer that represents the vertical
122+
position in pixels. The position is relative to the top edge of the
123+
add-in's task pane.
124+
remarks: >-
125+
\[ [API set: Mailbox
126+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
127+
\]
128+
129+
isPreview: false
130+
isDeprecated: false
131+
syntax:
132+
content: 'taskPaneY: number;'
133+
return:
134+
type: number
96135
- name: type
97136
uid: outlook!Office.DragoverEventData#type:member
98137
package: outlook!

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ remarks: >-
3333
3434
const eventData = event.dragAndDropEventData;
3535
console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
36+
console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);
3637
3738
if (eventData.type == "drop") {
3839
console.log("Items dropped into task pane.");
@@ -111,6 +112,44 @@ properties:
111112
content: 'pageY: number;'
112113
return:
113114
type: number
115+
- name: taskPaneX
116+
uid: outlook!Office.DropEventData#taskPaneX:member
117+
package: outlook!
118+
fullName: taskPaneX
119+
summary: >-
120+
Gets the x-coordinate of the mouse pointer that represents the horizontal
121+
position in pixels. The position is relative to the left edge of the
122+
add-in's task pane.
123+
remarks: >-
124+
\[ [API set: Mailbox
125+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
126+
\]
127+
128+
isPreview: false
129+
isDeprecated: false
130+
syntax:
131+
content: 'taskPaneX: number;'
132+
return:
133+
type: number
134+
- name: taskPaneY
135+
uid: outlook!Office.DropEventData#taskPaneY:member
136+
package: outlook!
137+
fullName: taskPaneY
138+
summary: >-
139+
Gets the y-coordinate of the mouse pointer that represents the vertical
140+
position in pixels. The position is relative to the top edge of the
141+
add-in's task pane.
142+
remarks: >-
143+
\[ [API set: Mailbox
144+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
145+
\]
146+
147+
isPreview: false
148+
isDeprecated: false
149+
syntax:
150+
content: 'taskPaneY: number;'
151+
return:
152+
type: number
114153
- name: type
115154
uid: outlook!Office.DropEventData#type:member
116155
package: outlook!

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ remarks: >-
3333
3434
const eventData = event.dragAndDropEventData;
3535
console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
36+
console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);
3637
3738
if (eventData.type == "drop") {
3839
console.log("Items dropped into task pane.");

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ remarks: >-
3333
3434
const eventData = event.dragAndDropEventData;
3535
console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
36+
console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);
3637
3738
if (eventData.type == "drop") {
3839
console.log("Items dropped into task pane.");

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

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -348,9 +348,13 @@ properties:
348348
349349
350350
- The `from` and `sender` properties represent the same person unless the
351-
message is sent by a delegate. In that case, the `from` property
352-
represents the delegator, and the `sender` property represents the
353-
delegate.
351+
message is sent by a delegate with **Send on behalf** permissions. In
352+
this case, the `from` property returns the delegator's email address and
353+
the `sender` property returns the delegate's address. For information
354+
about mailbox delegation, see [Manage permissions for recipients in
355+
Exchange
356+
Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients)<!--
357+
-->.
354358
355359
356360
- The `recipientType` property of the `EmailAddressDetails` object in the
@@ -671,9 +675,13 @@ properties:
671675
672676
673677
- The `from` and `sender` properties represent the same person unless the
674-
message is sent by a delegate. In that case, the `from` property
675-
represents the delegator, and the `sender` property represents the
676-
delegate.
678+
message is sent by a delegate with **Send on behalf** permissions. In
679+
this case, the `from` property returns the delegator's email address and
680+
the `sender` property returns the delegate's address. For information
681+
about mailbox delegation, see [Manage permissions for recipients in
682+
Exchange
683+
Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients)<!--
684+
-->.
677685
678686
679687
- The `recipientType` property of the `EmailAddressDetails` object in the

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

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -606,20 +606,9 @@ properties:
606606
uid: outlook!Office.MessageRead#from:member
607607
package: outlook!
608608
fullName: from
609-
summary: >-
609+
summary: |-
610610
Gets the email address of the sender of a message.
611611
612-
613-
The `from` and `sender` properties represent the same person unless the
614-
message is sent by a delegate. In that case, the `from` property
615-
represents the delegator, and the `sender` property represents the
616-
delegate.
617-
618-
619-
**Note**: The `recipientType` property of the `EmailAddressDetails`
620-
object in the `from` property is undefined.
621-
622-
623612
The `from` property returns an `EmailAddressDetails` object.
624613
remarks: >-
625614
**[Minimum permission
@@ -632,6 +621,23 @@ properties:
632621
-->**: Message Read
633622
634623
624+
**Important**:
625+
626+
627+
- The `from` and `sender` properties represent the same person unless the
628+
message is sent by a delegate with **Send on behalf** permissions. In
629+
this case, the `from` property returns the delegator's email address and
630+
the `sender` property returns the delegate's address. For information
631+
about mailbox delegation, see [Manage permissions for recipients in
632+
Exchange
633+
Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients)<!--
634+
-->.
635+
636+
637+
- The `recipientType` property of the `EmailAddressDetails` object in the
638+
`from` property is undefined.
639+
640+
635641
#### Examples
636642
637643
@@ -1203,18 +1209,7 @@ properties:
12031209
uid: outlook!Office.MessageRead#sender:member
12041210
package: outlook!
12051211
fullName: sender
1206-
summary: >-
1207-
Gets the email address of the sender of an email message.
1208-
1209-
1210-
The `from` and `sender` properties represent the same person unless the
1211-
message is sent by a delegate. In that case, the `from` property
1212-
represents the delegator, and the `sender` property represents the
1213-
delegate.
1214-
1215-
1216-
**Note**: The `recipientType` property of the `EmailAddressDetails`
1217-
object in the `sender` property is undefined.
1212+
summary: Gets the email address of the sender of an email message.
12181213
remarks: >-
12191214
**[Minimum permission
12201215
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
@@ -1226,6 +1221,23 @@ properties:
12261221
-->**: Message Read
12271222
12281223
1224+
**Important**:
1225+
1226+
1227+
- The `from` and `sender` properties represent the same person unless the
1228+
message is sent by a delegate with **Send on behalf** permissions. In
1229+
this case, the `from` property returns the delegator's email address and
1230+
the `sender` property returns the delegate's address. For information
1231+
about mailbox delegation, see [Manage permissions for recipients in
1232+
Exchange
1233+
Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients)<!--
1234+
-->.
1235+
1236+
1237+
- The `recipientType` property of the `EmailAddressDetails` object in the
1238+
`sender` property is undefined.
1239+
1240+
12291241
#### Examples
12301242
12311243

docs/docs-ref-autogen/outlook_1_1/outlook/office.attachmentdetails.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,42 @@ properties:
7070
type: >-
7171
<xref uid="outlook!Office.MailboxEnums.AttachmentType:enum" /> |
7272
string
73+
- name: contentId
74+
uid: outlook!Office.AttachmentDetails#contentId:member
75+
package: outlook!
76+
fullName: contentId
77+
summary: Gets the content identifier of an inline attachment.
78+
remarks: >-
79+
**Important**:
80+
81+
82+
- The `contentId` property is only supported in Outlook on the web, the
83+
new Outlook on Windows, and classic Outlook on Windows (preview). To
84+
preview the `contentId` property in classic Outlook on Windows, your
85+
Outlook client must run Version 2510 (Build 19312.20000) or later and must
86+
be on the Beta Channel. For more information, see [Microsoft 365 Insider
87+
Program](https://aka.ms/Msft365InsiderProgram)<!-- -->.
88+
89+
90+
- Changes to how inline images are represented in the HTML body of Outlook
91+
emails in Outlook on the web and the new Outlook on Windows released on
92+
November 15, 2025. Previously, the attachment ID of the image appeared in
93+
the `src` attribute of the applicable `<img>` element. Now, the image is
94+
represented by a content ID (`cid`<!-- -->) in the `src` attribute
95+
instead. If you parse the attachment ID from the HTML editor or get the
96+
Base64-encoded value of the image from the URL in the `src` attribute, you
97+
must update your add-in's parsing logic. For more information, see
98+
[Changes to inline image representation in Outlook on the web and new
99+
Outlook for
100+
Windows](https://devblogs.microsoft.com/microsoft365dev/changes-to-inline-images-in-outlook)<!--
101+
-->.
102+
103+
isPreview: false
104+
isDeprecated: false
105+
syntax:
106+
content: 'contentId: string;'
107+
return:
108+
type: string
73109
- name: contentType
74110
uid: outlook!Office.AttachmentDetails#contentType:member
75111
package: outlook!

0 commit comments

Comments
 (0)