devmount / third-stats

Thunderbird add-on turning your emails into beautifully visualized email account stats. Built with Vue.js and Chart.js
https://addons.thunderbird.net/thunderbird/addon/thirdstats/
MIT License
216 stars 27 forks source link
analytics chartjs email hacktoberfest statistics stats thunderbird thunderbird-addon vuejs

ThirdStats is a Thunderbird add-on for beautifully visualized email account stats.
Download from Thunderbird Add-ons repository. Contributions, corrections & requests can be made on GitHub.
Created by Andreas Müller.

release last commit CodeQL analysis license contributions welcome

Get started

Install ThirdStats from the Thunderbird Add-ons repository:

  1. Start Thunderbird, open the main menu and click on Add-ons
  2. Search for ThirdStats
  3. Click Add to Thunderbird and give necessary permissions
  4. Open the ThirdStats Popup in the upper right corner of the main toolbar and enjoy your email account stats

To properly recognize emails as sent, make sure to configure all email adresses you write from as Thunderbird identities for your email account. You can do so under account settings > select your account > click button more identities at the bottom and add or modify identities as you need.

Also keep in mind, that the processing of large mailboxes can take a lot of time.

Features

Here is how ThirdStats looks like on the Thunderbird default dark theme and light theme on Windows:

thirdstats_screenshot_version_1.8.0

Privacy and Security

ThirdStats runs entirely locally and will never contact, send or sell data to, any third-parties.

ThirdStats features require Thunderbird permissions to function, but will always seeks to minimise permissions where possible, and use granular permissions where available (Example: Thunderbird Permissions API does not currently provide for reading only message headers, instead of the entire email, including the body):

See the Security Policy for details how ThirdStats values your privacy.

Support this project

Contributions are very welcome! See the Contribution Guidelines for more information, how to help making this add-on even better.

Spread the word

Become a tester

Cutting edge alpha releases of ThirdStats can be found on the dedicated ThirdStats CDN. You can manually install these alpha releases and test them as you like.

If you encounter any problem, please issue a bug report. If you have ideas for additional features, please issue a feature request.

Become a ThirdStats developer

Here is how you can set up a local development environment:

  1. Clone this project with Git
  2. Install dependencies by running npm install within the cloned directory third-stats/
  3. Start the development server with npm run dev
  4. Open development site by going to http://localhost:8080 in your browser

Note that this tool uses Thunderbirds WebExtension APIs. This means that some JavaScript objects won't be available in your browser as development environment. If you want to test your changes in Thunderbird, do the following:

  1. Save all your changes and run npm run build to create a production build in the dist/ directory
  2. Open Thunderbird, go to main menu > add-ons > gear menu > debug add-ons > This Thunderbird > Load temporary add-on
  3. Now choose the manifest file inside the dist/ directory and your modified add-on will be loaded for the current Thunderbird session. You can check the web console by clicking the button Inspect in the add-on tile.

Special Thanks

Many thanks especially to those who helped translating this add-on and making it more accessable for people around the globe:

Licence

This Thunderbird add-on is licensed under MIT License.


This add-on is completely free to use. If you enjoy it and don't have the time to contribute, please consider donating via Paypal or sponsoring me to support further development. :green_heart: