🚀 Quickstart

Download RustMailer

Download the appropriate RustMailer version based on your operating system:

• Linux: rustmailer-1.0.0-x86_64-unknown-linux-gnu.tar.gz
• macOS: rustmailer-1.0.0-x86_64-apple-darwin.tar.gz
• Windows: rustmailer-1.0.0-x86_64-pc-windows-msvc.zip

Extract the File

Linux/macOS

On Linux or macOS, after downloading, extract the file and navigate to the extracted directory:

tar -xvzf rustmailer-1.0.0-x86_64-unknown-linux-gnu.tar.gz
cd rustmailer

Windows

On Windows, download the .zip file, right-click to extract it, and navigate to the extracted directory.

Run RustMailer

Run the following command depending on your operating system:

Linux/macOS:

./rustmailer --rustmailer-root-dir /tmp/data

Windows:

rustmailer.exe --rustmailer-root-dir D:\rustmailer_data

This command starts a new RustMailer instance and specifies the working directory for the service.

• All metadata, logs, and persistent state will be stored in the specified directory.
• If the directory does not exist, it will be created automatically.

Access RustMailer

Once started, RustMailer exposes the following interfaces:

• 🌐 Web UI at http://localhost:15630
• 🔌 gRPC API on port 16630 (gRPC service is enabled by default)

tip

You can now open http://localhost:15630 in your browser to access the RustMailer web interface.
Each RustMailer instance also serves interactive OpenAPI documentation at http://localhost:15630/api-docs.