Configures the preprocessing dialog of an integrated spam-reporting add-in in Outlook.
Properties that reference this object type:
Syntax
{
"title": "{string}",
"description": "{string}",
"spamNeverShowAgainOption": {boolean},
"spamReportingOptions": {
"title": "{string}",
"options": [
"{string}"
],
"type": "radio | checkbox"
},
"spamFreeTextSectionTitle": "{string}",
"spamMoreInfo": {
"text": "{string}",
"url": "{string}"
}
}
{
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Specifies the custom title of the preprocessing dialog.",
"maxLength": 128
},
"description": {
"type": "string",
"description": "Specifies the custom text that appears in the preprocessing dialog.",
"maxLength": 250
},
"spamNeverShowAgainOption": {
"type": "boolean",
"description": "Indicating if the developer will allow the user to permanently bypass the PreProcessing Dialog for this add-in. \u0022false\u0022 is the default value if not specified.",
"default": "false"
},
"spamReportingOptions": {
"type": "object",
"description": "Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.",
"properties": {
"title": {
"type": "string",
"description": "Specifies the title listed before the reporting options list.",
"maxLength": 128
},
"options": {
"type": "array",
"description": "Specifies the custom options that a user can select from the preprocessing dialog to provide a reason for reporting a message.",
"items": {
"type": "string",
"minItems": 1,
"maxItems": 5
}
},
"type": {
"type": "string",
"enum": [
"radio",
"checkbox"
],
"description": "Can be set to \u0022radio\u0022 or \u0022checkbox\u0022. This determines if Radio Buttons or checkboxes are used for the options. \u0022checkbox\u0022 is the default if this value is not specified.",
"default": "checkbox"
}
},
"required": [
"title",
"options"
]
},
"spamFreeTextSectionTitle": {
"type": "string",
"description": "A text box to the preprocessing dialog to allow users to provide additional information on the message they\u0027re reporting. This value is the title of that text box.",
"maxLength": 128
},
"spamMoreInfo": {
"type": "object",
"description": "Specifies the custom text and URL to provide informational resources to the users.",
"properties": {
"text": {
"type": "string",
"description": "Specifies display content of the hyperlink pointing to the site containing informational resources in the preprocessing dialog of a spam-reporting add-in.",
"maxLength": 128
},
"url": {
"type": "string",
"description": "Specifies the URL of the hyperlink pointing to the site containing informational resources in the preprocessing dialog of a spam-reporting add-in.",
"maxLength": 2048
}
},
"required": [
"text",
"url"
]
}
},
"required": [
"title",
"description"
]
}
{
"title": "{string}",
"description": "{string}",
"spamReportingOptions": {
"title": "{string}",
"options": [
"{string}"
]
},
"spamFreeTextSectionTitle": "{string}",
"spamMoreInfo": {
"text": "{string}",
"url": "{string}"
}
}
{
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Specifies the custom title of the preprocessing dialog.",
"maxLength": 128
},
"description": {
"type": "string",
"description": "Specifies the custom text that appears in the preprocessing dialog.",
"maxLength": 250
},
"spamReportingOptions": {
"type": "object",
"description": "Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.",
"properties": {
"title": {
"type": "string",
"description": "Specifies the title listed before the reporting options list.",
"maxLength": 128
},
"options": {
"type": "array",
"description": "Specifies the custom options that a user can select from the preprocessing dialog to provide a reason for reporting a message.",
"items": {
"type": "string",
"minItems": 1,
"maxItems": 5
}
}
},
"required": [
"title",
"options"
]
},
"spamFreeTextSectionTitle": {
"type": "string",
"description": "A text box to the preprocessing dialog to allow users to provide additional information on the message they\u0027re reporting. This value is the title of that text box.",
"maxLength": 128
},
"spamMoreInfo": {
"type": "object",
"description": "Specifies the custom text and URL to provide informational resources to the users.",
"properties": {
"text": {
"type": "string",
"description": "Specifies display content of the hyperlink pointing to the site containing informational resources in the preprocessing dialog of a spam-reporting add-in.",
"maxLength": 128
},
"url": {
"type": "string",
"description": "Specifies the URL of the hyperlink pointing to the site containing informational resources in the preprocessing dialog of a spam-reporting add-in.",
"maxLength": 2048
}
},
"required": [
"text",
"url"
]
}
},
"required": [
"title",
"description"
]
}
Properties
title
Specifies the custom title of the preprocessing dialog of a spam-reporting add-in.
Constraints
Maximum string length: 128.
title
Specifies the custom title of the preprocessing dialog of a spam-reporting add-in.
This property is localizable. For more information, see the localization schema.
Constraints
Maximum string length: 128.
description
Specifies the custom text that appears in the preprocessing dialog of a spam-reporting add-in.
Constraints
Maximum string length: 250.
description
Specifies the custom text that appears in the preprocessing dialog of a spam-reporting add-in.
This property is localizable. For more information, see the localization schema.
Constraints
Maximum string length: 250.
spamNeverShowAgainOption
Indicating if the developer will allow the user to permanently bypass the PreProcessing Dialog for this add-in. Default value: "false". To learn more, see Suppress the preprocessing dialog.
Supported values
Default value: false
.
spamReportingOptions
Specifies up to five options that a user can select from the preprocessing dialog to provide a reason for reporting a message.
spamFreeTextSectionTitle
Adds a text box to the preprocessing dialog for users to provide additional information on the message they're reporting. The string provided in this property appears above the text box.
Constraints
Maximum string length: 128.
spamFreeTextSectionTitle
Adds a text box to the preprocessing dialog for users to provide additional information on the message they're reporting. The string provided in this property appears above the text box.
This property is localizable. For more information, see the localization schema.
Constraints
Maximum string length: 128.
spamMoreInfo
Configures a link to provide informational resources to a user. In the preprocessing dialog, the link appears below the text provided in spamPreProcessingDialog.description
.