Docs / Obsidian Mail Server / Reference

Command-line reference

The oms command on the server does everything the admin center does, and is handy for scripts, bulk changes and recovery. Sign in to the server (console or SSH) and run it with sudo. sudo oms help lists every command. Changes made with it appear in Change history as cli:<linux user>.

Wherever a password is needed and not given with --password, oms asks for it without showing it, or reads it from standard input in scripts.

Organizations and domains

sudo oms org new <name> [--display "Display Name"]
sudo oms org list
sudo oms domain add <org> <domain> [--type Authoritative|InternalRelay|ExternalRelay] [--default]
sudo oms domain list [org]

Authoritative is all addresses on this server, InternalRelay shared with another mail server, ExternalRelay relay only (see Domains).

Users, mailboxes and groups

sudo oms mailbox new <org> <address> [--name "Display Name"] [--first F] [--last L] [--password X] [--hidden]
sudo oms shared new <org> <address> [--name "Display Name"]
sudo oms room new <org> <address> [--name "Display Name"]
sudo oms equipment new <org> <address> [--name "Display Name"]
sudo oms group new <org> <address> [--name "Display Name"]
sudo oms contact new <org> <outside-address> [--name "Display Name"]
sudo oms recipient list <org>
sudo oms recipient show <address>
sudo oms recipient disable <address>
sudo oms recipient enable <address>
sudo oms recipient remove <address> --confirm
sudo oms password set <address> [--password X]
sudo oms address add <recipient> <address> [--primary]
sudo oms address remove <recipient> <address>
sudo oms address primary <recipient> <address>
sudo oms group add <group> <member>
sudo oms group remove <group> <member>
sudo oms quota set <address> [--warn 9GB] [--send 10GB] [--receive 11GB]
sudo oms folder list <address> [--items] [--all]
sudo oms archive enable <address>
sudo oms archive policy <address> 730
sudo oms archive policy <address> never
sudo oms archive disable <address>

quota set with unlimited clears a limit. recipient remove deletes all mail of the recipient and needs --confirm.

Example: many users at once

A file people.csv with lines first,last,address,password:

while IFS=, read -r first last address password; do
  printf '%s\n' "$password" | sudo oms mailbox new <org> "$address" --first "$first" --last "$last" --name "$first $last"
done < people.csv

Public folders

sudo oms publicfolder list <org>
sudo oms publicfolder new <org> <name> [--parent <folder-id>]
sudo oms publicfolder permission <org> <folder-id> <address>|Default <role>
sudo oms publicfolder address <org> <folder-id> <address>

Roles: Owner, PublishingEditor, Editor, Author, Reviewer, Contributor, None. publicfolder list shows the folder ids. See Public folders.

Access and administrators

sudo oms permission add <mailbox> <user-or-group> FullAccess|SendAs|SendOnBehalf
sudo oms permission remove <mailbox> <user-or-group> FullAccess|SendAs|SendOnBehalf
sudo oms permission list <mailbox>
sudo oms role add <address> GlobalAdmin|OrgAdmin|HelpdeskAdmin|ViewOnlyAdmin
sudo oms role remove <address> <role>
sudo oms role list [org]
sudo oms mapihttp enable|disable|status <address>
sudo oms ntlm enable|disable|status|purge
sudo oms directory status|preview|sync <org> [--force]

mapihttp offers Outlook for Windows its Exchange connection for one person; ntlm turns Windows sign-in on for Outlook (see NTLM sign-in for Outlook).

Mail flow

sudo oms connector new <name> [--spaces "*"] [--smarthost host:port,...] [--port 25] [--require-tls] [--user u --password p]
sudo oms connector list
sudo oms connector remove <name>
sudo oms queue
sudo oms track [--msgid "<id>"] [--rcpt address] [--limit 50]

Connectors are the outgoing routes of the admin center: --spaces is Use for, --smarthost Relay servers, --require-tls Only send encrypted.

Phones

sudo oms device list <address>
sudo oms device block <address> <device-id>
sudo oms device allow <address> <device-id>
sudo oms device wipe <address> <device-id> --confirm
sudo oms device cancel-wipe <address> <device-id>
sudo oms device remove <address> <device-id>
sudo oms mobilepolicy show <org>
sudo oms mobilepolicy set <org> Name=Value ...

device wipe erases the whole phone at its next connection (see Phones and tablets).

The server itself