Mailflow

Mailflow is a simple and efficient tool for managing your emails. It allows you to organize, prioritize, and perform actions on your emails intuitively, all from an easy-to-use interface.

Features

• Automated Email Management: Organize and classify incoming emails automatically using user-defined rules.
• Intuitive Interface: A simple and user-friendly design that makes email management easy.
• Custom Filters: Create advanced filters to organize your emails according to your preferences.
• Real-time Notifications: Receive alerts and notifications about important emails, so you never miss anything crucial.
• Compatibility with Popular Email Services: Support for Gmail, Outlook, Yahoo Mail, and others.

Installation

Prerequisites

No advanced technical knowledge is required to install Mailflow. You just need to download the appropriate executable for your operating system.

Installation Steps

1. Download Ollama from the official website Ollama and pull the corresponding models

   ollama pull phi3.5
   ollama pull llama3.1

2. Set Ollama to serve and run the server

   ollama serve

3. Install the necessary libraries

4. There are currently 3 available modules which will be described in the following section.

mailextractor Module

This module receives an Email object and returns an ExtractedEmail one. It is possible to run an example on a dummy email by directly running the module via python -m mailextractor.

database module

Database module adds ExtractedEmail objects into a ChromaDB database located in the data folder. It is possible to run a dummy example by running the module directly via python -m database.

retriever module

This modules returns an answer to a question by searching in the vector database generated by the database module. An example can be found execunting the module directly via python -m retriever. Notices that the database has to be previously generated.

tests module

This module contains unit tests for validating the functionality of the email extraction system, specifically focusing on the extraction of CUPS (Código Universal de Punto de Suministro) and CIF (Código de Identificación Fiscal) from email texts. The tests utilize the pytest framework, and logging is set up to provide detailed feedback on the extraction process.

1. Go to the Releases section of the repository.
2. Download the executable file corresponding to your operating system:
   • macOS
   • Linux
   • Windows
3. Follow the installation instructions specific to your operating system.

Once installed, Mailflow will be ready to manage your emails efficiently.

Basic Usage

1. Connect Your Email: Add your email provider information and authenticate your account.
2. Create Rules: Set up automatic rules to organize and manage your emails.
3. View Emails: Browse and manage your emails with custom filters.
4. Automate Responses: Create rules to automatically reply to important emails or filter out irrelevant ones.

Contributing

1. Fork the repository.
2. Create a new branch for your feature or bug fix (git checkout -b branch-name).
3. Make your changes and commit them (git commit -m 'Add new feature').
4. Push to your branch (git push origin branch-name).
5. Create a Pull Request on GitHub. The main branch of the project is main.

Authors

• Pablo Perdomo Falcón - pabllopf
• Alberto L. Mariscal - almariscal

License: GNU General Public License v3.0

Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.