starzeus/mailrelay-email-client repository overview

⁠Mail Relay Email Client

A modern email client with SMTP server capabilities and advanced email filtering rules.

⁠Features

• Next.js 15 web client for managing emails
• Built-in SMTP server for receiving emails
• Advanced email filtering rules with multiple action types:
  • Forward emails to another address
  • Send to webhook endpoints
  • Publish to Kafka topics
  • Execute custom JavaScript code
• Modern UI built with Tailwind CSS
• PostgreSQL database for email storage
• Docker support for easy deployment

⁠Prerequisites

• Node.js 20 or later
• PostgreSQL 16 or later
• Docker and Docker Compose (optional)
• pnpm package manager

⁠Setup

1. Clone the repository:

   git clone https://github.com/starzeus/mailrelay-email-client.git
   cd mailrelay-email-client
   

   Copy

2. Install dependencies:

   pnpm install
   

   Copy

3. Copy the environment variables file:

   cp .env.example .env
   

   Copy

4. Update the environment variables in .env with your configuration.

5. Initialize the database:

   pnpm db:migrate
   

   Copy

⁠Running Locally

⁠Development Mode

# Run the Next.js client only
pnpm dev

# Run the SMTP server only
pnpm smtp

# Run both client and SMTP server
pnpm dev:all

⁠Production Mode

pnpm build
pnpm start

⁠Docker Deployment

1. Build and run with Docker Compose:

   docker-compose up -d
   

   Copy

2. The services will be available at:

   • Web Client: http://localhost:3000⁠
   • SMTP Server: localhost:2525

⁠Environment Variables

• POSTGRES_URL: PostgreSQL connection URL
• SMTP_HOST: SMTP server hostname
• SMTP_PORT: SMTP server port
• SMTP_SECURE: Enable/disable TLS
• SMTP_USER: SMTP authentication username
• SMTP_PASS: SMTP authentication password
• SMTP_FROM: Default "From" address
• APP_MODE: Run mode ('client', 'smtp', or 'both')
• APP_PORT: Web client port
• SMTP_SERVER_PORT: SMTP server port
• KAFKA_BROKERS: Kafka broker addresses
• KAFKA_CLIENT_ID: Kafka client identifier
• JWT_SECRET: JWT signing secret

⁠Email Filter Rules

1. Access the Filters & Actions section in the web client
2. Create rules with pattern matching for:
   • From address
   • To address
   • Subject
   • Body content
3. Configure actions:
   • Forward: Send to another email address
   • Webhook: Send to HTTP endpoint
   • Kafka: Publish to Kafka topic
   • JavaScript: Execute custom code

⁠Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

⁠License

MIT License - see LICENSE file for details