Mail-in-a-Box User Interface

An experimental SPA user interface for Mail-in-a-Box, using the following tools:

• React & Redux
• TypeScript
• Fluent UI design system
• Mail-in-a-Box API client

NOTE: This is very much alpha software, use at your own risk. See FEATURES.md for missing features.

Screenshots

👉 View Screenshots

Demo

👉 View Demo

The demo uses a mock API, you can perform any action.

Running Locally

Requirements

• Node.js

Instructions

1. Clone the repo
2. Copy src/config/config.example.json to src/config/config.json and
   • Update the hostname field, or
   • If you want to use a mock API, set mockApi to true
3. From the root of the project:
   1. Run npm install
   2. Run npm start

All API requests sent from the browser are proxied to your box instance via a backend Node.js server to bypass CORS restrictions.

Running in Production

Download the latest production release here: https://github.com/badsyntax/mailinabox-ui/releases/latest

(I'll add instructions on how to deploy to a Mail-in-a-Box instance in the future.)

Related Projects

This project uses a Mail-in-a-Box API client SDK, generated by https://github.com/badsyntax/mailinabox-api.

Features

See FEATURES.md

License

See LICENSE.md