beenull/himalaya
1
0
Fork 0
mirror of https://github.com/soywod/himalaya.git synced 2024-11-22 11:00:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
CLI to manage emails
71 commits 6 branches 41 tags 7.6 MiB
Rust 92.1%
Nix 6.9%
Shell 1%
Find a file
Clément DOUIN c3e690d2b6
update vim doc
2021-04-03 12:30:18 +02:00
.github add buymeacoffee funding provider 2021-03-11 22:54:10 +01:00
src introduce signature feature 2021-04-03 11:50:07 +02:00
vim update vim doc 2021-04-03 12:30:18 +02:00
.gitignore import vim plugin 2021-04-03 12:12:26 +02:00
Cargo.lock improve errors management 2021-03-12 23:01:01 +01:00
Cargo.toml improve errors management 2021-03-12 23:01:01 +01:00
CHANGELOG.md update doc/changelog about signature 2021-04-03 12:02:36 +02:00
install.sh improve readme 2021-01-17 17:07:23 +01:00
LICENSE improve readme 2021-01-17 17:07:23 +01:00
README.md update vim doc 2021-04-03 12:30:18 +02:00

README.md

📫 Himalaya gh-actions

Minimalist CLI email client, written in Rust.

The project is under active development. Do not use in production before the v1.0.0 (see the roadmap).

image

Table of contents

Motivation

Bringing emails to the terminal is a pain. The mainstream TUI, (neo)mutt, takes time to configure. The default mapping is not intuitive when coming from the Vim environment. It is even scary to use at the beginning, since you are dealing with sensitive data!

The aim of Himalaya is to extract the email logic into a simple (yet solid) CLI API that can be used either directly from the terminal or UIs. It gives users more flexibility.

Installation

curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | bash

See the wiki section for other installation methods.

Configuration

# ~/.config/himalaya/config.toml

name = "Your full name"
downloads-dir = "/abs/path/to/downloads"
signature = "Regards,"

[gmail]
default = true
email = "your.email@gmail.com"

imap-host = "imap.gmail.com"
imap-port = 993
imap-login = "your.email@gmail.com"
imap-passwd-cmd = "pass show gmail"

smtp-host = "smtp.gmail.com"
smtp-port = 487
smtp-login = "your.email@gmail.com"
smtp-passwd-cmd = "security find-internet-password -gs gmail -w"

See the wiki section for all the options.

Usage

himalaya 0.2.0
soywod <clement.douin@posteo.net>
📫 Minimalist CLI email client

USAGE:
    himalaya [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --account <STRING>     Selects a specific account
    -m, --mailbox <MAILBOX>    Selects a specific mailbox [default: INBOX]
    -o, --output <STRING>      Defines the output format [default: plain]  [possible values: plain, json]

SUBCOMMANDS:
    attachments    Downloads all message attachments
    copy           Copy a message to the targetted mailbox
    delete         Delete a message
    flags          Handles flags
    forward        Forwards a message
    help           Prints this message or the help of the given subcommand(s)
    idle           Spawns a blocking idle daemon
    list           Lists all messages
    mailboxes      Lists all mailboxes
    move           Move a message to the targetted mailbox
    read           Reads text bodies of a message
    reply          Answers to a message
    save           Saves a raw message
    search         Lists messages matching the given IMAP query
    send           Sends a raw message
    template       Generates a message template
    write          Writes a new message

See the wiki section for more information about commands.

List mailboxes

image

Shows mailboxes in a basic table.

List messages

image

Shows messages in a basic table.

Search messages

image

Shows filtered messages in a basic table. The query should follow the RFC-3501.

Download attachments

image

Downloads all attachments from a message directly to the downloads-dir.

Read a message

image

Shows the text content of a message (text/plain if exists, otherwise text/html).

Write a new message

himalaya write

Opens your default editor (from the $EDITOR environment variable) to compose a new message.

Reply to a message

himalaya reply --all 5123

Opens your default editor to reply to a message.

Forward a message

himalaya forward 5123

Opens your default editor to forward a message.

Copy a message

himalaya copy 5123 Sent

Copies a message to the targetted mailbox.

Move a message

himalaya move 5123 Drafts

Moves a message to the targetted mailbox.

Delete a message

himalaya delete 5123

Moves a message.

Listen to new messages

himalaya idle

Starts a session in idle mode (blocking). When a new message arrives, it runs the command notify-cmd defined in the config file.

Here a use case with systemd:

# ~/.config/systemd/user/himalaya.service

[Unit]
Description=Himalaya new messages notifier

[Service]
ExecStart=/usr/local/bin/himalaya idle
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

systemctl --user enable himalaya.service
systemctl --user start  himalaya.service

Interfaces

GUI

Not yet, but feel free to contribute ;)

TUI

Credits