Fob
Browse the docs

Setup and accounts

Generated from --help output of fob-email 0.2.0. Every command also accepts --help and --version.

config accounts is an alias of config profiles; the two are interchangeable.

getting-started#

fob-email getting-started

Print setup instructions (skips if an account exists)

config profiles#

config profiles list#

fob-email config profiles list

List accounts (current marked with *)

Options:
      --json  Output raw JSON                                          [boolean]

config profiles add#

fob-email config profiles add <name>

Add or update an account's IMAP/SMTP credentials

Positionals:
  name  Account name                                         [string] [required]

Options:
      --imap-host    IMAP host                               [string] [required]
      --imap-port    IMAP port                           [number] [default: 993]
      --imap-user    IMAP username                           [string] [required]
      --imap-pass    IMAP password (app password)            [string] [required]
      --imap-tls     Use TLS for IMAP                  [boolean] [default: true]
      --smtp-host    SMTP host (enables sending)                        [string]
      --smtp-port    SMTP port                           [number] [default: 465]
      --smtp-user    SMTP username (defaults to --imap-user)            [string]
      --smtp-pass    SMTP password (defaults to --imap-pass)            [string]
      --smtp-secure  Use TLS for SMTP                  [boolean] [default: true]
      --verify       Connect to verify creds and cache the account profile (--no
                     -verify to skip)                  [boolean] [default: true]

config profiles use#

fob-email config profiles use <name>

Set the current account

Positionals:
  name  Account name                                         [string] [required]

config profiles remove#

fob-email config profiles remove <name>

Remove an account

Positionals:
  name  Account name                                         [string] [required]

config profiles refresh#

fob-email config profiles refresh [name]

Re-probe an account's profile — address, provider, thread strategy, folders (--a
ll for every account)

Positionals:
  name  Account name (omit with --all)                                  [string]

Options:
      --all  Refresh every account                                     [boolean]