Skip to content

LucBennett/ReportPhishing

Repository files navigation

icon ReportPhishing

ReportPhishing is a Thunderbird MailExtension that makes it easy to report phishing emails. With a simple click, you can submit a copy of a suspicious email to multiple phishing report services, including:

Simply select the services, and click submit!


⚠️ Warning: Beware of Phishing Emails!

Phishing emails attempt to steal your personal information by pretending to be from legitimate organizations. Never click on links or download attachments from suspicious emails. If you receive a phishing email, report it immediately to the appropriate authorities.


🚀 Download

You can download the latest version of ReportPhishing from the Releases page.

🛠️ Build Instructions

To build the extension from source, follow these steps:

  1. Navigate to the project directory
    Open your terminal or command prompt and go to the project folder.

  2. Run the appropriate compile script based on your operating system:

    • Node.js:

      node compile.js

      (Requires Node.js)

    • Unix & macOS:

      ./compile.sh

      (Requires /bin/sh and 7z or zip installed)

    • Windows (with .NET):

      ./compile.ps1

      (Requires PowerShell and .NET)

    • Windows (with 7z/zip):

      ./compile-z.ps1

      (Requires PowerShell and 7z or zip installed)

    Alternatively, you can compile using:

    npm run compile

    The compiled .xpi file will be located in the build directory.


📥 Installation Instructions

To install ReportPhishing in Thunderbird:

  1. Open Thunderbird.
  2. Navigate to Menu (hamburger icon) → Add-ons and Themes.
  3. Click Tools for Add-ons (gear icon) → Install Add-on From File.
  4. Select the ReportPhishing.xpi file and install it.

🔧 Development Workflow

To maintain a clean and efficient codebase, use the following tools:

🖋️ Prettier (Code Formatter)

Format the code:

npm run format

🕵️ ESLint (Code Linter)

Check for code issues:

npm run lint

⚙️ Compiling

To compile the extension:

npm run compile

🧪 Running Tests

ReportPhishing includes automated tests to ensure proper functionality.

  1. Install dependencies:

    npm install
  2. Run the test suite:

    npm run test

Regularly running tests helps catch and fix any issues before releasing updates.


❤️ Support This Project

If you find ReportPhishing useful, consider supporting development:

Buy me a coffee!


📜 License

ReportPhishing is licensed under the Mozilla Public License 2.0 (MPL-2.0).
See the LICENSE file for details.


🎨 Icon Credits

The icon was created by freepik and is available on FlatIcon.

About

Thunderbird extension to report phishing emails.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published