Share via

extensionRibbonsArrayFixedControlItem object

  • Article

Configures the button of an integrated spam-reporting add-in in Outlook. Must configure if spamReportingOverride is specified in the extensions.ribbons.contexts array.

Properties that reference this object type:

Syntax

{
  "id": "{string}",
  "type": "button",
  "label": "{string}",
  "icons": [
    {
      "size": {number},
      "url": "{string}"
    }
  ],
  "supertip": {
    "title": "{string}",
    "description": "{string}"
  },
  "actionId": "{string}",
  "enabled": {boolean}
}

Properties

id

Specifies the unique ID of the button of a spam-reporting add-in.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

type

Defines the control type of a spam-reporting add-in.

Type
string

Required
✅

Constraints

Supported values
Allowed values: button.

label

Specifies the text that appears on button of a spam-reporting add-in.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

label

Specifies the text that appears on button of a spam-reporting add-in.

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

icons

Defines the icons for the button of a spam-reporting add-in. There must be at least three child objects, each with icon sizes of 16, 32, and 80 pixels respectively.

Type
Array of extensionCommonIcon

Required
✅

Constraints
Minimum array items: 1. Maximum array items: 3.

Supported values

supertip

Configures a supertip for the button of a spam-reporting add-in.

Type
extensionCommonSuperToolTip

Required
✅

Constraints

Supported values

actionId

Specifies the ID of the action taken when a user selects the button of a spam-reporting add-in. The actionId must match the runtime.actions.id property of an action in the runtimes object.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

enabled

This property must be specified in the fixedControls object. However, it doesn't affect the functionality of a spam-reporting add-in.

Type
boolean

Required
✅

Constraints

Supported values
Default value: True.