NAME

himalaya - CLI to manage emails

SYNOPSIS

himalaya [-c|--config] [-a|--account] [-b|--backend] [--json] [--log-level] [--log-file] [-h|--help] [-V|--version] [subcommands]

DESCRIPTION

CLI to manage emails.

First time here? Run `himalaya` with no command: it offers to generate an account discovered from your email address, which `himalaya configure` does again later. Everything discovery does not cover is written by hand.

OPTIONS

-c, --config <PATH>

Override the default configuration file path.

The given paths are shell-expanded then canonicalized (if applicable). Other paths are merged with the first one, which allows you to separate your public config from your private one(s). Multiple paths can also be given at once, delimited by `:` like `$PATH` in a POSIX shell.

-a, --account <NAME>

Override the default account.

An account name corresponds to an entry in the table at the root level of your TOML configuration file.

-b, --backend <BACKEND> [default: auto]

Force a specific backend for cross-protocol commands.

Only consumed by the shared commands (`mailboxes`, `envelopes`, `flags`, `messages`); the protocol-specific subcommands ignore it and always use their own backend. With `auto` (the default) the shared command picks the first configured backend it supports; with an explicit value it uses only that backend, and bails if the account has no matching config block or the operation has no implementation for it (e.g. `--backend smtp mailboxes list`).

Possible values:

--json

Enable JSON output.

When set, command output (data or errors) is displayed as JSON string.

--log-level <LEVEL>

Filter log output by level.

When omitted, the `RUST_LOG` environment variable is consulted (it supports per-target filters — see the `env_logger` documentation). When present, this flag overrides `RUST_LOG` entirely.

Possible values:

--log-file <PATH>

Append log output to the given file instead of stderr.

Useful when interactive prompts (which always write to stderr) would otherwise be intermixed with log lines. The file is opened in append mode and created if it does not exist.

-h, --help

Print help (see a summary with '-h')

-V, --version

Print version

SUBCOMMANDS

himalaya-mailbox(1)

Manage mailboxes using the shared API

himalaya-envelope(1)

Manage envelopes using the shared API

himalaya-flag(1)

Manage flags using the shared API

himalaya-message(1)

Manage messages using the shared API

himalaya-attachment(1)

Manage attachments using the shared API

himalaya-imap(1)

IMAP-specific API

himalaya-jmap(1)

JMAP-specific API

himalaya-gmail(1)

Gmail-specific API

himalaya-msgraph(1)

Microsoft Graph CLI

himalaya-maildir(1)

Maildir-specific API

himalaya-m2dir(1)

M2dir-specific API

himalaya-smtp(1)

SMTP-specific API

himalaya-configure(1)

Configure an account interactively

himalaya-account(1)

Manage accounts defined in the TOML configuration file

himalaya-completion(1)

Generate completion script for the give shell(s) to the given directory

himalaya-manual(1)

Generate manual pages to the given directory

himalaya-json-schema(1)

Generate JSON Schemas of every command's JSON output to the given directory

himalaya-help(1)

Print this message or the help of the given subcommand(s)

EXTRA

Report bugs to:
https://github.com/pimalaya/himalaya/issues/

Sponsoring:
https://pimalaya.org/sponsor/

This program is part of Pimalaya, free software funded entirely by grants and donations. If you find it useful, consider sponsoring its development.

VERSION

vv2.1.0 +imap +m2dir +rustls-ring +pimdir +msgraph +jmap +gmail +maildir +smtp build: linux gnu x86_64 git: unknown, rev unknown

AUTHORS

Clément DOUIN (soywod) <pimalaya.org@posteo.net>