# Reporting Plugin

## Introduction

Mail reporting plugins (AKA "phishing buttons") enhance email security by allowing users to report phishing attempts directly from their email clients. They streamline the process, making it easier for organizations to identify and respond to potential threats.

***

## Supported Clients

* Office 365 (Desktop, Web, Mobile)
* Google Workspace (Gmail)

## Deprecated Clients

* Outlook 2016, 2019
* Outlook for Mac (2016, 2019)

{% hint style="danger" %}
[Support for Office 2016 and Office 2019 ended on October 14, 2025](https://learn.microsoft.com/en-us/officeupdates/update-history-office-2019). If you haven't already begun to upgrade your Office environment to a newer version of Office, Microsoft recommends that you start now. For more information, see [Plan an upgrade from older versions of Office to Microsoft 365 Apps](https://learn.microsoft.com/en-us/deployoffice/endofsupport/plan-upgrade-older-versions-office). 

Because Microsoft has deprecated these versions of Outlook, any issues with the Reporting Plugin on those platforms are a result of Microsoft’s decision to end support. Unfortunately, we are unable to provide troubleshooting or further assistance for software Microsoft has retired.
{% endhint %}

## Prerequisites

A connected Azure application. See [here](https://wiki.lucysecurity.com/application-reference/settings/common-system-settings/azure-applications) for details.

This application must then be selected in the plugin settings.

## Client Profiles

Starting in Lucy version 4.13 you can save plugin configurations on a per-client basis (one profile per client). When you are ready to download the plugin you will be prompted to select a client, and the plugin will use that client's settings profile.

<figure><img src="https://3536856424-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVYPsDfg76rUuy4DWfSsJ%2Fuploads%2FvkeGMR3njD3MMsUrSqBy%2Fimage.png?alt=media&#x26;token=1e1d0823-ca1e-431a-9539-c5698be0e93e" alt=""><figcaption></figcaption></figure>

## Plugin Settings

Before we can begin using the plugin we must configure it. To configure, navigate to **Settings > Submitted Email Settings > Plugin Settings** and create a new configuration. See [this platform reference page](https://wiki.lucysecurity.com/application-reference/settings/submitted-email-settings/plugin-settings) for details on the configuration options.

{% hint style="success" %}
Remember to select your Azure application in the Plugin settings at the bottom!
{% endhint %}

***

## Download the plugin

{% hint style="success" %}
You must [configure your plugin settings](https://wiki.lucysecurity.com/application-reference/settings/submitted-email-settings/plugin-settings) before downloading and deploying.
{% endhint %}

To download the plugin navigate to the **Incidents Dashboard** and select **Download Plugin**, then select the appropriate option for your mail client.

<figure><img src="https://3536856424-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVYPsDfg76rUuy4DWfSsJ%2Fuploads%2FL5tMOIxRdyrvwpj6SwVb%2Fimage.png?alt=media&#x26;token=afbb2b87-1dc0-4205-8708-8dc71972df52" alt=""><figcaption></figcaption></figure>

* **User/Machine Wide:** MSI installer for Outlook Native
* ~~**Classic Microsoft Outlook 365:** XML file for O365 using REST API~~
* **Microsoft Outlook 365:** XML file for O365 using [Microsoft's Graph API](https://learn.microsoft.com/en-us/graph/)
* **Gmail Addon:** [App script](https://www.google.com/script/start/) for Gmail clients.

{% hint style="danger" %}

#### Deprecation notice for REST API plugin

Microsoft has ended support for REST-based plugins, please use the Graph API version.
{% endhint %}

In Lucy version 5.4 and above the download options have been updated to reflect this change:

<figure><img src="https://3536856424-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVYPsDfg76rUuy4DWfSsJ%2Fuploads%2FHjMsP1TfbKJTagfaA900%2Fimage.png?alt=media&#x26;token=26055900-e725-4f46-8595-7ecd93c61a8b" alt=""><figcaption></figcaption></figure>

***

## Deployment

LUCY's reporting plugin is compatible with Microsoft O365, Outlook Native, and Gmail. The deployment is a little different for each version, so be sure to use the guide for your mail client.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><strong>Microsoft Office 365</strong><br><strong>(XML)</strong></td><td></td><td><a href="reporting-plugin/deploying-office-365">deploying-office-365</a></td><td></td></tr><tr><td></td><td><strong>Outlook Native</strong><br><strong>(MSI)</strong></td><td></td><td><a href="reporting-plugin/deploying-outlook-native-deprecated">deploying-outlook-native-deprecated</a></td><td></td></tr><tr><td></td><td><strong>Gmail</strong><br><strong>(apps script)</strong></td><td></td><td><a href="reporting-plugin/deploying-gmail">deploying-gmail</a></td><td></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.lucysecurity.com/guides/reporting-plugin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
