Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/docs-ref-autogen/outlook/outlook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ interfaces:
- outlook!Office.CoercionTypeOptions:interface
- outlook!Office.Contact:interface
- outlook!Office.CustomProperties:interface
- outlook!Office.DecryptedMessageAttachment:interface
- outlook!Office.DecryptedMessageBody:interface
- outlook!Office.DelayDeliveryTime:interface
- outlook!Office.Diagnostics:interface
- outlook!Office.Display:interface
Expand Down Expand Up @@ -55,6 +57,7 @@ interfaces:
- outlook!Office.MeetingSuggestion:interface
- outlook!Office.Message:interface
- outlook!Office.MessageCompose:interface
- outlook!Office.MessageDecryptEventCompletedOptions:interface
- outlook!Office.MessageRead:interface
- outlook!Office.NotificationMessageAction:interface
- outlook!Office.NotificationMessageDetails:interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,12 @@ properties:
**Important**:


- The `contentId` property is only supported in Outlook on the web and the
new Outlook on Windows.
- The `contentId` property is only supported in Outlook on the web and
Outlook on Windows (new and classic (preview)). To preview the `contentId`
property in classic Outlook on Windows, your Outlook client must run
Version 2510 (Build 19312.20000) or later and must be on the Beta Channel.
For more information, see [Microsoft 365 Insider
Program](https://aka.ms/Msft365InsiderProgram)<!-- -->.


- Starting November 15, 2025, changes to how inline images are represented
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
### YamlMime:TSType
name: Office.DecryptedMessageAttachment
uid: outlook!Office.DecryptedMessageAttachment:interface
package: outlook!
fullName: Office.DecryptedMessageAttachment
summary: Represents an attachment in a decrypted message.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read


To learn how to develop an encryption add-in in Outlook, see [Create an
encryption Outlook
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption)<!--
-->.

isPreview: true
isDeprecated: false
type: interface
properties:
- name: attachmentType
uid: outlook!Office.DecryptedMessageAttachment#attachmentType:member
package: outlook!
fullName: attachmentType
summary: Specifies the type of attachment.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'attachmentType: MailboxEnums.AttachmentType;'
return:
type: <xref uid="outlook!Office.MailboxEnums.AttachmentType:enum" />
- name: content
uid: outlook!Office.DecryptedMessageAttachment#content:member
package: outlook!
fullName: content
summary: Specifies the Base64-encoded content of the attachment.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read


**Important**: The `content` property isn't supported by attachments
of type `MailboxEnums.AttachmentType.Cloud`<!-- -->.

isPreview: true
isDeprecated: false
syntax:
content: 'content: string;'
return:
type: string
- name: contentId
uid: outlook!Office.DecryptedMessageAttachment#contentId:member
package: outlook!
fullName: contentId
summary: >-
Specifies the content identifier of an inline attachment.


The `contentId` property must be specified if `isInline` is set to
`true`<!-- -->.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read


**Important**: When images are added to a message as inline
attachments, they're automatically assigned a content ID. In the body of a
message, the content ID of an inline attachment is specified in the `src`
attribute of the `<img>` element (for example, `<img width=96 height=96
id="Picture_1" src="cid:image001.png@01DC1E6F.FC7C7410">`<!-- -->). To
easily identify and provide these inline attachments during decryption, we
recommend saving the content IDs of inline attachments to the message
header during encryption. Call
`Office.context.mailbox.item.getAttachmentsAsync` to get the content ID of
an inline attachment. Then, call
`Office.context.mailbox.item.internetHeaders.setAsync` to save the ID to
the header of the message.

isPreview: true
isDeprecated: false
syntax:
content: 'contentId?: string;'
return:
type: string
- name: isInline
uid: outlook!Office.DecryptedMessageAttachment#isInline:member
package: outlook!
fullName: isInline
summary: >-
If true, specifies that the decrypted attachment appears as an image in
the body of the message instead of in the attachment list. If the
`isInline` property isn't specified, its value is set to false.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'isInline?: boolean;'
return:
type: boolean
- name: name
uid: outlook!Office.DecryptedMessageAttachment#name:member
package: outlook!
fullName: name
summary: Specifies the name of the attachment.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'name: string;'
return:
type: string
- name: path
uid: outlook!Office.DecryptedMessageAttachment#path:member
package: outlook!
fullName: path
summary: >-
Specifies the URL reference path of the attachment if its type is
`MailboxEnums.AttachmentType.Cloud`<!-- -->. The `path` property must be
specified for attachments of type `MailboxEnums.AttachmentType.Cloud`<!--
-->.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'path?: string;'
return:
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
### YamlMime:TSType
name: Office.DecryptedMessageBody
uid: outlook!Office.DecryptedMessageBody:interface
package: outlook!
fullName: Office.DecryptedMessageBody
summary: Represents the body of a decrypted message.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read


To learn how to develop an encryption add-in in Outlook, see [Create an
encryption Outlook
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption)<!--
-->.

isPreview: true
isDeprecated: false
type: interface
properties:
- name: coercionType
uid: outlook!Office.DecryptedMessageBody#coercionType:member
package: outlook!
fullName: coercionType
summary: >-
Specifies the format of the body of a message. The body of a message can
be formatted as `Office.CoercionType.Html` or
`Office.CoercionType.Text`<!-- -->.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'coercionType: Office.CoercionType;'
return:
type: <xref uid="office!Office.CoercionType:enum" />
- name: content
uid: outlook!Office.DecryptedMessageBody#content:member
package: outlook!
fullName: content
summary: Specifies the content displayed in the body of the message.
remarks: >-
\[ [API set: Mailbox
preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
\]


**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**


**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Read

isPreview: true
isDeprecated: false
syntax:
content: 'content: string;'
return:
type: string
21 changes: 14 additions & 7 deletions docs/docs-ref-autogen/outlook/outlook/office.mailboxevent.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ summary: >-
activation](https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation)<!--
-->, including [Smart
Alerts](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events)<!--
-->, or the [integrated spam-reporting
-->, the [integrated spam-reporting
feature](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting)<!--
-->. It allows the add-in to signify to the Outlook client that it has
-->, or
[decryption](https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption)
(preview). It allows the add-in to signify to the Outlook client that it has
completed processing an event.
remarks: >-
\[ [API set: Mailbox
Expand Down Expand Up @@ -57,8 +59,8 @@ methods:
package: outlook!
fullName: completed(options)
summary: >-
Indicates that the event-based or spam-reporting add-in has completed
processing an event.
Indicates that the event-based, spam-reporting, or decryption (preview)
add-in has completed processing an event.
remarks: >-
\[ [API set: Mailbox
1.10](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
Expand Down Expand Up @@ -122,17 +124,22 @@ methods:
syntax:
content: >-
completed(options?: SmartAlertsEventCompletedOptions |
SpamReportingEventCompletedOptions): void;
SpamReportingEventCompletedOptions |
MessageDecryptEventCompletedOptions): void;
parameters:
- id: options
description: >-
Optional. An object that specifies the behavior of an event-based or
spam-reporting add-in when it completes processing an event.
Optional. An object that specifies the behavior of an event-based,
spam-reporting, or decryption add-in when it completes processing an
event.
type: >-
<xref
uid="outlook!Office.SmartAlertsEventCompletedOptions:interface" /> |
<xref
uid="outlook!Office.SpamReportingEventCompletedOptions:interface" />
| <xref
uid="outlook!Office.MessageDecryptEventCompletedOptions:interface"
/>
return:
type: void
description: ''
Loading