Commands, arguments, and options for synq mail.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
synq mail
Self-hosted mail server (iRedMail) setup and admin [self-host]
synq mail [options] [command]| Subcommand | Purpose |
|---|---|
steps | List the mail setup steps |
status [serverId] | Show the setup progress for a mail server |
servers | List every server the mail stack is installed on |
scan <serverId> | Probe a server for an existing mail install (read-only) |
adopt <serverId> | Re-adopt an existing mail install whose orchestrator state was lost |
setup [options] <serverId> | Start or resume the mail setup wizard (streams over SSE) |
cancel | Cancel the mail setup currently running |
dns-ack <serverId> | Acknowledge that DNS records are published (releases the DKIM gate) |
ptr-ack <serverId> | Acknowledge that reverse DNS (PTR) is configured |
reset [options] <serverId> | Wipe the on-server setup state file (does NOT touch installed daemons) |
forget <serverId> | Stop managing a mail server (drops the DB row; leaves the stack + state intact) |
health <serverId> | Show live status of every mail daemon, and whether mail is leaving the box |
logs [options] <serverId> <component> | Tail a mail component's journal (snapshot) |
postmaster | Manage the postmaster mailbox |
build [options] | Build the synq-mail engine image locally from a source checkout [dev] |
synq mail adopt
Re-adopt an existing mail install whose orchestrator state was lost
synq mail adopt [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Server ID to adopt |
synq mail build
Build the synq-mail engine image locally from a source checkout [dev]
synq mail build [options]| Option | Meaning |
|---|---|
--context <dir> | Repo root containing apps/email/Dockerfile (default: checkout or cwd) |
--tag <ref> | Image ref to tag (default: the pinned synq-mail ref) |
synq mail cancel
Cancel the mail setup currently running
synq mail cancel [options]synq mail dns-ack
Acknowledge that DNS records are published (releases the DKIM gate)
synq mail dns-ack [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
synq mail forget
Stop managing a mail server (drops the DB row; leaves the stack + state intact)
synq mail forget [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
synq mail health
Show live status of every mail daemon, and whether mail is leaving the box
synq mail health [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
synq mail logs
Tail a mail component's journal (snapshot)
synq mail logs [options] <serverId> <component>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
component | Component key (postfix|dovecot|amavis|clamav|iredapd|postgresql|…) |
| Option | Meaning |
|---|---|
-n, --lines <n> | Number of lines (max 1000) (default: "200") |
synq mail postmaster
Manage the postmaster mailbox
synq mail postmaster [options] [command]| Subcommand | Purpose |
|---|---|
set-password [options] <serverId> | Rotate the postmaster password |
synq mail postmaster set-password
Rotate the postmaster password
synq mail postmaster set-password [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
| Option | Meaning |
|---|---|
--password <password> | New password (min 12 chars); prompted if omitted |
synq mail ptr-ack
Acknowledge that reverse DNS (PTR) is configured
synq mail ptr-ack [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
synq mail reset
Wipe the on-server setup state file (does NOT touch installed daemons)
synq mail reset [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Mail server ID |
| Option | Meaning |
|---|---|
-y, --yes | Skip the confirmation prompt |
synq mail scan
Probe a server for an existing mail install (read-only)
synq mail scan [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Server ID to scan |
synq mail servers
List every server the mail stack is installed on
synq mail servers [options]synq mail setup
Start or resume the mail setup wizard (streams over SSE)
synq mail setup [options] <serverId>| Argument | Meaning |
|---|---|
serverId | Server ID to install the mail stack on |
| Option | Meaning |
|---|---|
-d, --domain <domain> | Mail domain (e.g. example.com) |
--start-step <n> | Resume from a specific step (1-13) |
--config <json> | iRedMail config overrides as a JSON object |
synq mail status
Show the setup progress for a mail server
synq mail status [options] [serverId]| Argument | Meaning |
|---|---|
serverId | Mail server ID (omit for the empty welcome shell) |
synq mail steps
List the mail setup steps
synq mail steps [options]