Generated from mxr accounts --help. Edit the clap definitions in crates/daemon/src/cli/ and re-run npm run build in site/ to regenerate.
Manage accounts
mxr accounts [OPTIONS] [COMMAND]
Subcommand Purpose addAdd an account showShow account details testTest account connectivity repairRe-save account passwords into the protected keychain store disableDisable an account without deleting local cached mail removeRemove an account from config; cached mail is kept unless purged addressesManage owned addresses (aliases) for an account. Direction inference uses these to classify inbound vs outbound mail helpPrint this message or the help of the given subcommand(s)
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Add, test, repair, disable, or inspect accounts and aliases.
mxr accounts addresses add --account work alias@example.com
Add an account.
Without flags, runs an interactive wizard. Pass any subset of the optional flags below to drive the flow non-interactively (scripts / CI). Passwords may also be sourced from MXR_IMAP_PASSWORD, MXR_SMTP_PASSWORD, or MXR_GMAIL_CLIENT_SECRET when stdin is not a TTY.
mxr accounts add [OPTIONS] <PROVIDER>
Flag Description <PROVIDER>Provider type: gmail, imap, imap-smtp, smtp, outlook, or outlook-work
Flag Description --account-name <ACCOUNT_NAME>Account key (the short identifier used by other commands) --email <EMAIL>Email address for the account --display-name <DISPLAY_NAME>Display name shown in From: headers; defaults to account name --gmail-bundled <GMAIL_BUNDLED>Use the bundled OAuth client (true) or supply your own (false) [possible values: true, false] --gmail-client-id <GMAIL_CLIENT_ID>Custom Gmail OAuth client ID (only when --gmail-bundled=false) --gmail-client-secret <GMAIL_CLIENT_SECRET>Custom Gmail OAuth client secret --imap-host <IMAP_HOST>— --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] --imap-port <IMAP_PORT>[default: 993] --imap-no-authIMAP requires authentication. Default true --imap-username <IMAP_USERNAME>— --imap-password <IMAP_PASSWORD>IMAP password (or set MXR_IMAP_PASSWORD) --smtp-host <SMTP_HOST>— --smtp-port <SMTP_PORT>[default: 587] --smtp-no-auth— --smtp-username <SMTP_USERNAME>— --smtp-password <SMTP_PASSWORD>SMTP password (or set MXR_SMTP_PASSWORD) -h, --helpPrint help (see a summary with ‘-h’)
Manage owned addresses (aliases) for an account. Direction inference uses these to classify inbound vs outbound mail
mxr accounts addresses [OPTIONS] <COMMAND>
Subcommand Purpose listList addresses owned by an account addAdd an address as an alias on an account removeRemove an alias from an account set-primaryPromote an existing alias to primary (demoting the previous primary) helpPrint this message or the help of the given subcommand(s)
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Add an address as an alias on an account
mxr accounts addresses add [OPTIONS] <EMAIL>
Flag Description --account <ACCOUNT>Account name or id. Defaults to the configured default account --primaryMark as primary; demotes the previous primary atomically --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
List addresses owned by an account
mxr accounts addresses list [OPTIONS]
Flag Description --account <ACCOUNT>Account name or id. Defaults to the configured default account --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Remove an alias from an account
mxr accounts addresses remove [OPTIONS] <EMAIL>
Flag Description --account <ACCOUNT>— --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Promote an existing alias to primary (demoting the previous primary)
mxr accounts addresses set-primary [OPTIONS] <EMAIL>
Flag Description --account <ACCOUNT>— --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Disable an account without deleting local cached mail
mxr accounts disable [OPTIONS] <NAME>
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Remove an account from config; cached mail is kept unless purged
mxr accounts remove [OPTIONS] <NAME>
Flag Description --dry-run— --yes— --purge-local-data— --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Re-save account passwords into the protected keychain store
mxr accounts repair [OPTIONS] <NAME>
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Show account details
mxr accounts show [OPTIONS] <NAME>
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help
Test account connectivity
mxr accounts test [OPTIONS] <NAME>
Flag Description --format <FORMAT>Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids] -h, --helpPrint help