🚨🚨🚨 IMPORTANT DISCLAIMER 🚨🚨🚨

This project is currently in early development, and things may break unexpectedly. It also lacks proper authentication. It is NOT recommended to expose this application to the internet, as you will be providing the world access to your emails. Use at your own discretion and only in a controlled environment for now.

While feedback and contributions are appreciated during this early development phase, please note that this project is not yet suitable for use as a stable email backup solution. The first stable release is targeted for the end of the year. If you require a reliable email archiving solution, it is advisable to wait until the stable release.

Use at your own risk and in a controlled environment only.

Briefbox

Briefbox is a tool for archiving emails from multiple IMAP and POP3 accounts. It provides a user-friendly web interface for managing email accounts, searching archived emails, and viewing email details along with attachments. One of the standout features of Briefbox is its advanced search functionality, which allows users to quickly find specific emails using various criteria.

Setup and Usage

1. Clone the repository:

   git clone https://github.com/bandundu/email-archiver.git

2. Navigate to the backend directory:

   cd email-archiver/backend

3. Create a virtual environment:

   python -m venv .venv

4. Activate the virtual environment:

   source .venv/bin/activate

5. Install the required dependencies:

   pip install -r requirements.txt

6. Launch the backend:

   python app.py

   The backend will start running on http://localhost:5050.

7. Open a new terminal and navigate to the frontend directory:

   cd ../frontend/briefbox-front

8. Install the frontend dependencies:

   npm install

9. Start the frontend development server:

   npm start

   The frontend will be accessible at http://localhost:3000.

10. Access the web interface by opening a web browser and navigating to http://localhost:3000.

11. Use the web interface to add email accounts, search for emails, and view email details.

Note: I apologize for the inconvenience, but I am are currently working on improving the Docker Compose setup for a smoother deployment experience. In the meantime, please follow the above steps for a bare-metal installation.

Future Enhancements

• Email export functionality
• Gmail and Outlook OAuth2 authentication
• Advanced search capabilities (e.g., date range, multiple criteria)
• Improved user interface and user experience

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Make sure to follow the project's code of conduct.