From 9dde2dbac6049eb4ac0980de3a7fd82b3279e5a7 Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Thu, 9 Oct 2025 16:38:51 -0700 Subject: [PATCH] Get latest --- docs/docs-ref-autogen/outlook/outlook.yml | 3 + .../office.attachmentdetailscompose.yml | 8 +- .../office.decryptedmessageattachment.yml | 217 +++++++++++++++ .../outlook/office.decryptedmessagebody.yml | 86 ++++++ .../outlook/outlook/office.mailboxevent.yml | 21 +- ...ce.messagedecrypteventcompletedoptions.yml | 173 ++++++++++++ docs/docs-ref-autogen/outlook/toc.yml | 6 + .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- .../office.attachmentdetailscompose.yml | 8 +- docs/includes/outlook-preview.md | 12 + generate-docs/API Coverage Report.csv | 15 + .../Outlook_1_10/outlook.d.ts | 4 +- .../Outlook_1_11/outlook.d.ts | 4 +- .../Outlook_1_12/outlook.d.ts | 4 +- .../Outlook_1_13/outlook.d.ts | 4 +- .../Outlook_1_14/outlook.d.ts | 4 +- .../Outlook_1_15/outlook.d.ts | 4 +- .../Outlook_1_8/outlook.d.ts | 4 +- .../Outlook_1_9/outlook.d.ts | 4 +- .../api-extractor-inputs-outlook/outlook.d.ts | 258 +++++++++++++++++- generate-docs/script-inputs/office.d.ts | 4 +- .../script-inputs/office_preview.d.ts | 258 +++++++++++++++++- 28 files changed, 1111 insertions(+), 46 deletions(-) create mode 100644 docs/docs-ref-autogen/outlook/outlook/office.decryptedmessageattachment.yml create mode 100644 docs/docs-ref-autogen/outlook/outlook/office.decryptedmessagebody.yml create mode 100644 docs/docs-ref-autogen/outlook/outlook/office.messagedecrypteventcompletedoptions.yml diff --git a/docs/docs-ref-autogen/outlook/outlook.yml b/docs/docs-ref-autogen/outlook/outlook.yml index f63df79857..730678f6d4 100644 --- a/docs/docs-ref-autogen/outlook/outlook.yml +++ b/docs/docs-ref-autogen/outlook/outlook.yml @@ -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 @@ -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 diff --git a/docs/docs-ref-autogen/outlook/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook/outlook/office.attachmentdetailscompose.yml index 70374f2b9d..afc645d87d 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.attachmentdetailscompose.yml @@ -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 diff --git a/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessageattachment.yml b/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessageattachment.yml new file mode 100644 index 0000000000..d4fdd63bf4 --- /dev/null +++ b/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessageattachment.yml @@ -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: + - 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 `` element (for example, ``). 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 diff --git a/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessagebody.yml b/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessagebody.yml new file mode 100644 index 0000000000..5bb9322ac9 --- /dev/null +++ b/docs/docs-ref-autogen/outlook/outlook/office.decryptedmessagebody.yml @@ -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: + - 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 diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailboxevent.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailboxevent.yml index 09974a5b69..3fd060b432 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.mailboxevent.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.mailboxevent.yml @@ -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 @@ -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) @@ -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: >- | + | return: type: void description: '' diff --git a/docs/docs-ref-autogen/outlook/outlook/office.messagedecrypteventcompletedoptions.yml b/docs/docs-ref-autogen/outlook/outlook/office.messagedecrypteventcompletedoptions.yml new file mode 100644 index 0000000000..2bb85a2785 --- /dev/null +++ b/docs/docs-ref-autogen/outlook/outlook/office.messagedecrypteventcompletedoptions.yml @@ -0,0 +1,173 @@ +### YamlMime:TSType +name: Office.MessageDecryptEventCompletedOptions +uid: outlook!Office.MessageDecryptEventCompletedOptions:interface +package: outlook! +fullName: Office.MessageDecryptEventCompletedOptions +summary: >- + Specifies the behavior of an [encryption + add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption) + after it completes processing an + [OnMessageRead](https://learn.microsoft.com/javascript/api/office/office.eventtype#fields) + event. +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 +type: interface +properties: + - name: allowEvent + uid: outlook!Office.MessageDecryptEventCompletedOptions#allowEvent:member + package: outlook! + fullName: allowEvent + summary: >- + When you use the [completed + method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1)) + to signal completion of an event handler, this value indicates if the + `OnMessageRead` event should continue to run or be canceled. If the + `allowEvent` property is set to `true`, the decrypted contents of + the message is displayed. + 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: 'allowEvent: boolean;' + return: + type: boolean + - name: attachments + uid: outlook!Office.MessageDecryptEventCompletedOptions#attachments:member + package: outlook! + fullName: attachments + summary: >- + When you use the [completed + method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1)) + to signal completion of an event handler and set its `allowEvent` property + to `true`, this property sets the decrypted attachments 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: 'attachments?: DecryptedMessageAttachment[];' + return: + type: [] + - name: contextData + uid: outlook!Office.MessageDecryptEventCompletedOptions#contextData:member + package: outlook! + fullName: contextData + summary: >- + When you use the [completed + method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1)) + to signal completion of an event handler and set its `allowEvent` property + to `true`, this property specifies any JSON data passed to the + add-in for processing. + 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**: + + + - To retrieve the value of the `contextData` property, you must call + `Office.context.mailbox.item.getInitializationContextAsync`. If + you create a JSON string using `JSON.stringify()` and assign it to the + `contextData` property, you must parse the string using `JSON.parse()` + once you retrieve it. + + + - You can use the `contextData` property to store custom internet headers + to decrypt messages in reply and forward scenarios. + + isPreview: true + isDeprecated: false + syntax: + content: 'contextData?: any;' + return: + type: any + - name: emailBody + uid: outlook!Office.MessageDecryptEventCompletedOptions#emailBody:member + package: outlook! + fullName: emailBody + summary: >- + When you use the [completed + method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1)) + to signal completion of an event handler and set its `allowEvent` property + to `true`, this property sets the decrypted contents of 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 + + + **Important**: If the `emailBody` property isn't specified, an empty + body is returned. + + isPreview: true + isDeprecated: false + syntax: + content: 'emailBody?: DecryptedMessageBody;' + return: + type: diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index 5f37a53bd1..00f9ebde2c 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -97,6 +97,10 @@ items: uid: outlook!Office.Contact:interface - name: CustomProperties uid: outlook!Office.CustomProperties:interface + - name: DecryptedMessageAttachment + uid: outlook!Office.DecryptedMessageAttachment:interface + - name: DecryptedMessageBody + uid: outlook!Office.DecryptedMessageBody:interface - name: DelayDeliveryTime uid: outlook!Office.DelayDeliveryTime:interface - name: Diagnostics @@ -163,6 +167,8 @@ items: uid: outlook!Office.MeetingSuggestion:interface - name: MessageCompose uid: outlook!Office.MessageCompose:interface + - name: MessageDecryptEventCompletedOptions + uid: outlook!Office.MessageDecryptEventCompletedOptions:interface - name: MessageRead uid: outlook!Office.MessageRead:interface - name: NotificationMessageAction diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.attachmentdetailscompose.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.attachmentdetailscompose.yml index 78087aba5d..241c91b925 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.attachmentdetailscompose.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.attachmentdetailscompose.yml @@ -131,8 +131,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 diff --git a/docs/includes/outlook-preview.md b/docs/includes/outlook-preview.md index 21f1a57fe5..9e3c2d3d5e 100644 --- a/docs/includes/outlook-preview.md +++ b/docs/includes/outlook-preview.md @@ -2,6 +2,14 @@ |:---|:---|:---| |[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[isAllDayEvent](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isalldayevent-member)|Gets or sets the Office.IsAllDayEvent property of an appointment.| |[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[isAllDayEvent](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-isalldayevent-member)|Returns a boolean value indicating whether the event is all day.| +|[DecryptedMessageAttachment](/javascript/api/outlook/office.decryptedmessageattachment)|[attachmentType](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-attachmenttype-member)|Specifies the type of attachment.| +||[content](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-content-member)|Specifies the Base64-encoded content of the attachment.| +||[contentId](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-contentid-member)|Specifies the content identifier of an inline attachment.| +||[isInline](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-isinline-member)|If true, specifies that the decrypted attachment appears as an image in the body of the message instead of in the attachment list.| +||[name](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-name-member)|Specifies the name of the attachment.| +||[path](/javascript/api/outlook/office.decryptedmessageattachment#outlook-office-decryptedmessageattachment-path-member)|Specifies the URL reference path of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`.| +|[DecryptedMessageBody](/javascript/api/outlook/office.decryptedmessagebody)|[coercionType](/javascript/api/outlook/office.decryptedmessagebody#outlook-office-decryptedmessagebody-coerciontype-member)|Specifies the format of the body of a message.| +||[content](/javascript/api/outlook/office.decryptedmessagebody#outlook-office-decryptedmessagebody-content-member)|Specifies the content displayed in the body of the message.| |[Display](/javascript/api/outlook/office.display)|[body](/javascript/api/outlook/office.display#outlook-office-display-body-member)|Gets an object to temporarily set the content displayed in the body of a message in read mode.| ||[subject](/javascript/api/outlook/office.display#outlook-office-display-subject-member)|Gets an object to temporarily set the content displayed in the subject of a message in read mode.| |[DisplayedBody](/javascript/api/outlook/office.displayedbody)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedbody#outlook-office-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| @@ -12,4 +20,8 @@ ||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| ||[setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| ||[setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| +|[MessageDecryptEventCompletedOptions](/javascript/api/outlook/office.messagedecrypteventcompletedoptions)|[allowEvent](/javascript/api/outlook/office.messagedecrypteventcompletedoptions#outlook-office-messagedecrypteventcompletedoptions-allowevent-member)|When you use the completed method to signal completion of an event handler,| +||[attachments](/javascript/api/outlook/office.messagedecrypteventcompletedoptions#outlook-office-messagedecrypteventcompletedoptions-attachments-member)|When you use the completed method to signal completion of an event handler| +||[contextData](/javascript/api/outlook/office.messagedecrypteventcompletedoptions#outlook-office-messagedecrypteventcompletedoptions-contextdata-member)|When you use the completed method to signal completion of an event handler| +||[emailBody](/javascript/api/outlook/office.messagedecrypteventcompletedoptions#outlook-office-messagedecrypteventcompletedoptions-emailbody-member)|When you use the completed method to signal completion of an event handler| |[MessageRead](/javascript/api/outlook/office.messageread)|[display](/javascript/api/outlook/office.messageread#outlook-office-messageread-display-member)|Gets an object to temporarily set the content displayed in the body or subject of a message in read mode.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index f0489782e3..fcdd983c4b 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -9178,6 +9178,16 @@ outlook,Office.CustomProperties,"remove(name)",Method,Excellent,true outlook,Office.CustomProperties,"saveAsync(callback, asyncContext)",Method,Excellent,true outlook,Office.CustomProperties,"saveAsync(asyncContext)",Method,Excellent,false outlook,Office.CustomProperties,"set(name, value)",Method,Excellent,true +outlook,Office.DecryptedMessageAttachment,N/A,Interface,Unknown,false +outlook,Office.DecryptedMessageAttachment,"attachmentType",Property,Good,false +outlook,Office.DecryptedMessageAttachment,"content",Property,Great,false +outlook,Office.DecryptedMessageAttachment,"contentId",Property,Excellent,true +outlook,Office.DecryptedMessageAttachment,"isInline",Property,Excellent,false +outlook,Office.DecryptedMessageAttachment,"name",Property,Good,false +outlook,Office.DecryptedMessageAttachment,"path",Property,Excellent,false +outlook,Office.DecryptedMessageBody,N/A,Interface,Good,false +outlook,Office.DecryptedMessageBody,"coercionType",Property,Great,false +outlook,Office.DecryptedMessageBody,"content",Property,Great,false outlook,Office.DelayDeliveryTime,N/A,Interface,Unknown,false outlook,Office.DelayDeliveryTime,"getAsync(options, callback)",Method,Poor,false outlook,Office.DelayDeliveryTime,"getAsync(callback)",Method,Poor,true @@ -9794,6 +9804,11 @@ outlook,Office.MessageCompose,"sendAsync(options, callback)",Method,Poor,true outlook,Office.MessageCompose,"sendAsync(callback)",Method,Poor,true outlook,Office.MessageCompose,"setSelectedDataAsync(data, options, callback)",Method,Excellent,true outlook,Office.MessageCompose,"setSelectedDataAsync(data, callback)",Method,Excellent,false +outlook,Office.MessageDecryptEventCompletedOptions,N/A,Interface,Excellent,false +outlook,Office.MessageDecryptEventCompletedOptions,"allowEvent",Property,Excellent,false +outlook,Office.MessageDecryptEventCompletedOptions,"attachments",Property,Excellent,false +outlook,Office.MessageDecryptEventCompletedOptions,"contextData",Property,Excellent,false +outlook,Office.MessageDecryptEventCompletedOptions,"emailBody",Property,Excellent,false outlook,Office.MessageRead,N/A,Interface,Unknown,true outlook,Office.MessageRead,"attachments",Property,Fine,true outlook,Office.MessageRead,"body",Property,Great,true diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts index 16bd06be07..c7fce77bb9 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts @@ -3872,7 +3872,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts index ae5a3b1924..32425319fd 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts @@ -3884,7 +3884,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts index 7f00f053c4..1a82d635d8 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts @@ -3884,7 +3884,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts index 51c917190a..daee2f3d6f 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts @@ -3899,7 +3899,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts index 496b285952..7b1988a04a 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts @@ -4010,7 +4010,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts index 17ec009774..f4f6ed5290 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts @@ -4085,7 +4085,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts index 143b2c89e2..7fed611bea 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts @@ -3598,7 +3598,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts index d01917056f..4a1ffe4f3c 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts @@ -3704,7 +3704,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts index 34524b1262..b0a4b82641 100644 --- a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts @@ -4122,7 +4122,9 @@ export declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. @@ -5386,6 +5388,164 @@ export declare namespace Office { */ set(name: string, value: string): void; } + /** + * Represents an attachment in a decrypted message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}. + * + * @beta + */ + export interface DecryptedMessageAttachment { + /** + * Specifies the type of attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + attachmentType: MailboxEnums.AttachmentType; + /** + * Specifies the Base64-encoded content of the attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: The `content` property isn't supported by attachments of type `MailboxEnums.AttachmentType.Cloud`. + * + * @beta + */ + content: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: 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 `` element (for example, ``). + * 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. + * + * @beta + */ + contentId?: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + isInline?: boolean; + /** + * Specifies the name of the attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + name: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + path?: string; + } + /** + * Represents the body of a decrypted message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}. + * + * @beta + */ + export interface DecryptedMessageBody { + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + coercionType: CommonAPI.CoercionType; + /** + * Specifies the content displayed in the body of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + content: string; + } /** * The `DelayDeliveryTime` object enables you to manage the delayed delivery date and time of a message. * @@ -9897,8 +10057,9 @@ export declare namespace Office { /** * The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}, including - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}, - * or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}. + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}, the + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}, or + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | decryption} (preview). * It allows the add-in to signify to the Outlook client that it has completed processing an event. * * @remarks @@ -9920,7 +10081,7 @@ export declare namespace Office { */ export interface MailboxEvent { /** - * 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] @@ -9935,9 +10096,9 @@ export declare namespace Office { * * - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12. * - * @param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event. + * @param options - Optional. An object that specifies the behavior of an event-based, spam-reporting, or decryption add-in when it completes processing an event. */ - completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void; + completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void; } /** * Represents the categories master list on the mailbox. @@ -11818,6 +11979,91 @@ export declare namespace Office { */ setSelectedDataAsync(data: string, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; } + /** + * Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | encryption add-in} after it completes processing an + * {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OnMessageRead} event. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + export interface MessageDecryptEventCompletedOptions { + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler, + * this value indicates if the `OnMessageRead` event should continue to run or be canceled. If the `allowEvent` property is set to `true`, the decrypted contents of the message is displayed. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + allowEvent: boolean; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property sets the decrypted attachments of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + attachments?: DecryptedMessageAttachment[]; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property specifies any JSON data passed to the add-in for processing. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: + * + * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync`. + * If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it. + * + * - You can use the `contextData` property to store custom internet headers to decrypt messages in reply and forward scenarios. + * + * @beta + */ + contextData?: any; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property sets the decrypted contents of the body of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: If the `emailBody` property isn't specified, an empty body is returned. + * + * @beta + */ + emailBody?: DecryptedMessageBody; + } /** * The message read mode of {@link Office.Item | Office.context.mailbox.item}. * diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 4359f36926..0f87a4f248 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -12938,7 +12938,9 @@ declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 3bc1166653..7cbfe3ecbe 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -12985,7 +12985,9 @@ declare namespace Office { * * **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 {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}. * * - Starting November 15, 2025, changes to how inline images are represented in the HTML body of Outlook emails in * Outlook on the web and the new Outlook on Windows will begin rolling out to production users. @@ -14249,6 +14251,164 @@ declare namespace Office { */ set(name: string, value: string): void; } + /** + * Represents an attachment in a decrypted message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}. + * + * @beta + */ + interface DecryptedMessageAttachment { + /** + * Specifies the type of attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + attachmentType: MailboxEnums.AttachmentType; + /** + * Specifies the Base64-encoded content of the attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: The `content` property isn't supported by attachments of type `MailboxEnums.AttachmentType.Cloud`. + * + * @beta + */ + content: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: 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 `` element (for example, ``). + * 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. + * + * @beta + */ + contentId?: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + isInline?: boolean; + /** + * Specifies the name of the attachment. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + name: string; + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + path?: string; + } + /** + * Represents the body of a decrypted message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}. + * + * @beta + */ + interface DecryptedMessageBody { + /** + * 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] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + coercionType: Office.CoercionType; + /** + * Specifies the content displayed in the body of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + content: string; + } /** * The `DelayDeliveryTime` object enables you to manage the delayed delivery date and time of a message. * @@ -18760,8 +18920,9 @@ declare namespace Office { /** * The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}, including - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}, - * or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}. + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}, the + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}, or + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | decryption} (preview). * It allows the add-in to signify to the Outlook client that it has completed processing an event. * * @remarks @@ -18783,7 +18944,7 @@ declare namespace Office { */ interface MailboxEvent { /** - * 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] @@ -18798,9 +18959,9 @@ declare namespace Office { * * - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12. * - * @param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event. + * @param options - Optional. An object that specifies the behavior of an event-based, spam-reporting, or decryption add-in when it completes processing an event. */ - completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void; + completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void; } /** * Represents the categories master list on the mailbox. @@ -20681,6 +20842,91 @@ declare namespace Office { */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | encryption add-in} after it completes processing an + * {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OnMessageRead} event. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + interface MessageDecryptEventCompletedOptions { + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler, + * this value indicates if the `OnMessageRead` event should continue to run or be canceled. If the `allowEvent` property is set to `true`, the decrypted contents of the message is displayed. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + allowEvent: boolean; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property sets the decrypted attachments of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @beta + */ + attachments?: DecryptedMessageAttachment[]; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property specifies any JSON data passed to the add-in for processing. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: + * + * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync`. + * If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it. + * + * - You can use the `contextData` property to store custom internet headers to decrypt messages in reply and forward scenarios. + * + * @beta + */ + contextData?: any; + /** + * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler + * and set its `allowEvent` property to `true`, this property sets the decrypted contents of the body of the message. + * + * @remarks + * + * [Api set: Mailbox preview] + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * **Important**: If the `emailBody` property isn't specified, an empty body is returned. + * + * @beta + */ + emailBody?: DecryptedMessageBody; + } /** * The message read mode of {@link Office.Item | Office.context.mailbox.item}. *