Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Outlook] (spam reporting) Document improvements #2145

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

[Outlook] (spam reporting) Document improvements #2145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ec53d4
Draft spam reporting improvements
samantharamon Nov 15, 2024
2798228
Clarify description of ReportingOptions attributes
samantharamon Nov 18, 2024
2618078
Edit heading
samantharamon Nov 20, 2024
192f5fb
Update ms.date
samantharamon Dec 17, 2024
9ebfd34
Remove preview strings
samantharamon Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/manifest/preprocessingdialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: PreProcessingDialog element in the manifest file
description: The PreProcessingDialog element configures the preprocessing dialog of a spam-reporting add-in in Outlook.
ms.date: 05/20/2024
ms.date: 01/16/2025
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -37,6 +37,7 @@ None.
| :------ | :------: | :------ |
| **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. |
| **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. |
| **NeverShowAgainOption** | 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.<br><br>**Important**: The **\<NeverShowAgainOption\>** element was introduced in [requirement set 1.15](../requirement-sets/outlook/requirement-set-1.15/outlook-requirement-set-1.15.md). Learn more about its [supported clients and platforms](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets). |
| [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. |
| **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. |
| [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. |
Expand Down
8 changes: 5 additions & 3 deletions docs/manifest/reportingoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ReportingOptions element in the manifest file
description: The ReportingOptions element specifies the reporting options listed in the preprocessing dialog of a spam-reporting add-in in Outlook.
ms.date: 06/12/2024
ms.date: 01/16/2025
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -29,14 +29,16 @@ For more information, see [Version overrides in the add-in only manifest](/offic

## Attributes

None.
| Attribute | Required | Description |
|:-----|:-----:|:-----|
| **inputType** | 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.<br><br>**Important**: The **inputType** attribute was introduced in [requirement set 1.15](../requirement-sets/outlook/requirement-set-1.15/outlook-requirement-set-1.15.md). Learn more about its [supported clients and platforms](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets). |

## Child elements

| Element | Required | Description |
| :------ | :------: | :------ |
| **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. |
| **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. |
| **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. |

## Example

Expand Down