Skip to content

Commit e6be141

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents 6456c9a + 00f1c9e commit e6be141

File tree

12 files changed

+427
-13
lines changed

12 files changed

+427
-13
lines changed

‎docs/docs-ref-autogen/outlook/outlook/office.spamreportingeventcompletedoptions.yml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,119 @@ isPreview: false
6363
isDeprecated: false
6464
type: interface
6565
properties:
66+
- name: commandId
67+
uid: 'outlook!Office.SpamReportingEventCompletedOptions#commandId:member'
68+
package: outlook!
69+
fullName: commandId
70+
summary: >-
71+
When you use the [completed
72+
method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))
73+
to signal that a reported message has finished processing, this property specifies the ID of the task pane that
74+
opens after the message is processed.
75+
remarks: >-
76+
\[ [API set: Mailbox preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
77+
78+
79+
**[Minimum permission level
80+
(Outlook)](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
81+
-->**: **read item**
82+
83+
84+
**[Applicable Outlook
85+
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
86+
-->**: Message Read
87+
88+
89+
**Important**:
90+
91+
92+
- The `commandId` option is currently in preview in Outlook on the web and on Windows (new and classic). To
93+
preview this feature in classic Outlook on Windows, install Version 2411 (Build 18227.20034) or later. Then, join
94+
the [Microsoft 365 Insider
95+
program](https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638)
96+
and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
97+
[Open a task pane after reporting a message
98+
(preview)](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview)<!--
99+
-->.
100+
101+
102+
- The `commandId` value must match the task pane ID specified in the manifest of your add-in. In an add-in only
103+
manifest, the ID is specified in the `id` attribute of the
104+
[Control](https://learn.microsoft.com/javascript/api/manifest/control) element that represents the task pane. The
105+
`commandId` property isn't currently supported in a spam-reporting add-in that uses a unified manifest for
106+
Microsoft 365.
107+
108+
109+
- If you configure the `commandId` option in the `event.completed` call, a post-processing dialog isn't shown to
110+
the user even if the `showPostProcessingDialog` option is specified in the call.
111+
112+
113+
- If you implement a task pane to open after a reported message is processed, when the `event.completed` call
114+
occurs, any task pane that's open or pinned is closed.
115+
isPreview: true
116+
isDeprecated: false
117+
syntax:
118+
content: 'commandId?: string;'
119+
return:
120+
type: string
121+
- name: contextData
122+
uid: 'outlook!Office.SpamReportingEventCompletedOptions#contextData:member'
123+
package: outlook!
124+
fullName: contextData
125+
summary: >-
126+
When you use the [completed
127+
method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))
128+
to signal that a reported message has finished processing, this property specifies any JSON data passed to the
129+
add-in's task pane after the message is processed.
130+
remarks: >-
131+
\[ [API set: Mailbox preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
132+
133+
134+
**[Minimum permission level
135+
(Outlook)](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
136+
-->**: **read item**
137+
138+
139+
**[Applicable Outlook
140+
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141+
-->**: Message Read
142+
143+
144+
**Important**:
145+
146+
147+
- The `contextData` option is currently in preview in Outlook on the web and on Windows (new and classic). To
148+
preview this feature in classic Outlook on Windows, install Version 2411 (Build 18227.20034) or later. Then, join
149+
the [Microsoft 365 Insider
150+
program](https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638)
151+
and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
152+
[Open a task pane after reporting a message
153+
(preview)](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview)<!--
154+
-->.
155+
156+
157+
- If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to
158+
the `commandId` option. Otherwise, the JSON data assigned to `contextData` is ignored.
159+
160+
161+
- If you configure the `commandId` and `contextData` options in the `event.completed` call, a post-processing
162+
dialog isn't shown to the user even if the `showPostProcessingDialog` option is specified in the call.
163+
164+
165+
- If you implement a task pane to open after a reported message is processed, when the `event.completed` call
166+
occurs, any task pane that's open or pinned is closed.
167+
168+
169+
- To retrieve the value of the `contextData` property, you must call
170+
`Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation of your task pane. If
171+
you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the
172+
string using `JSON.parse()` once you retrieve it.
173+
isPreview: true
174+
isDeprecated: false
175+
syntax:
176+
content: 'contextData?: any;'
177+
return:
178+
type: any
66179
- name: folderName
67180
uid: 'outlook!Office.SpamReportingEventCompletedOptions#folderName:member'
68181
package: outlook!
@@ -138,6 +251,11 @@ properties:
138251
of the folder to which the message will be moved in the `folderName` property of the `event.completed` call.
139252
Otherwise, the `moveItemTo` property will default to `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the
140253
reported message to the **Junk Email** folder.
254+
255+
256+
- If you configure the `commandId` and `contextData` options in the `event.completed` call to open a task pane
257+
after a user selects the **Report** option from the preprocessing dialog, you must set the `moveItemTo` option
258+
to `Office.MailboxEnums.MoveSpamItemTo.NoMove`<!-- -->. Otherwise, the task pane won't open.
141259
isPreview: false
142260
isDeprecated: false
143261
syntax:
@@ -288,6 +406,12 @@ properties:
288406
**[Applicable Outlook
289407
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
290408
-->**: Message Read
409+
410+
411+
**Important**: If you configure the `commandId` and `contextData` options in the `event.completed` call to
412+
open a task pane after a user selects the **Report** option from the preprocessing dialog, a post-processing
413+
dialog isn't shown to the user. This behavior applies even if the `showPostProcessingDialog` is specified in the
414+
`event.completed` call.
291415
isPreview: false
292416
isDeprecated: false
293417
syntax:

‎docs/includes/outlook-preview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,5 @@
9696
||[loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose \| LoadedMessageRead>) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.|
9797
|[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.|
9898
|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[errorMessageMarkdown](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessagemarkdown-member)|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|
99+
|[SpamReportingEventCompletedOptions](/javascript/api/outlook/office.spamreportingeventcompletedoptions)|[commandId](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,|
100+
||[contextData](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,|

‎docs/manifest/commandsurface.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: CommandSurface element in the manifest file
3+
description: Defines the custom tab and ribbon buttons of a module extension add-in in classic Outlook on Windows.
4+
ms.date: 02/27/2025
5+
ms.localizationpriority: medium
6+
---
7+
8+
# CommandSurface element
9+
10+
Defines the custom tab and ribbon buttons of a module extension add-in in classic Outlook on Windows. For more information about module extensions, see [Module extension Outlook add-ins](/office/dev/add-ins/outlook/extension-module-outlook-add-ins).
11+
12+
**Add-in type**: Mail
13+
14+
**Valid only in these VersionOverrides schemas**:
15+
16+
- Mail 1.1
17+
18+
For more information, see [Version overrides in the add-in only manifest](/office/dev/add-ins/develop/xml-manifest-overview#version-overrides-in-the-manifest).
19+
20+
**Associated with these requirement sets**:
21+
22+
- [Mailbox 1.5](../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md)
23+
24+
## Contained in
25+
26+
- [ExtensionPoint](extensionpoint.md) ([Module](extensionpoint.md#module) mail add-ins)
27+
28+
## Attributes
29+
30+
None.
31+
32+
## Child elements
33+
34+
| Element | Required | Description |
35+
|:-----|:-----:|:-----|
36+
| [CustomTab](customtab.md) | Yes | Defines a custom tab on the ribbon for the module extension add-in. The custom tab hosts buttons that run add-in operations. |
37+
38+
## Example
39+
40+
```xml
41+
<ExtensionPoint xsi:type="Module">
42+
<SourceLocation resid="residExtensionPointUrl"/>
43+
<Label resid="residExtensionPointLabel"/>
44+
<CommandSurface>
45+
<CustomTab id="idTab">
46+
<Group id="idGroup">
47+
<Label resid="residGroupLabel"/>
48+
<Control xsi:type="Button" id="group.changeToAssociate">
49+
<Label resid="residChangeToAssociateLabel"/>
50+
<Supertip>
51+
<Title resid="residChangeToAssociateLabel"/>
52+
<Description resid="residChangeToAssociateDesc"/>
53+
</Supertip>
54+
<Icon>
55+
<bt:Image size="16" resid="residAssociateIcon16"/>
56+
<bt:Image size="32" resid="residAssociateIcon32"/>
57+
<bt:Image size="80" resid="residAssociateIcon80"/>
58+
</Icon>
59+
<Action xsi:type="ExecuteFunction">
60+
<FunctionName>changeToAssociateRate</FunctionName>
61+
</Action>
62+
</Control>
63+
</Group>
64+
<Label resid="residCustomTabLabel"/>
65+
</CustomTab>
66+
</CommandSurface>
67+
</ExtensionPoint>
68+
```

‎docs/manifest/customfunctionssourcelocation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
22
title: SourceLocation element (version overrides) in the manifest file
33
description: Defines the location of a resource needed by the Script or Page elements used by custom functions in Excel, or needed by the ReportPhishingCustomization element, DetectedEntity extension point, or LaunchEvent extension point in Outlook.
4-
ms.date: 05/20/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

88
# SourceLocation element (version overrides)
99

10-
Defines the location of a resource needed by the **\<Script\>** or **\<Page\>** elements used by custom functions in Excel, or needed by the **\<ReportPhishingCustomization\>** element, **\<DetectedEntity\>** extension point, or **\<LaunchEvent\>** extension point in Outlook.
10+
Defines the location of a resource needed by the following elements.
11+
12+
- **\<Script\>** or **\<Page\>** elements used by custom functions in Excel
13+
- **\<ReportPhishingCustomization\>** element, **\<DetectedEntity\>** extension point, **\<LaunchEvent\>** extension point, or **\<Module\>** extension point in Outlook.
1114

1215
> [!IMPORTANT]
1316
> This article only refers to the **\<SourceLocation\>** that is a child of the following:
1417
>
1518
> - **\<Page\>**, **\<Script\>**, or **\<ReportPhishingCustomization\>** elements
16-
> - **\<DetectedEntity\>** or **\<LaunchEvent\>** extension points
19+
> - **\<DetectedEntity\>**, **\<LaunchEvent\>**, or **\<Module\>** extension points
1720
>
1821
> For information about the **\<SourceLocation\>** element of the base manifest, see [SourceLocation](sourcelocation.md).
1922
@@ -29,13 +32,14 @@ For more information, see [Version overrides in the add-in only manifest](/offic
2932
**Associated with these requirement sets**:
3033

3134
- [CustomFunctionsRuntime 1.1](../requirement-sets/excel/custom-functions-requirement-sets.md)
35+
- [Mailbox 1.5](../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md)
3236
- [Mailbox 1.6](../requirement-sets/outlook/requirement-set-1.6/outlook-requirement-set-1.6.md)
3337
- [Mailbox 1.10](../requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10.md)
3438
- [Mailbox 1.14](../requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14.md)
3539

3640
## Contained in
3741

38-
- [ExtensionPoint](extensionpoint.md) ([Contextual](extensionpoint.md#detectedentity) and [LaunchEvent](extensionpoint.md#launchevent) mail add-ins)
42+
- [ExtensionPoint](extensionpoint.md) ([DetectedEntity](extensionpoint.md#detectedentity), [LaunchEvent](extensionpoint.md#launchevent), and [Module](extensionpoint.md#module) mail add-ins)
3943
- [Page](page.md)
4044
- [ReportPhishingCustomization](reportphishingcustomization.md) (Mail add-ins)
4145
- [Script](script.md)

‎docs/manifest/extensionpoint.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: ExtensionPoint element in the manifest file
33
description: Defines where an add-in exposes functionality in the Office UI.
4-
ms.date: 09/05/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

@@ -283,7 +283,7 @@ This extension point puts buttons on the ribbon for the form that's displayed to
283283

284284
### Module
285285

286-
This extension point puts buttons on the ribbon for the module extension.
286+
This extension point adds a module extension add-in to the Outlook navigation bar. It also adds buttons to a custom tab on the ribbon for the module extension. To learn how to create module extensions, see [Module extension Outlook add-ins](/office/dev/add-ins/outlook/extension-module-outlook-add-ins).
287287

288288
> [!IMPORTANT]
289289
> Registering [Mailbox](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md#events) and [Item](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item.md#events) events is not available with this extension point.
@@ -292,8 +292,41 @@ This extension point puts buttons on the ribbon for the module extension.
292292

293293
| Element | Description |
294294
|:-----|:-----|
295-
| [OfficeTab](officetab.md) | Adds the command(s) to the default ribbon tab. |
296-
| [CustomTab](customtab.md) | Adds the command(s) to the custom ribbon tab. |
295+
| [SourceLocation](customfunctionssourcelocation.md) | Specifies the location of the HTML file that sets up the main user interface of the add-in. |
296+
| Label | Specifies the label of the module extension. Its **resid** attribute can be no more than 32 characters and must be set to the value of the **id** attribute of a **\<String\>** element in the [ShortStrings](shortstrings.md) element. |
297+
| [CommandSurface](commandsurface.md) | Adds a group of add-in buttons to a custom tab on the ribbon. |
298+
299+
#### Example
300+
301+
```xml
302+
<ExtensionPoint xsi:type="Module">
303+
<SourceLocation resid="residExtensionPointUrl"/>
304+
<Label resid="residExtensionPointLabel"/>
305+
<CommandSurface>
306+
<CustomTab id="idTab">
307+
<Group id="idGroup">
308+
<Label resid="residGroupLabel"/>
309+
<Control xsi:type="Button" id="group.changeToAssociate">
310+
<Label resid="residChangeToAssociateLabel"/>
311+
<Supertip>
312+
<Title resid="residChangeToAssociateLabel"/>
313+
<Description resid="residChangeToAssociateDesc"/>
314+
</Supertip>
315+
<Icon>
316+
<bt:Image size="16" resid="residAssociateIcon16"/>
317+
<bt:Image size="32" resid="residAssociateIcon32"/>
318+
<bt:Image size="80" resid="residAssociateIcon80"/>
319+
</Icon>
320+
<Action xsi:type="ExecuteFunction">
321+
<FunctionName>changeToAssociateRate</FunctionName>
322+
</Action>
323+
</Control>
324+
</Group>
325+
<Label resid="residCustomTabLabel"/>
326+
</CustomTab>
327+
</CommandSurface>
328+
</ExtensionPoint>
329+
```
297330

298331
### MobileMessageReadCommandSurface
299332

‎docs/manifest/preprocessingdialog.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: PreProcessingDialog element in the manifest file
33
description: The PreProcessingDialog element configures the preprocessing dialog of a spam-reporting add-in in Outlook.
4-
ms.date: 05/20/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

@@ -37,10 +37,13 @@ None.
3737
| :------ | :------: | :------ |
3838
| **Title** | Yes | Specifies the custom title of the preprocessing dialog. Its **resid** attribute must be set to the value of the **id** attribute of a [String](string.md) in the [ShortStrings](shortstrings.md) element under the [Resources](resources.md) element. |
3939
| **Description** | Yes | Specifies the custom text that appears in the preprocessing dialog. Its **resid** attribute must be set to the value of the **id** attribute of a [String](string.md) in the [LongStrings](longstrings.md) element under the [Resources](resources.md) element. |
40+
| **NeverShowAgainOption** (preview)* | No | When set to `true`, adds a "Don't show me this message again" checkbox to prevent the preprocessing dialog from appearing again. Consider specifying this element in your manifest when the preprocessing dialog of your spam-reporting add-in doesn't require user input. If you set this element to `true` and also specify the **\<ReportingOptions\>** and **\<FreeTextLabel\>** elements, the "Don't show me this message again" checkbox isn't shown on the preprocessing dialog. |
4041
| [ReportingOptions](reportingoptions.md) | No | Lists up to five options a user can select from the preprocessing dialog to provide a reason for reporting a message. |
4142
| **FreeTextLabel** | No | Adds a text box to the preprocessing dialog to allow users to provide additional information on the message they're reporting. Its **resid** attribute sets the title of the text box. The **resid** attribute must be set to the value of the **id** attribute of a [String](string.md) in the [ShortStrings](shortstrings.md) element under the [Resources](resources.md) element. |
4243
| [MoreInfo](moreinfo.md) | No | Specifies the custom text and URL to provide informational resources to the users. The custom text and URL configured in this element appear below the text provided in the **\<Description\>** element. |
4344

45+
> \* The **\<NeverShowAgainOption\>** element is currently in preview in Outlook on the web and on Windows (new and classic). To preview this feature in classic Outlook on Windows, install Version 2411 (Build 18227.20034) or later. Then, join the [Microsoft 365 Insider program](https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638) and select the **Beta Channel** option.
46+
4447
## Example
4548

4649
```xml

0 commit comments

Comments
 (0)