Thunderbird AI Extension

Introduction

The ChatGPT Thunderbird Extension uses OpenAI's GPT-3.5 API to assist with email writing. It allows you to generate automatic responses in various tones and styles.

Authors

• @NoahLeu
• @hawk305
• @alex199626
• @paulinem-unirostock
• @Lukasz-Reszcz
• @HuseynAhmedov

Installation

Prerequisites

Note for Windows User: Before you start, it's recommended to install the Windows Subsystem for Linux (WSL) on your Windows computer and clone the repository directly in the WSL environment. This will make it easier to follow all the steps. Follow these instructions:

1. Install WSL

   • WSL Installation Guide
   • Open PowerShell as Administrator and run:

     wsl --install

   • Restart your computer.

2. Set Up WSL

   • Open WSL (e.g., Ubuntu) and complete the setup.

3. Clone the Repository

   • Clone the repository into your WSL environment:

     git clone https://github.com/clecap/web20-2024.git
     cd <repo-name>

From here the Installation Process is the same for all Operationg Systems:

1. Install Node Version Manager (nvm)

   • Installation Guide

2. Install Node.js

   • Install the latest version with:

     nvm install node

3. Install Project Dependencies

   • Navigate to the project directory and run:

     npm install

Build the Extension

To build the extension, follow these steps:

1. Run the build script in the project directory:

   ./build

2. Install the generated .xpi file into Thunderbird:

   • Open Thunderbird.
   • Go to Tools > Add-ons.
   • Click on the gear icon and select Install Add-on From File....
   • Choose the generated .xpi file and follow the prompts.

Usage

To use the ChatGPT Thunderbird Extension:

1. Open an email in Thunderbird.
2. Click the 'ChatGPT Thunderbird' button located alongside the 'Reply', 'Forward', etc. buttons.
3. On your first use, you will need to provide your OpenAI API key. To do this click on 'General Settings', enter the key and click 'Save'.
4. Select the desired reply intention and tone provided by ChatGPT.
5. Click the 'Generate' button to create a reply.
6. Review the generated reply. Once satisfied, click the 'Choose' button.
7. Edit the message as needed and then send it.

Current Features

• Email writing, Summary support using OpenAI's GPT-3.5 API
• Personalization options for generated messages
• Summary of the email content using the LLM API
• Summary includes spam detection
• Template based generation context for LLM (e.g. provide chatgpt with information on your work place in a question-answer format)

Further Development

This is a list of possible ideas to be integrated into the project in the future:

• Send AI generated calendar invites (.ics files)
• Check own calendar availability before sending invites

Roles

Project Management

• @NoahLeu

BE: Team 1 (Writing Assistant)

• @NoahLeu
• @alex199626
• @paulinem-unirostock

BE: Team 2 (Summarization Tool)

• @hawk305
• @Lukasz-Reszcz

FE

• @HuseynAhmedov

License

MIT