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

Email archiving tool for IMAP/POP3 accounts (early development)
https://github.com/bandundu/email-archiver

archiving email flask imap pop react

Last synced: about 2 months ago
JSON representation

Email archiving tool for IMAP/POP3 accounts (early development)

• Host: GitHub
• URL: https://github.com/bandundu/email-archiver
• Owner: bandundu
• Created: 2024-03-06T20:27:43.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T06:08:05.000Z (4 months ago)
• Last Synced: 2024-07-05T05:46:51.260Z (3 months ago)
• Topics: archiving, email, flask, imap, pop, react
• Language: JavaScript
• Homepage:
• Size: 487 KB
• Stars: 185
• Watchers: 6
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

    

  



**This project is currently in early development, and things may break unexpectedly.**

# 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.

  

    

    

  

  

    

    

  

## Prerequisites

- Python 3.x

- Node.js

- npm

## Setup and Usage

1. Clone the repository:

   ```bash

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

   ```

2. Navigate to the backend directory:

   ```bash

   cd email-archiver/backend

   ```

3. Create a virtual environment:

   ```bash

   python -m venv .venv

   ```

4. Activate the virtual environment:

   ```bash

   source .venv/bin/activate

   ```

5. Install the required dependencies:

   ```bash

   pip install -r requirements.txt

   ```

6. Launch the backend:

   ```bash

   python app.py

   ```

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

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

   ```bash

   cd ../frontend/briefbox-front

   ```

8. Install the frontend dependencies:

   ```bash

   npm install

   ```

9. Start the frontend development server:

   ```bash

   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.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=bandundu/email-archiver&type=Date)](https://star-history.com/#bandundu/email-archiver&Date)