Skip to content

Commit 2d5083e

Browse files
[Outlook] (spam reporting) Document improvements (#2145)
* Draft spam reporting improvements * Clarify description of ReportingOptions attributes * Edit heading * Update ms.date * Remove preview strings * Prepare docs for preview * Updated the preview page
1 parent bcbe3dd commit 2d5083e

File tree

3 files changed

+38
-5
lines changed

3 files changed

+38
-5
lines changed

docs/manifest/preprocessingdialog.md

+4-1
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

docs/manifest/reportingoptions.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: ReportingOptions element in the manifest file
33
description: The ReportingOptions element specifies the reporting options listed in the preprocessing dialog of a spam-reporting add-in in Outlook.
4-
ms.date: 06/12/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

@@ -29,14 +29,18 @@ For more information, see [Version overrides in the add-in only manifest](/offic
2929

3030
## Attributes
3131

32-
None.
32+
| Attribute | Required | Description |
33+
|:-----|:-----:|:-----|
34+
| **inputType** (preview)* | No | Specifies the input type of the reporting options in the preprocessing dialog. If the `inputType` attribute isn't included, the reporting options appear as checkboxes. To use radio buttons, set the `inputType` attribute to `Radio`. You can only use one input type in the dialog. |
35+
36+
> \* The `inputType` attribute 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.
3337
3438
## Child elements
3539

3640
| Element | Required | Description |
3741
| :------ | :------: | :------ |
3842
| **Title** | Yes | Specifies a custom title for the reporting options in 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. |
39-
| **Option** | Yes | Specifies a custom option with a checkbox that a user can select from the preprocessing dialog to provide a reason for reporting a message. You can add up to *five* options, but must specify at least one option. |
43+
| **Option** | Yes | Specifies a custom option that a user can select from the preprocessing dialog to provide a reason for reporting a message. You can add up to *five* options, but must specify at least one option. |
4044

4145
## Example
4246

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

+27-1
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: 11/14/2024
4+
ms.date: 02/27/2025
55
ms.topic: whats-new
66
ms.localizationpriority: medium
77
---
@@ -115,6 +115,32 @@ Added an `event.completed` option to format a message in a Smart Alerts dialog u
115115

116116
---
117117

118+
### Spam reporting improvements
119+
120+
#### Suppress the preprocessing dialog
121+
122+
Added the [NeverShowAgainOption](/javascript/api/manifest/preprocessingdialog?view=outlook-js-preview&preserve-view=true#child-elements) element as a child of the **\<PreProcessingDialog\>** element. This element adds a "Don't show me this message again" checkbox to the preprocessing dialog to prevent it from appearing again.
123+
124+
**Available in**: Outlook on the web and on Windows (new and classic) (Microsoft 365 subscription)
125+
126+
#### Use radio buttons for reporting options
127+
128+
Added the `inputType` attribute to the [ReportingOptions](/javascript/api/manifest/reportingoptions?view=outlook-js-preview&preserve-view=true#attributes) element. This attribute uses radio buttons for the reporting options of a preprocessing dialog.
129+
130+
**Available in**: Outlook on the web and on Windows (new and classic) (Microsoft 365 subscription)
131+
132+
#### Open a task pane from the preprocessing dialog
133+
134+
Added the [commandId](/javascript/api/outlook/office.spamreportingeventcompletedoptions?view=outlook-js-preview&preserve-view=true#outlook-office-spamreportingeventcompletedoptions-commandid-member) and [contextData](/javascript/api/outlook/office.spamreportingeventcompletedoptions?view=outlook-js-preview&preserve-view=true#outlook-office-spamreportingeventcompletedoptions-contextdata-member) options to the `event.completed` call. These options configure a task pane to open after a user selects **Report** from the preprocessing dialog.
135+
136+
**Available in**: Outlook on the web and on Windows (new and classic) (Microsoft 365 subscription)
137+
138+
<br>
139+
140+
---
141+
142+
---
143+
118144
### Temporarily set the body or subject displayed in read mode
119145

120146
#### [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)