Skip to content

Your first account

One command sets up an account, the encrypted store, and the daemon. Enter accepts the [default] shown for each prompt.

Run the wizard

antiphon setup

On a fresh machine you need not remember the subcommand: running antiphon with no configuration yet drops straight into this same wizard.

It asks, in order:

  1. e-mail address: your address.
  2. account name [personal]: a short label.
  3. from name (optional): your display name, or blank.
  4. imap host [imap.<domain>]: where mail is read.
  5. imap user [<your address>]: the IMAP login.
  6. smtp host [smtp.<domain>]: where mail is sent.
  7. mail password. On macOS it is stored in the Keychain (typed hidden, never in a file). Elsewhere, give a command that prints it, e.g. pass show mail/personal.
  8. vault passphrase. Encrypts the local store. On macOS you choose one and it is kept in the Keychain as antiphon-vault. Elsewhere, give a command that prints it, e.g. pass show antiphon/vault.

The wizard writes the config, creates and mounts the vault, initialises the store, and starts the daemon on its first sync. It refuses to run if a config already exists.

Gmail, Outlook and friends

Big providers often want an app password. If your normal password is refused, create an app password in your provider's security settings and give the wizard that. Full OAuth (Microsoft 365, Google Workspace) is set up later: in the client, type :settings, pick the provider in the account form, then press O to sign in. The accounts page walks it.

Check the setup

antiphon doctor

Every line should read ok (config, accounts, store, vault, daemon, notmuch, PGP if you use it). A FAIL line names the problem and the fix.

Open it

antiphon

The first sync of a large mailbox takes a few minutes. Folders appear in the sidebar and the list fills as mail arrives; you can read what has landed meanwhile.

Press ? any time for the full key list, generated from your own config. Any other key closes it.

Next: use the interface.