{"id":13820486,"url":"https://github.com/bandundu/email-archiver","last_synced_at":"2025-05-16T10:31:04.180Z","repository":{"id":226293443,"uuid":"768294292","full_name":"bandundu/email-archiver","owner":"bandundu","description":"Email archiving tool for IMAP/POP3 accounts (early development)","archived":false,"fork":false,"pushed_at":"2024-05-28T06:08:05.000Z","size":499,"stargazers_count":190,"open_issues_count":8,"forks_count":7,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-08-04T08:04:30.595Z","etag":null,"topics":["archiving","email","flask","imap","pop","react"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bandundu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-06T20:27:43.000Z","updated_at":"2024-08-01T22:07:15.000Z","dependencies_parsed_at":"2024-03-29T16:46:34.850Z","dependency_job_id":"66814575-1393-4aea-bf9c-12b790d89339","html_url":"https://github.com/bandundu/email-archiver","commit_stats":null,"previous_names":["bandundu/email-archiver"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bandundu%2Femail-archiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bandundu%2Femail-archiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bandundu%2Femail-archiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bandundu%2Femail-archiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bandundu","download_url":"https://codeload.github.com/bandundu/email-archiver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225423624,"owners_count":17472149,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archiving","email","flask","imap","pop","react"],"created_at":"2024-08-04T08:01:04.309Z","updated_at":"2024-11-19T20:30:36.843Z","avatar_url":"https://github.com/bandundu.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/your-invite-link\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/1236779067252936736?color=7289DA\u0026label=Discord\u0026logo=discord\u0026logoColor=white\u0026style=for-the-badge\" alt=\"Discord\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n**This project is currently in early development, and things may break unexpectedly.**\n\n# Briefbox\n\nBriefbox 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.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg width=\"500\" alt=\"image\" src=\"https://github.com/bandundu/email-archiver/assets/41874924/c6775f3b-f1b8-41e5-9650-0278fd30a813\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg width=\"500\" alt=\"image\" src=\"https://github.com/bandundu/email-archiver/assets/41874924/dcd67645-f809-45cc-8f01-b3574df20bbe\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg width=\"500\" alt=\"image\" src=\"https://github.com/bandundu/email-archiver/assets/41874924/c8ff9719-3798-4ee8-a2ca-ac6992c6fca2\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg width=\"500\" alt=\"image\" src=\"https://github.com/bandundu/email-archiver/assets/41874924/cabdef22-4f56-47e7-ace3-07c39e8416fc\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\n\n\n\n\n\n## Prerequisites\n\n- Python 3.x\n- Node.js\n- npm\n\n## Setup and Usage\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/bandundu/email-archiver.git\n   ```\n\n2. Navigate to the backend directory:\n\n   ```bash\n   cd email-archiver/backend\n   ```\n\n3. Create a virtual environment:\n\n   ```bash\n   python -m venv .venv\n   ```\n\n4. Activate the virtual environment:\n\n   ```bash\n   source .venv/bin/activate\n   ```\n\n5. Install the required dependencies:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n6. Launch the backend:\n\n   ```bash\n   python app.py\n   ```\n\n   The backend will start running on `http://localhost:5050`.\n\n7. Open a new terminal and navigate to the frontend directory:\n\n   ```bash\n   cd ../frontend/briefbox-front\n   ```\n\n8. Install the frontend dependencies:\n\n   ```bash\n   npm install\n   ```\n\n9. Start the frontend development server:\n\n   ```bash\n   npm start\n   ```\n\n   The frontend will be accessible at `http://localhost:3000`.\n\n10. Access the web interface by opening a web browser and navigating to `http://localhost:3000`.\n\n11. Use the web interface to add email accounts, search for emails, and view email details.\n\n**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.\n\n\u003c!-- 1. Create a `docker-compose.yml` file in a folder of your chosing with the following content:\n\n```yaml\nversion: '3'\n\nservices:\n  backend:\n    # latest-arm for ARM devices like Raspberry Pi\n    image: bandundu/briefbox-backend:latest\n    ports:\n      - \"5050:5050\"\n    volumes:\n      - ./:/app/data\n    environment:\n      - FLASK_ENV=development\n      - FLASK_APP=app.py\n\n  frontend:\n    # latest-arm for ARM devices like Raspberry Pi\n    image: bandundu/briefbox-frontend:latest\n    ports:\n      - \"3000:3000\"\n    depends_on:\n      - backend\n```\n\n\u003e **Note:** For ARM devices like Raspberry Pi, use the `latest-arm` tag for both backend and frontend images.\n\n2. Run the following command to start the containers:\n\n```bash\ndocker-compose up\n```\n\n3. Access the web interface by opening a web browser and navigating to `http://localhost:3000`.\n\n4. Use the web interface to add email accounts, search for emails, and view email details. --\u003e\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=bandundu/email-archiver\u0026type=Date)](https://star-history.com/#bandundu/email-archiver\u0026Date)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbandundu%2Femail-archiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbandundu%2Femail-archiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbandundu%2Femail-archiver/lists"}