BhaMail is a production-ready, self-hosted email solution that provides Gmail-like functionality for individuals, teams, and organizations. Built with modern technologies and designed for easy deployment and maintenance.

• Modern Web Interface - Gmail-like UI with responsive design
• Mobile Apps - Native Flutter apps for iOS and Android
• Email Protocols - Full SMTP, IMAP, and POP3 support
• Conversation Threading - Smart email grouping and organization
• Advanced Search - Powered by OpenSearch with full-text indexing
• Attachment Support - File uploads with virus scanning
• Rich Text Editor - HTML email composition with formatting
• Labels and Filters - Customizable email organization
• Multiple Accounts - Support for multiple email domains

• Two-Factor Authentication (2FA) - TOTP support
• DKIM Signing - Domain-based email authentication
• JWT Tokens - Secure API authentication
• Rate Limiting - Protection against abuse
• Virus Scanning - ClamAV integration for attachments
• Encrypted Storage - Secure password hashing

• Admin Panel - Web-based administration interface
• User Management - Create, edit, and manage user accounts
• Domain Configuration - Multi-domain email hosting
• Monitoring - Health checks and system metrics
• Backup/Restore - Automated backup and recovery tools
• API Access - RESTful API with OpenAPI documentation

• Docker Compose - Local development and testing
• Kubernetes - Production-ready container orchestration
• MinIO Storage - S3-compatible object storage for attachments
• Redis Cache - Performance optimization and session management
• PostgreSQL - Robust database with full ACID compliance
• MailHog - Email testing and development tools

• Docker and Docker Compose
• Node.js 18+ (for development)
• Git

1. Clone the repository

   git clone https://github.com/your-org/bhamail.git
   cd bhamail

2. Run setup script

   ./scripts/setup.sh

3. Start services

   docker-compose up -d

4. Seed database

   npm run seed

5. Access the application

   • Web App: http://localhost:3000
   • API Docs: http://localhost:3001/api-docs
   • MailHog: http://localhost:8025
   • Admin: admin@bhamail.local / password

See Production Deployment Guide for detailed instructions.

bhamail/
├── api/                    # Backend API (Node.js + TypeScript)
│   ├── src/               # Source code
│   ├── migrations/        # Database migrations
│   └── package.json
├── web/                   # Frontend web app (React + Vite)
│   ├── src/               # React components and pages
│   ├── public/            # Static assets
│   └── package.json
��── mobile/                # Mobile app (Flutter)
│   ├── lib/               # Dart source code
│   ├── android/           # Android-specific files
│   ├── ios/               # iOS-specific files
│   └── pubspec.yaml
├── infra/                 # Infrastructure as code
│   ├── k8s/               # Kubernetes manifests
│   └── terraform/         # Terraform configurations
├── docs/                  # Documentation
│   ├── api.md             # API documentation
│   ├── deployment.md      # Deployment guide
│   └── architecture.md    # System architecture
├── scripts/               # Utility scripts
│   ├── setup.sh           # Development setup
│   ├── seed.js            # Database seeding
│   ├── backup.sh          # Backup script
│   └── restore.sh         # Restore script
├── tests/                 # Test suites
│   ├── api/               # API tests
│   ├── web/               # Web app tests
│   └── e2e/               # End-to-end tests
└── docker-compose.yml     # Local development environment

• Node.js - Runtime environment
• TypeScript - Type-safe JavaScript
• Express.js - Web framework
• PostgreSQL - Primary database
• Redis - Caching and queues
• MinIO - Object storage (S3-compatible)
• OpenSearch - Search and analytics
• ClamAV - Antivirus scanning

• React - UI library
• Vite - Build tool and dev server
• Tailwind CSS - Utility-first CSS framework
• Radix UI - Accessible component primitives
• React Query - Data fetching and state management
• React Router - Client-side routing

• Flutter - Cross-platform mobile framework
• Dart - Programming language
• Provider/Riverpod - State management
• HTTP - API communication

• Docker - Containerization
• Kubernetes - Container orchestration
• Terraform - Infrastructure as code
• GitHub Actions - CI/CD pipelines

• API Documentation
• Architecture Overview
• Deployment Guide
• Development Guide
• Security Guide
• Troubleshooting

# Database
DB_HOST=localhost
DB_PORT=5432
DB_NAME=bhamail
DB_USER=bhamail
DB_PASSWORD=bhamail123

# Redis
REDIS_HOST=localhost
REDIS_PORT=6379

# JWT
JWT_SECRET=your-super-secret-jwt-key
JWT_EXPIRES_IN=7d

# Mail
SMTP_HOST=mailhog
SMTP_PORT=1025
SMTP_SECURE=false

# Storage
MINIO_ENDPOINT=localhost:9000
MINIO_ACCESS_KEY=minioadmin
MINIO_SECRET_KEY=minioadmin
MINIO_BUCKET=bhamail-attachments

# Search
OPENSEARCH_HOST=localhost:9200

cd api
npm test
npm run test:coverage

cd web
npm test
npm run test:e2e

npm run test:integration

We welcome contributions! Please see our Contributing Guide for details.

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes
4. Add tests for your changes
5. Run the test suite: npm test
6. Commit your changes: git commit -m 'Add amazing feature'
7. Open a Pull Request

This project is licensed under the MIT License - see the LICENSE file for details.

• Documentation: Check our docs for detailed guides
• Issues: Report bugs or request features on GitHub Issues
• Discussions: Join community discussions on GitHub Discussions
• Email: Contact us at support@bhamail.com

