Fob
Browse the docs

Folders and sync

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

folders#

folders list#

fob-email folders list

List folders

Options:
      --account  Configured account name                                [string]
      --json     Output raw JSON                                       [boolean]

folders create#

fob-email folders create <name>

Create a folder (e.g. Invoices/2026)

Positionals:
  name  Folder path                                          [string] [required]

Options:
      --account  Configured account name                                [string]
      --json     Output raw JSON                                       [boolean]

folders rename#

fob-email folders rename <name>

Rename or move a folder

Positionals:
  name  Existing folder path                                 [string] [required]

Options:
      --to       New folder path                             [string] [required]
      --account  Configured account name                                [string]
      --json     Output raw JSON                                       [boolean]

folders delete#

fob-email folders delete <name>

Delete a folder

Positionals:
  name  Folder path                                          [string] [required]

Options:
  -y, --yes      Confirm deletion                                      [boolean]
      --account  Configured account name                                [string]
      --json     Output raw JSON                                       [boolean]

sync#

sync run#

fob-email sync run

Pull folders into the local mirror

Options:
      --folder        Folder to sync                 [string] [default: "INBOX"]
      --all-folders   Sync every selectable folder                     [boolean]
      --all-accounts  Sync every configured account                    [boolean]
      --full          Ignore stored cursors and resync from scratch    [boolean]
      --limit         On a first/full sync, mirror only the newest N messages
                                                                        [number]
      --account       Configured account name                           [string]
      --json          Output raw JSON                                  [boolean]

sync status#

fob-email sync status

Show what is mirrored locally and how stale it is

Options:
      --folder        Limit to one folder                               [string]
      --all-accounts  Show every configured account                    [boolean]
      --account       Configured account name                           [string]
      --json          Output raw JSON                                  [boolean]

sync clear#

fob-email sync clear

Delete mirrored data (it can always be re-synced)

Options:
      --folder   Limit to one folder                                    [string]
  -y, --yes      Skip the confirmation                                 [boolean]
      --account  Configured account name                                [string]
      --json     Output raw JSON                                       [boolean]