Use the CLI

The Fluxmail CLI configures and runs the service. Email operations such as reading, drafting, and sending are available through MCP and REST.

Complete the Quickstart before using the workflows below.

Check the instance

fluxmail status
fluxmail accounts list
fluxmail members list

fluxmail status reports provider availability, connected mailboxes, and mailboxes that need to be reauthorized.

Run the HTTP server

fluxmail serve

The server listens on port 8977 by default. It provides MCP at /mcp and REST at /api/v1.

For a local MCP client that uses stdio, the client launches this command instead:

fluxmail stdio

See Connect an MCP client for client configuration and transport options.

Manage mailboxes and members

Connect another mailbox or list the existing mailboxes:

fluxmail accounts add gmail
fluxmail accounts list

Administrators can invite members and share mailboxes with them:

fluxmail members add --name "Another person" --email person@example.com
fluxmail accounts access <account-id> --share-with person@example.com

See Teams and plans for mailbox sharing and plan limits.

Manage API keys

Create a key for an HTTP MCP or REST client:

fluxmail apikey create --name local-client

Fluxmail shows the key once. You can list, change, or revoke keys without exposing their stored secrets:

fluxmail apikey list
fluxmail apikey permissions <key-id> --profile read-only
fluxmail apikey revoke <key-id>

See Permissions for profiles, custom capabilities, and mailbox restrictions.

Use the CLI with Docker

Prefix commands with docker compose exec fluxmail:

docker compose exec fluxmail fluxmail status
docker compose exec fluxmail fluxmail accounts list

See Deploy with Docker for remote server setup.

Command reference

Run fluxmail --help or add --help to a command for terminal help:

fluxmail accounts add --help

The CLI reference lists every command and option.