• Calendar integration
• Contact management
• Email templates
• Mobile push notifications
• Advanced spam filtering

• End-to-end encryption (PGP)
• Chat integration
• File sharing and collaboration
• Advanced analytics dashboard
• Multi-language support

• AI-powered email categorization
• Video calls integration
• Advanced workflow automation
• Third-party app marketplace
• Enterprise features (SSO, LDAP)

Thank you to our sponsors who make this project possible!

Become a sponsor and get your logo here.

• Mailcow - Inspiration for self-hosted email
• Gmail - UI/UX inspiration
• Postfix - SMTP server reference
• Dovecot - IMAP server reference
• OpenSearch - Search functionality
• MinIO - S3-compatible storage

Made with ❤️ by the BhaMail team - Open Source Email Service

A production-grade, Gmail-like email service built with modern web technologies. BhaMail provides a complete email solution with web and mobile clients, focusing on privacy, security, and ease of deployment.

• Docker Desktop
• Node.js 18+ (for development)
• Git

1. Clone and Setup

git clone <repository-url>
cd BhaMail
cp .env.example .env

2. Start Services

docker-compose up -d

3. Initialize Database and Seed Data

npm run setup
npm run seed

4. Access the Application

• Web UI: http://localhost:3000
• API Docs: http://localhost:8000/docs
• MailHog (Email Testing): http://localhost:8025
• Admin Login: admin@bhamail.local / password

BhaMail/
├── api/                 # Node.js + TypeScript Backend
│   ├── src/
│   │   ├── controllers/ # API controllers
│   │   ├── services/    # Business logic
│   │   ├── models/      # Database models
│   │   ├── middleware/  # Express middleware
│   │   ├── routes/      # API routes
│   │   └── utils/       # Utilities
│   ├── migrations/      # Database migrations
│   ├── tests/           # Backend tests
│   └── package.json
├── web/                 # React + Vite Frontend
│   ├── src/
│   │   ├── components/  # React components
│   │   ├── pages/       # Page components
│   │   ├── services/    # API services
│   │   ├── hooks/       # Custom hooks
│   │   └── utils/       # Utilities
│   ├── public/          # Static assets
│   └── package.json
├── mobile/              # Flutter Mobile App
│   ├── lib/
│   │   ├── screens/     # Mobile screens
│   │   ├── widgets/     # Reusable widgets
│   │   └── services/    # API services
│   └── pubspec.yaml
├── infra/               # Infrastructure
│   ├── docker-compose.yml
│   ├── k8s/             # Kubernetes manifests
│   └── helm/            # Helm charts
├── docs/                # Documentation
├── scripts/             # Utility scripts
└── tests/               # Integration & E2E tests

• API: Node.js + TypeScript + Express
• Database: PostgreSQL
• Cache: Redis
• Queue: BullMQ
• Search: OpenSearch
• Storage: MinIO (S3-compatible)
• Mail: MailHog (dev) / Postfix+Dovecot (prod)
• Security: JWT, bcrypt, rate limiting
• Monitoring: Prometheus + Grafana

• Web: React + Vite + TypeScript
• Mobile: Flutter
• PWA: Service Workers, offline support
• UI: Tailwind CSS, shadcn/ui components

• Containers: Docker + Docker Compose
• Orchestration: Kubernetes + Helm
• CI/CD: GitHub Actions
• Testing: Jest, Cypress, k6

cd api
npm install
npm run dev          # Start development server
npm run build        # Build for production
npm run test         # Run tests
npm run migrate      # Run database migrations

cd web
npm install
npm run dev          # Start development server
npm run build        # Build for production
npm run test         # Run tests
npm run preview      # Preview production build

cd mobile
flutter pub get
flutter run          # Run on connected device
flutter build apk    # Build Android APK

• ✅ Email/password signup and login
• ✅ JWT + refresh token authentication
• ✅ Password reset via email
• ✅ Two-factor authentication (TOTP)
• ✅ Rate limiting and account lockouts
• ✅ CSRF protection and CORS configuration

• ✅ Compose, send, reply, forward emails
• ✅ Conversation threading
• ✅ Drafts auto-save
• ✅ Attachments with virus scanning
• ✅ Labels and folders
• ✅ Email filters and rules
• ✅ Full-text search with OpenSearch
• ✅ Schedule send and snooze
• ✅ Offline support via service workers

• ✅ Multi-tenant support
• ✅ User management admin panel
• ✅ Quota management and monitoring
• ✅ Audit logs and compliance features
• ✅ Backup and restore procedures

• ✅ SMTP sending and receiving
• ✅ IMAP/POP3 support documentation
• ✅ SPF/DKIM/DMARC configuration
• ✅ External client support (Outlook, Thunderbird)

See docs/production-ops.md for detailed instructions.

helm install bhamail ./infra/helm/bhamail

• Architecture Overview
• API Documentation
• Production Operations
• SPF/DKIM/DMARC Setup
• Security Best Practices
• Development Guide

npm run test

npm run test:integration

npm run test:e2e

npm run test:load

BhaMail implements security best practices:

• TLS encryption for all communications
• Secure password storage with bcrypt/Argon2
• JWT tokens with secure refresh mechanism
• CSRF tokens and XSS protection
• Rate limiting and DDoS protection
• Virus scanning for attachments
• Audit logging for compliance

Currently supported languages:

• English (default)
• Hindi (example implementation)

MIT License - see LICENSE file for details.

See CONTRIBUTING.md for development setup and contribution guidelines.

For support, please open an issue on GitHub or join our community discussions.