Edit

Share via

ReportPhishingCustomization element

Configures the ribbon button and preprocessing dialog of a spam-reporting add-in in Outlook.

To learn more about how to implement the spam reporting feature in your add-in, see Implement an integrated spam-reporting add-in.

Add-in type: Mail

Valid only in these VersionOverrides schemas:

  • Mail 1.1

For more information, see Version overrides in the add-in only manifest.

Associated with these requirement sets:

Contained in

Attributes

None.

Child elements

Element Required Description
Control Yes Configures and adds the add-in button to the ribbon. The xsi:type attribute must be set to Button and the xsi:type attribute of its <Action> child element must be set to ExecuteFunction.
PreProcessingDialog Yes Configures the preprocessing dialog shown after the add-in button is selected from the ribbon. This dialog allows users to provide additional information about a message they're reporting.
SourceLocation element (version overrides) Yes Specifies the location of the source JavaScript file.

Important: The resid value of the <SourceLocation> element must match the resid value of the <Runtime> element that represents the browser runtime. For example, if your runtime is defined as <Runtime resid="WebViewRuntime.Url">, specify <SourceLocation resid="WebViewRuntime.Url"/>.

Example

<ExtensionPoint xsi:type="ReportPhishingCommandSurface">
  <ReportPhishingCustomization>
    <!-- Configures the ribbon button. -->
    <Control xsi:type="Button" id="ReportingButton">
      <Label resid="ReportingButton.Label"/>
      <Supertip>
        <Title resid="ReportingButton.Label"/>
        <Description resid="ReportingButton.Description"/>
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="Icon.16x16"/>
        <bt:Image size="32" resid="Icon.32x32"/>
        <bt:Image size="64" resid="Icon.64x64"/>
        <bt:Image size="80" resid="Icon.80x80"/>
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>onMessageReport</FunctionName>
      </Action>
    </Control>
    <!-- Configures the preprocessing dialog. -->
    <PreProcessingDialog>
      <Title resid="PreProcessingDialog.Label"/>
      <Description resid="PreProcessingDialog.Description"/>
      <ReportingOptions>
        <Title resid="OptionsTitle.Label"/>
        <Option resid="Option1.Label"/>
        <Option resid="Option2.Label"/>
        <Option resid="Option3.Label"/>
        <Option resid="Option4.Label"/>
      </ReportingOptions>
      <FreeTextLabel resid="FreeText.Label"/>
      <MoreInfo>
        <MoreInfoText resid="MoreInfo.Label"/>
        <MoreInfoUrl resid="MoreInfo.Url"/>
      </MoreInfo>
    </PreProcessingDialog>
    <!-- Identifies the runtime to be used. The resid value must match the resid value of the Runtime element that represents the browser runtime. -->
    <SourceLocation resid="Commands.Url"/>
  </ReportPhishingCustomization>
</ExtensionPoint>
  • Last updated on