Files
inbox_assistant/README.md
T
2025-03-26 16:46:51 +01:00

1.5 KiB

Inbox Assistant

A simple assistant that prioritizes and summarizes your IMAP inbox using Mistral AI.

Features

  • Fetches emails from an IMAP server
  • Summarizes and prioritizes emails using Mistral AI
  • Displays the summary and emails in a web interface

Requirements

  • Python 3.13
  • Flask
  • imap-tools
  • Mistral AI
  • ruff

Installation

  1. Clone the repository:
git clone https://codeberg.org/gurix/inbox_assistant.git
cd inbox_assistant
  1. Create a virtual environment and activate it:
python -m venv .venv
source .venv/bin/activate
  1. Install the dependencies:
uv sync
  1. Set up the environment variables by using direnv:

Create a .envrc file in the root directory with the following content:

export MISTRAL_API_KEY=your_mistral_api_key
export IMAP_SERVER=your_imap_server
export EMAIL_ACCOUNT=your_email_account
export EMAIL_PASSWORD=your_email_password
  1. Run the application:
uv run app.py

Usage

  • Access the web interface at http://localhost:5003
  • The assistant will fetch emails from the IMAP server, summarize them, and display the summary and prioritized emails

Configuration

  • The assistant can be configured by modifying the instructions variable in the app.py file
  • The IMAP server, email account, and password can be configured via envorinment variables.
  • The Mistral AI API key can be configured via envorinment variables.

License

This project is licensed under the MIT License.