Skip to content
mxr

mxr accounts

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]

Subcommands

Section titled “Subcommands”
Subcommand Purpose
add Add an account
show Show account details
test Test account connectivity
reauth Re-authorize an OAuth account and keep cached mail
repair Re-save account passwords into the protected keychain store
disable Disable an account without deleting local cached mail
remove Remove an account from config; cached mail is kept unless purged
addresses Manage owned addresses (aliases) for an account. Direction inference uses these to classify inbound vs outbound mail
help Print this message or the help of the given subcommand(s)

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Use When

Section titled “Use When”

Add, test, repair, disable, or inspect accounts and aliases.

Everyday Examples

Section titled “Everyday Examples”
Terminal window
mxr accounts add gmail
mxr accounts addresses add --account work alias@example.com

Sub-subcommands

Section titled “Sub-subcommands”

mxr accounts add

Section titled “mxr accounts add”

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>

Arguments

Section titled “Arguments”
Flag Description
<PROVIDER> Provider type: gmail, imap, imap-smtp, smtp, outlook, or outlook-work

Options

Section titled “Options”
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> —
--imap-port <IMAP_PORT> [default: 993]
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
--imap-no-auth IMAP 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, --help Print help (see a summary with ‘-h’)

mxr accounts addresses

Section titled “mxr accounts addresses”

Manage owned addresses (aliases) for an account. Direction inference uses these to classify inbound vs outbound mail

mxr accounts addresses [OPTIONS] <COMMAND>

Subcommands

Section titled “Subcommands”
Subcommand Purpose
list List addresses owned by an account
add Add an address as an alias on an account
remove Remove an alias from an account
set-primary Promote an existing alias to primary (demoting the previous primary)
help Print this message or the help of the given subcommand(s)

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts addresses add

Section titled “mxr accounts addresses add”

Add an address as an alias on an account

mxr accounts addresses add [OPTIONS] <EMAIL>

Arguments

Section titled “Arguments”
Flag Description
<EMAIL> —

Options

Section titled “Options”
Flag Description
--account <ACCOUNT> Account name or id. Defaults to the configured default account
--primary Mark 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, --help Print help

mxr accounts addresses list

Section titled “mxr accounts addresses list”

List addresses owned by an account

mxr accounts addresses list [OPTIONS]

Options

Section titled “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, --help Print help

mxr accounts addresses remove

Section titled “mxr accounts addresses remove”

Remove an alias from an account

mxr accounts addresses remove [OPTIONS] <EMAIL>

Arguments

Section titled “Arguments”
Flag Description
<EMAIL> —

Options

Section titled “Options”
Flag Description
--account <ACCOUNT> —
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts addresses set-primary

Section titled “mxr accounts addresses set-primary”

Promote an existing alias to primary (demoting the previous primary)

mxr accounts addresses set-primary [OPTIONS] <EMAIL>

Arguments

Section titled “Arguments”
Flag Description
<EMAIL> —

Options

Section titled “Options”
Flag Description
--account <ACCOUNT> —
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts disable

Section titled “mxr accounts disable”

Disable an account without deleting local cached mail

mxr accounts disable [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts reauth

Section titled “mxr accounts reauth”

Re-authorize an OAuth account and keep cached mail

mxr accounts reauth [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts remove

Section titled “mxr accounts remove”

Remove an account from config; cached mail is kept unless purged

mxr accounts remove [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
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, --help Print help

mxr accounts repair

Section titled “mxr accounts repair”

Re-save account passwords into the protected keychain store

mxr accounts repair [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts show

Section titled “mxr accounts show”

Show account details

mxr accounts show [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

mxr accounts test

Section titled “mxr accounts test”

Test account connectivity

mxr accounts test [OPTIONS] <NAME>

Arguments

Section titled “Arguments”
Flag Description
<NAME> —

Options

Section titled “Options”
Flag Description
--format <FORMAT> Output format for accounts (the no-subcommand listing) [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

See also

Section titled “See also”

MIT ORApache-2.0, at your option.