From 810ff90b2a44161c7118ddad30310efe2e1e1e2c Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Wed, 3 Sep 2025 12:34:46 -0700 Subject: [PATCH 1/4] Add decryption APIs to preview page --- docs/manifest/launchevent.md | 4 +- .../outlook-requirement-set-preview.md | 46 ++++++++++++++++++- 2 files changed, 47 insertions(+), 3 deletions(-) diff --git a/docs/manifest/launchevent.md b/docs/manifest/launchevent.md index 5e9e50a8a..327367584 100644 --- a/docs/manifest/launchevent.md +++ b/docs/manifest/launchevent.md @@ -1,7 +1,7 @@ --- title: LaunchEvent in the manifest file description: The LaunchEvent element configures your add-in to activate based on supported events. -ms.date: 07/02/2025 +ms.date: 09/11/2025 ms.localizationpriority: medium --- @@ -49,7 +49,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic | **Type** | Yes | Specifies a supported event type. For the set of supported types, see the "Event canonical name and add-in only manifest name" column of the table of supported events in [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation#supported-events). | | **FunctionName** | Yes | Specifies the name of the JavaScript function to handle the event specified in the `Type` attribute. | | **SendMode** | No | Used by the `OnMessageSend` and `OnAppointmentSend` events. Specifies the options available to the user if your add-in stops an item from being sent or if the add-in is unavailable. If the **SendMode** property isn't included, the `SoftBlock` option is set by default. For a list of available send mode options, see [Available send mode options](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#available-send-mode-options). | -| **HeaderName** (preview) | No | Specifies the internet header name used to identify a message on which the `OnMessageReadWithCustomHeader` event occurs. The `Type` attribute must be set to `OnMessageReadWithCustomHeader`. | +| **HeaderName** (preview) | No | Specifies the internet header name used to identify a message on which the `OnMessageDecrypt` or `OnMessageReadWithCustomHeader` event occurs. The `Type` attribute must be set to `OnMessageDecrypt` or `OnMessageReadWithCustomHeader`. | ## Child elements diff --git a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md index d2134773c..90a939192 100644 --- a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md +++ b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md @@ -1,7 +1,7 @@ --- title: Outlook add-in API preview requirement set description: Features and APIs that are currently in preview for Outlook add-ins. -ms.date: 03/11/2025 +ms.date: 09/11/2025 ms.topic: whats-new ms.localizationpriority: medium --- @@ -75,6 +75,50 @@ Added a new property that represents if an appointment is an all-day event. --- +### Decrypt a message and its attachments + +#### [OnMessageDecrypt event](/office/dev/add-ins/develop/event-based-activation#outlook-events) + +Added a decryption event that occurs when the header of an encrypted message matches the header key of an installed encryption add-in. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [HeaderName attribute in the LaunchEvent element](../../../manifest/launchevent.md#attributes) + +Updated the `HeaderName` attribute of the **\** XML element to specify the header key used for decryption. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Event.completed method](/javascript/api/outlook/office.mailboxevent?view=outlook-js-preview&preserve-view=true#outlook-office-mailboxevent-completed-member(1)) + +Updated the `event.completed` method to indicate when an encryption add-in has completed processing the `OnMessageDecrypt` event. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Office.MessageDecryptEventCompletedOptions](/javascript/api/outlook/office.messagedecrypteventcompletedoptions?view=outlook-js-preview&preserve-view=true) + +Added an object to specify the behavior of an encryption add-in after it completes processing an `OnMessageDecrypt` event. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Office.DecryptedMessageAttachment](/javascript/api/outlook/office.decryptedmessageattachment?view=outlook-js-preview&preserve-view=true) + +Added an object that represents an attachment in a decrypted message. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Office.DecryptedMessageBody](/javascript/api/outlook/office.decryptedmessagebody?view=outlook-js-preview&preserve-view=true) + +Added an object that represents the body a decrypted message. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +
+ +--- + +--- + ### Temporarily set the body or subject displayed in read mode #### [Office.context.mailbox.item.display](/javascript/api/outlook/office.messageread?view=outlook-js-preview&preserve-view=true#outlook-office-messageread-display-member) From 36f59e3f7390210dac4c72e3c8d99756a8c0036d Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Wed, 3 Sep 2025 13:01:30 -0700 Subject: [PATCH 2/4] Update LaunchEvent code snippet --- docs/manifest/launchevent.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/manifest/launchevent.md b/docs/manifest/launchevent.md index 327367584..f75df387c 100644 --- a/docs/manifest/launchevent.md +++ b/docs/manifest/launchevent.md @@ -25,6 +25,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic + From bc81c33e9663bd461aee6e3600d7a47fe678269c Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Sun, 7 Sep 2025 18:47:24 -0700 Subject: [PATCH 3/4] Fix typo and add link --- docs/manifest/launchevent.md | 1 + .../preview-requirement-set/outlook-requirement-set-preview.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/manifest/launchevent.md b/docs/manifest/launchevent.md index f75df387c..0752a7641 100644 --- a/docs/manifest/launchevent.md +++ b/docs/manifest/launchevent.md @@ -66,3 +66,4 @@ For more information, see [Version overrides in the add-in only manifest](/offic - [Automatically check for an attachment before a message is sent](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough) - [Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events) - [Implement event-based activation in Outlook mobile add-ins](/office/dev/add-ins/outlook/mobile-event-based) +- [Create an encryption Outlook add-in](/office/dev/add-ins/outlook/encryption-decryption?branch=samramon-decryption) diff --git a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md index 90a939192..f614f5228 100644 --- a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md +++ b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md @@ -109,7 +109,7 @@ Added an object that represents an attachment in a decrypted message. #### [Office.DecryptedMessageBody](/javascript/api/outlook/office.decryptedmessagebody?view=outlook-js-preview&preserve-view=true) -Added an object that represents the body a decrypted message. +Added an object that represents the body of a decrypted message. **Available in**: Classic Outlook on Windows (Microsoft 365 subscription) From 24403c2b1de4ad012f7e932a96bc82cf9fea9bf2 Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Wed, 8 Oct 2025 15:51:40 -0700 Subject: [PATCH 4/4] Update ms.date and event name --- docs/manifest/launchevent.md | 8 ++++---- .../outlook-requirement-set-preview.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/manifest/launchevent.md b/docs/manifest/launchevent.md index 0752a7641..8df644732 100644 --- a/docs/manifest/launchevent.md +++ b/docs/manifest/launchevent.md @@ -1,7 +1,7 @@ --- title: LaunchEvent in the manifest file description: The LaunchEvent element configures your add-in to activate based on supported events. -ms.date: 09/11/2025 +ms.date: 10/09/2025 ms.localizationpriority: medium --- @@ -25,7 +25,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic - + @@ -50,7 +50,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic | **Type** | Yes | Specifies a supported event type. For the set of supported types, see the "Event canonical name and add-in only manifest name" column of the table of supported events in [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation#supported-events). | | **FunctionName** | Yes | Specifies the name of the JavaScript function to handle the event specified in the `Type` attribute. | | **SendMode** | No | Used by the `OnMessageSend` and `OnAppointmentSend` events. Specifies the options available to the user if your add-in stops an item from being sent or if the add-in is unavailable. If the **SendMode** property isn't included, the `SoftBlock` option is set by default. For a list of available send mode options, see [Available send mode options](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#available-send-mode-options). | -| **HeaderName** (preview) | No | Specifies the internet header name used to identify a message on which the `OnMessageDecrypt` or `OnMessageReadWithCustomHeader` event occurs. The `Type` attribute must be set to `OnMessageDecrypt` or `OnMessageReadWithCustomHeader`. | +| **HeaderName** (preview) | No | Specifies the internet header name used to identify a message on which the `OnMessageRead` or `OnMessageReadWithCustomHeader` event occurs. The `Type` attribute must be set to `OnMessageRead` or `OnMessageReadWithCustomHeader`. | ## Child elements @@ -66,4 +66,4 @@ For more information, see [Version overrides in the add-in only manifest](/offic - [Automatically check for an attachment before a message is sent](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough) - [Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events) - [Implement event-based activation in Outlook mobile add-ins](/office/dev/add-ins/outlook/mobile-event-based) -- [Create an encryption Outlook add-in](/office/dev/add-ins/outlook/encryption-decryption?branch=samramon-decryption) +- [Create an encryption Outlook add-in](/office/dev/add-ins/outlook/encryption-decryption) diff --git a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md index f614f5228..88d2c74fc 100644 --- a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md +++ b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md @@ -1,7 +1,7 @@ --- title: Outlook add-in API preview requirement set description: Features and APIs that are currently in preview for Outlook add-ins. -ms.date: 09/11/2025 +ms.date: 10/09/2025 ms.topic: whats-new ms.localizationpriority: medium --- @@ -77,7 +77,7 @@ Added a new property that represents if an appointment is an all-day event. ### Decrypt a message and its attachments -#### [OnMessageDecrypt event](/office/dev/add-ins/develop/event-based-activation#outlook-events) +#### [OnMessageRead event](/office/dev/add-ins/develop/event-based-activation#outlook-events) Added a decryption event that occurs when the header of an encrypted message matches the header key of an installed encryption add-in. @@ -91,13 +91,13 @@ Updated the `HeaderName` attribute of the **\** XML element to spe #### [Event.completed method](/javascript/api/outlook/office.mailboxevent?view=outlook-js-preview&preserve-view=true#outlook-office-mailboxevent-completed-member(1)) -Updated the `event.completed` method to indicate when an encryption add-in has completed processing the `OnMessageDecrypt` event. +Updated the `event.completed` method to indicate when an encryption add-in has completed processing the `OnMessageRead` event. **Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [Office.MessageDecryptEventCompletedOptions](/javascript/api/outlook/office.messagedecrypteventcompletedoptions?view=outlook-js-preview&preserve-view=true) -Added an object to specify the behavior of an encryption add-in after it completes processing an `OnMessageDecrypt` event. +Added an object to specify the behavior of an encryption add-in after it completes processing an `OnMessageRead` event. **Available in**: Classic Outlook on Windows (Microsoft 365 subscription)