aeyoll / mailboar

Mailboar provides a web interface for Tiny MailCatcher, a MailCatcher clone written in Rust.

Mailboar

Mailboar provides a web interface for Tiny MailCatcher, a MailCatcher clone written in Rust.

• Installation
  • Using Cargo, Git and Yarn
  • Using Docker
• Development

Installation

Using Cargo, Git and Yarn

First, install mailboar using Cargo:

cargo install mailboar

Then, clone this repository, and build the static assets using https://yarnpkg.com/. Node >= 14 is required.

yarn # Install dependencies
yarn run build # Build static assets

This will create a static repository with all the assets.

Finally, launch mailboar from the cloned repository:

mailboar --ip 127.0.0.1 --smtp-port=1025 --api-port=1080 --http-port=8025 # default values

Using Docker

There is also a small Docker image available, with all batteries included:

docker run --rm --init -t -p 1080:1080 -p 1025:1025 -p 8025:8025 aeyoll/mailboar:latest

Development

For easier development, use https://github.com/watchexec/cargo-watch to auto-compile on change:

cargo watch -x 'run'

Auto-compile static assets:

yarn run start

Rust version requirements

1.62.0+