Skip to content

Commit f203153

Browse files
[Outlook] (encryption) Add decryption APIs to preview page (#2340)
* Add decryption APIs to preview page * Update LaunchEvent code snippet * Fix typo and add link * Update ms.date and event name
1 parent 82e4458 commit f203153

File tree

2 files changed

+49
-3
lines changed

2 files changed

+49
-3
lines changed

docs/manifest/launchevent.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: LaunchEvent in the manifest file
33
description: The LaunchEvent element configures your add-in to activate based on supported events.
4-
ms.date: 07/02/2025
4+
ms.date: 10/09/2025
55
ms.localizationpriority: medium
66
---
77

@@ -25,6 +25,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
2525
<LaunchEvents>
2626
<LaunchEvent Type="OnNewMessageCompose" FunctionName="onMessageComposeHandler"/>
2727
<LaunchEvent Type="OnNewAppointmentOrganizer" FunctionName="onAppointmentComposeHandler"/>
28+
<LaunchEvent Type="OnMessageRead" FunctionName="onMessageReadHandler" HeaderName="contoso-encrypted"/>
2829
<LaunchEvent Type="OnMessageReadWithCustomHeader" FunctionName="onMessageReadWithCustomHeaderHandler" HeaderName="contoso-spam-simulation"/>
2930
<LaunchEvent Type="OnMessageReadWithCustomAttachment" FunctionName="onMessageReadWithCustomAttachmentHandler">
3031
<MessageAttachments>
@@ -49,7 +50,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
4950
| **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). |
5051
| **FunctionName** | Yes | Specifies the name of the JavaScript function to handle the event specified in the `Type` attribute. |
5152
| **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). |
52-
| **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`. |
53+
| **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`. |
5354

5455
## Child elements
5556

@@ -65,3 +66,4 @@ For more information, see [Version overrides in the add-in only manifest](/offic
6566
- [Automatically check for an attachment before a message is sent](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough)
6667
- [Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events)
6768
- [Implement event-based activation in Outlook mobile add-ins](/office/dev/add-ins/outlook/mobile-event-based)
69+
- [Create an encryption Outlook add-in](/office/dev/add-ins/outlook/encryption-decryption)

docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Outlook add-in API preview requirement set
33
description: Features and APIs that are currently in preview for Outlook add-ins.
4-
ms.date: 03/11/2025
4+
ms.date: 10/09/2025
55
ms.topic: whats-new
66
ms.localizationpriority: medium
77
---
@@ -75,6 +75,50 @@ Added a new property that represents if an appointment is an all-day event.
7575

7676
---
7777

78+
### Decrypt a message and its attachments
79+
80+
#### [OnMessageRead event](/office/dev/add-ins/develop/event-based-activation#outlook-events)
81+
82+
Added a decryption event that occurs when the header of an encrypted message matches the header key of an installed encryption add-in.
83+
84+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
85+
86+
#### [HeaderName attribute in the LaunchEvent element](../../../manifest/launchevent.md#attributes)
87+
88+
Updated the `HeaderName` attribute of the **\<LaunchEvent\>** XML element to specify the header key used for decryption.
89+
90+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
91+
92+
#### [Event.completed method](/javascript/api/outlook/office.mailboxevent?view=outlook-js-preview&preserve-view=true#outlook-office-mailboxevent-completed-member(1))
93+
94+
Updated the `event.completed` method to indicate when an encryption add-in has completed processing the `OnMessageRead` event.
95+
96+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
97+
98+
#### [Office.MessageDecryptEventCompletedOptions](/javascript/api/outlook/office.messagedecrypteventcompletedoptions?view=outlook-js-preview&preserve-view=true)
99+
100+
Added an object to specify the behavior of an encryption add-in after it completes processing an `OnMessageRead` event.
101+
102+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
103+
104+
#### [Office.DecryptedMessageAttachment](/javascript/api/outlook/office.decryptedmessageattachment?view=outlook-js-preview&preserve-view=true)
105+
106+
Added an object that represents an attachment in a decrypted message.
107+
108+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
109+
110+
#### [Office.DecryptedMessageBody](/javascript/api/outlook/office.decryptedmessagebody?view=outlook-js-preview&preserve-view=true)
111+
112+
Added an object that represents the body of a decrypted message.
113+
114+
**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
115+
116+
<br>
117+
118+
---
119+
120+
---
121+
78122
### Temporarily set the body or subject displayed in read mode
79123

80124
#### [Office.context.mailbox.item.display](/javascript/api/outlook/office.messageread?view=outlook-js-preview&preserve-view=true#outlook-office-messageread-display-member)

0 commit comments

Comments
 (0)