himalaya-repl

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #golang #go #deep-learning #linux #nodejs #java #awesome #cli #pytorch #mcp #openai

(★ 17)

REPL to manage emails

himalaya-repl 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <img src="./logo.svg" alt="Logo" width="128" height="128" />
  <h1>📫 Himalaya REPL</h1>
  <p><strong>REPL</strong> to manage emails, based on <a href="https://crates.io/crates/email-lib"><code>email-lib</code></a></p>
  <p>
    <a href="https://github.com/pimalaya/himalaya-repl/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/pimalaya/himalaya-repl?color=success"/></a>
	
    <a href="https://matrix.to/#/#pimalaya:matrix.org"><img alt="Matrix" src="https://img.shields.io/matrix/pimalaya:matrix.org?color=success&label=chat"/></a>
  </p>
  <p>
    <em>🚧 Himalaya REPL is still experimental 🚧<br>For a more stable alternative, see <a href="https://github.com/pimalaya/himalaya">Himalaya CLI</a></em>
  </p>
</div>

## Features

- Multi-accounting
- Interactive configuration via **wizard** (requires `wizard` feature)
- Mailbox, envelope, message and flag management
- Message composition based on `$EDITOR`
- **IMAP** backend (requires `imap` feature)
- **Maildir** backend (requires `maildir` feature)
- **Notmuch** backend (requires `notmuch` feature)
- **SMTP** backend (requires `smtp` feature)
- **Sendmail** backend (requires `sendmail` feature)
- Global system **keyring** for managing secrets (requires `keyring` feature)
- **OAuth 2.0** authorization (requires `oauth2` feature)
- **PGP** encryption:
  - via shell commands (requires `pgp-commands` feature)
  - via [GPG](https://www.gnupg.org/) bindings (requires `pgp-gpg` feature)
  - via native implementation (requires `pgp-native` feature)

*Himalaya REPL is written in [Rust](https://www.rust-lang.org/), and relies on [cargo features](https://doc.rust-lang.org/cargo/reference/features.html) to enable or disable functionalities. Default features can be found in the `features` section of the [`Cargo.toml`](https://github.com/pimalaya/himalaya-repl/blob/master/Cargo.toml#L18).*

## Installation

### Pre-built binary

Himalaya REPL can be installed with a pre-built binary. Find the latest [`pre-release`](https://github.com/pimalaya/himalaya-repl/actions/workflows/pre-release.yml) GitHub workflow and look for the *Artifacts* section. You should find a pre-built binary matching your OS.

### Cargo (git)

Himalaya REPL can also be installed with [cargo](https://doc.rust-lang.org/cargo/):

```bash
$ cargo install --locked --git https://github.com/pimalaya/himalaya-repl.git
```

## Configuration

Just run `himalaya-repl`, the wizard will help you to configure your default account.

You can also manually edit your own configuration, from scratch:

- Copy the content of the documented [`./config.sample.toml`](./config.sample.toml)
- Paste it in a new file `~/.config/himalaya/config.toml`
- Edit, then comment or uncomment the options you want

<details>
  <summary>Proton Mail (Bridge)</summary>

When using Proton Bridge, emails are synchronized locally and exposed via a local IMAP/SMTP server. This implies 2 things:

- Id order may be reversed or shuffled, but envelopes will still be sorted by date.
  - SSL/TLS needs to be deactivated manually.
  - The password to use is the one generated by Proton Bridge, not the one from your Proton Mail account.

```toml
  [accounts.proton]
  email = "example@proton.me"

backend = "imap"
  imap.host = "127.0.0.1"
  imap.port = 1143
  imap.encryption = false
  imap.login = "example@proton.me"
  imap.auth.type = "password"
  imap.auth.raw = "<bridge-imap-p@ssw0rd>"

message.send.backend = "smtp"
  smtp.host = "127.0.0.1"
  smtp.port = 1025
  smtp.encryption = false
  smtp.login = "example@proton.me"
  smtp.auth.type = "password"
  smtp.auth.raw = "<bridge-smtp-p@ssw0rd>"
  ```

Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives:

- Save your password in any password manager that can be queried via the CLI:

```toml
    imap.auth.type = "password"
    imap.auth.cmd = "pass show proton"
    ```

- Use the global keyring of your system (requires the `keyring` cargo feature):

```toml
    imap.auth.type = "password"
    imap.auth.keyring = "proton-example"
    ```

Running `himalaya configure -a proton` will ask for your IMAP password, just paste the one generated previously.
</details>

<details>
  <summary>Gmail</summary>

Google passwords cannot be used directly. There is two ways to authenticate yourself:

### Using [App Passwords](https://support.google.com/mail/answer/185833)

This option is the simplest and the fastest. First, be sure that:

- IMAP is enabled
  - Two-step authentication is enabled
  - Less secure app access is enabled

First create a [dedicated password](https://myaccount.google.com/apppasswords) for Himalaya.

```toml
  [accounts.gmail]
  email = "example@gmail.com"

folder.alias.inbox = "INBOX"
  folder.alias.sent = "[Gmail]/Sent Mail"
  folder.alias.drafts = "[Gmail]/Drafts"
  folder.alias.trash = "[Gmail]/Trash"

backend = "imap"
  imap.host = "imap.gmail.com"
  imap.port = 993
  imap.login = "example@gmail.com"
  imap.auth.type = "password"
  imap.auth.cmd = "pass show gmail"

message.send.backend = "smtp"
  smtp.host = "smtp.gmail.com"
  smtp.port = 465
  smtp.login = "example@gmail.com"
  smtp.auth.type = "password"
  smtp.auth.cmd = "pass show gmail"
  ```

Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives:

- Save your password in any password manager that can be queried via the CLI:

```toml
    imap.auth.type = "password"
    imap.auth.cmd = "pass show gmail"
    ```

- Use the global keyring of your system (requires the `keyring` cargo feature):

```toml
    imap.auth.type = "password"
    imap.auth.keyring = "gmail-example"
    ```

Running `himalaya configure -a gmail` will ask for your IMAP password, just paste the one generated previously.

### Using OAuth 2.0

This option is the most secure but the hardest to configure. It requires the `oauth2` and `keyring` cargo features.

First, you need to get your OAuth 2.0 credentials by following [this guide](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.). Once you get your client id and your client secret, you can configure your Himalaya account this way:

```toml
  [accounts.gmail]
  email = "example@gmail.com"

folder.alias.inbox = "INBOX"
  folder.alias.sent = "[Gmail]/Sent Mail"
  folder.alias.drafts = "[Gmail]/Drafts"
  folder.alias.trash = "[Gmail]/Trash"

backend = "imap"
  imap.host = "imap.gmail.com"
  imap.port = 993
  imap.login = "example@gmail.com"
  imap.auth.type = "oauth2"
  imap.auth.client-id = "<imap-client-id>"
  imap.auth.auth-url = "https://accounts.google.com/o/oauth2/v2/auth"
  imap.auth.token-url = "https://www.googleapis.com/oauth2/v3/token"
  imap.auth.pkce = true
  imap.auth.scope = "https://mail.google.com/"

message.send.backend = "smtp"
  smtp.host = "smtp.gmail.com"
  smtp.port = 465
  smtp.login = "example@gmail.com"
  smtp.auth.type = "oauth2"
  smtp.auth.client-id = "<smtp-client-id>"
  smtp.auth.auth-url = "https://accounts.google.com/o/oauth2/v2/auth"
  smtp.auth.token-url = "https://www.googleapis.com/oauth2/v3/token"
  smtp.auth.pkce = true
  smtp.auth.scope = "https://mail.google.com/"

# If you want your SMTP to share the same client id (and so the same access token)
  # as your IMAP config, you can add the following:
  #
  # imap.auth.type = "oauth2"
  # imap.auth.client-id = "<client-id>"
  # imap.auth.client-secret.keyring = "gmail-oauth2-client-secret"
  # imap.auth.access-token.keyring = "gmail-oauth2-access-token"
  # imap.auth.refresh-token.keyring = "gmail-oauth2-refresh-token"
  #
  # smtp.auth.type = "oauth2"
  # smtp.auth.client-id = "<client-id>"
  # smtp.auth.client-secret.keyring = "gmail-oauth2-client-secret"
  # smtp.auth.access-token.keyring = "gmail-oauth2-access-token"
  # smtp.auth.refresh-token.keyring = "gmail-oauth2-refresh-token"
  ```

Running `himalaya configure -a gmail` will complete your OAuth 2.0 setup and ask for your client secret.
</details>

<details>
  <summary>Outlook</summary>

```toml
  [accounts.outlook]
  email = "example@outlook.com"

backend = "imap"
  imap.host = "outlook.office365.com"
  imap.port = 993
  imap.login = "example@outlook.com"
  imap.auth.type = "password"
  imap.auth.cmd = "pass show outlook"

message.send.backend = "smtp"
  smtp.host = "smtp.mail.outlook.com"
  smtp.port = 587
  smtp.encryption = "start-tls"
  smtp.login = "example@outlook.com"
  smtp.auth.type = "password"
  smtp.auth.cmd = "pass show outlook"
  ```

### Using OAuth 2.0

This option is the most secure but the hardest to configure. First, you need to get your OAuth 2.0 credentials by following [this guide](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth). Once you get your client id and your client secret, you can configure your Himalaya account this way:

```toml
  [accounts.outlook]
  email = "example@outlook.com"

backend = "imap"
  imap.host = "outlook.office365.com"
  imap.port = 993
  imap.login = "example@outlook.com"
  imap.auth.type = "oauth2"
  imap.auth.client-id = "<imap-client-id>"
  imap.auth.auth-url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
  imap.auth.token-url = "https://login.microsoftonline.com/common/oauth2/v2.0/token"
  imap.auth.pkce = true
  imap.auth.scope = "https://outlook.office.com/IMAP.AccessAsUser.All"

message.send.backend = "smtp"
  smtp.host = "smtp.mail.outlook.com"
  smtp.port = 587
  smtp.starttls = true
  smtp.login = "example@outlook.com"
  smtp.auth.type = "oauth2"
  smtp.auth.client-id = "<smtp-client-id>"
  smtp.auth.auth-url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
  smtp.auth.token-url = "https://login.microsoftonline.com/common/oauth2/v2.0/token"
  smtp.auth.pkce = true
  smtp.auth.scope = "https://outlook.office.com/SMTP.Send"

# If you want your SMTP to share the same client id (and so the same access token)
  # as your IMAP config, you can add the following:
  #
  # imap.auth.type = "oauth2"
  # imap.auth.client-id = "<client-id>"
  # imap.auth.client-secret.keyring = "outlook-oauth2-client-secret"
  # imap.auth.access-token.keyring = "outlook-oauth2-access-token"
  # imap.auth.refresh-token.keyring = "outlook-oauth2-refresh-token"
  #
  # smtp.auth.type = "oauth2"
  # smtp.auth.client-id = "<client-id>"
  # smtp.auth.client-secret.keyring = "outlook-oauth2-client-secret"
  # smtp.auth.access-token.keyring = "outlook-oauth2-access-token"
  # smtp.auth.refresh-token.keyring = "outlook-oauth2-refresh-token"
  ```

Running `himalaya configure -a outlook` will complete your OAuth 2.0 setup and ask for your client secret.
</details>

<details>
  <summary>iCloud Mail</summary>

From the [iCloud Mail](https://support.apple.com/en-us/HT202304) support page:

- IMAP port = `993`.
  - IMAP login = name of your iCloud Mail email address (for example, `johnappleseed`, not `johnappleseed@icloud.com`)
  - SMTP port = `587` with `STARTTLS`
  - SMTP login = full iCloud Mail email address (for example, `johnappleseed@icloud.com`, not `johnappleseed`)

```toml
  [accounts.icloud]
  email = "johnappleseed@icloud.com"

backend = "imap"
  imap.host = "imap.mail.me.com"
  imap.port = 993
  imap.login = "johnappleseed"
  imap.auth.type = "password"
  imap.auth.cmd = "pass show icloud"

message.send.backend = "smtp"
  smtp.host = "smtp.mail.me.com"
  smtp.port = 587
  smtp.encryption = "start-tls"
  smtp.login = "johnappleseed@icloud.com"
  smtp.auth.type = "password"
  smtp.auth.cmd = "pass show icloud"
  ```
</details>

## FAQ

<details>
  <summary>How to compose a message?</summary>

An email message is a list of **headers** (`key: val`) followed by a **body**. They form together a template:

```eml
  Header: value
  Header: value
  Header: value

Body
  ```

***Headers and body must be separated by an empty line.***

### Headers

Here a non-exhaustive list of valid email message template headers:

- `Message-ID`: represents the message identifier (you usually do not need to set up it manually)
  - `In-Reply-To`: represents the identifier of the replied message
  - `Date`: represents the date of the message
  - `Subject`: represents the subject of the message
  - `From`: represents the address of the sender
  - `To`: represents the addresses of the receivers
  - `Reply-To`: represents the address the receiver should reply to instead of the `From` header
  - `Cc`: represents the addresses of the other receivers (carbon copy)
  - `Bcc`: represents the addresses of the other hidden receivers (blind carbon copy)
    
  An address can be:

- a single email address `user@domain`
  - a named address `Name <user@domain>`
  - a quoted named address `"Name" <user@domain>`

Multiple address are separated by a coma `,`: `user@domain, Name <user@domain>, "Name" <user@domain>`.

### Plain text body

Email message template body can be written in plain text. The result will be compiled into a single `text/plain` MIME part:

```eml
  From: alice@localhost
  To: Bob <bob@localhost>
  Subject: Hello from Himalaya

Hello, world!
  ```

### MML boby

Email message template body can also be written in MML. The MIME Meta Language was introduced by the Emacs [`mml`](https://www.gnu.org/software/emacs/manual/html_node/emacs-mime/Composing.html) ELisp module. Pimalaya [ported it](https://github.com/pimalaya/core/tree/master/mml) in Rust.

A raw email message is structured according to the [MIME](https://www.rfc-editor.org/rfc/rfc2045) standard. This standard produces verbose, non-friendly messages. Here comes MML: it simplifies the way email message body are structured. Thanks to its simple XML-based syntax, it allows you to easily add multiple parts, attach a binary file, or attach inline image to your body without dealing with the MIME standard.

For instance, this MML template:

```eml
  From: alice@localhost
  To: bob@localhost
  Subject: MML simple

<#multipart type=alternative>
  This is a plain text part.
  <#part type=text/enriched>
  <center>This is a centered enriched part</center>
  <#/multipart>
  ```

compiles into the following MIME Message:

```eml
  Subject: MML simple
  To: bob@localhost
  From: alice@localhost
  MIME-Version: 1.0
  Date: Tue, 29 Nov 2022 13:07:01 +0000
  Content-Type: multipart/alternative;
   boundary="4CV1Cnp7mXkDyvb55i77DcNSkKzB8HJzaIT84qZe"

--4CV1Cnp7mXkDyvb55i77DcNSkKzB8HJzaIT84qZe
  Content-Type: text/plain; charset=utf-8
  Content-Transfer-Encoding: 7bit

This is a plain text part.
  --4CV1Cnp7mXkDyvb55i77DcNSkKzB8HJzaIT84qZe
  Content-Type: text/enriched
  Content-Transfer-Encoding: 7bit

<center>This is a centered enriched part</center>
  --4CV1Cnp7mXkDyvb55i77DcNSkKzB8HJzaIT84qZe--
  ```

*See more examples at [pimalaya/core/mml](https://github.com/pimalaya/core/tree/master/mml/examples).*
</details>

<details>
  <summary>How to add attachments to a message?</summary>

*Read first about the FAQ: How to compose a message?*.

```eml
  From: alice@localhost
  To: bob@localhost
  Subject: How to attach stuff

Regular binary attachment:
  <#part filename=/path/to/file.pdf><#/part>

Custom file name:
  <#part filename=/path/to/file.pdf name=custom.pdf><#/part>

Inline image:
  <#part disposition=inline filename=/path/to/image.png><#/part>
  ```

*See more examples at [pimalaya/core/mml](https://github.com/pimalaya/core/tree/master/mml/examples).*
</details>

<details>
  <summary>How to debug Himalaya REPL?</summary>

The simplest way is to use `--debug` and `--trace` arguments.

The advanced way is based on environment variables:

- `RUST_LOG=<level>`: determines the log level filter, can be one of `off`, `error`, `warn`, `info`, `debug` and `trace`.
  - `RUST_SPANTRACE=1`: enables the spantrace (a span represent periods of time in which a program was executing in a particular context).
  - `RUST_BACKTRACE=1`: enables the error backtrace.
  - `RUST_BACKTRACE=full`: enables the full error backtrace, which include source lines where the error originated from.

</details>

<details>
  <summary>How the wizard discovers IMAP/SMTP configs?</summary>

All the lookup mechanisms use the email address domain as base for the lookup. It is heavily inspired from the Thunderbird [Autoconfiguration](https://udn.realityripple.com/docs/Mozilla/Thunderbird/Autoconfiguration) protocol. For example, for the email address `test@example.com`, the lookup is performed as (in this order):

1. check for `autoconfig.example.com`
  2. look up of `example.com` in the ISPDB (the Thunderbird central database)
  3. look up `MX example.com` in DNS, and for `mx1.mail.hoster.com`, look up `hoster.com` in the ISPDB
  4. look up `SRV example.com` in DNS
  5. try to guess (`imap.example.com`, `smtp.example.com`…)
</details>

## Sponsoring

[![nlnet](https://nlnet.nl/logo/banner-160x60.png)](https://nlnet.nl/)

Special thanks to the [NLnet foundation](https://nlnet.nl/) and the [European Commission](https://www.ngi.eu/) that helped the project to receive financial support from various programs:

- [NGI Assure](https://nlnet.nl/project/Himalaya/) in 2022
- [NGI Zero Entrust](https://nlnet.nl/project/Pimalaya/) in 2023
- [NGI Zero Core](https://nlnet.nl/project/Pimalaya-PIM/) in 2024 *(still ongoing)*

If you appreciate the project, feel free to donate using one of the following providers:

[![GitHub](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/soywod)
[![Ko-fi](https://img.shields.io/badge/-Ko--fi-ff5e5a?logo=Ko-fi&logoColor=ffffff)](https://ko-fi.com/soywod)
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?logo=Buy%20Me%20A%20Coffee&logoColor=000000)](https://www.buymeacoffee.com/soywod)
[![Liberapay](https://img.shields.io/badge/-Liberapay-f6c915?logo=Liberapay&logoColor=222222)](https://liberapay.com/soywod)
[![thanks.dev](https://img.shields.io/badge/-thanks.dev-000000?logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQuMDk3IiBoZWlnaHQ9IjE3LjU5NyIgY2xhc3M9InctMzYgbWwtMiBsZzpteC0wIHByaW50Om14LTAgcHJpbnQ6aW52ZXJ0IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxwYXRoIGQ9Ik05Ljc4MyAxNy41OTdINy4zOThjLTEuMTY4IDAtMi4wOTItLjI5Ny0yLjc3My0uODktLjY4LS41OTMtMS4wMi0xLjQ2Mi0xLjAyLTIuNjA2di0xLjM0NmMwLTEuMDE4LS4yMjctMS43NS0uNjc4LTIuMTk1LS40NTItLjQ0Ni0xLjIzMi0uNjY5LTIuMzQtLjY2OUgwVjcuNzA1aC41ODdjMS4xMDggMCAxLjg4OC0uMjIyIDIuMzQtLjY2OC40NTEtLjQ0Ni42NzctMS4xNzcuNjc3LTIuMTk1VjMuNDk2YzAtMS4xNDQuMzQtMi4wMTMgMS4wMjEtMi42MDZDNS4zMDUuMjk3IDYuMjMgMCA3LjM5OCAwaDIuMzg1djEuOTg3aC0uOTg1Yy0uMzYxIDAtLjY4OC4wMjctLjk4LjA4MmExLjcxOSAxLjcxOSAwIDAgMC0uNzM2LjMwN2MtLjIwNS4xNTYtLjM1OC4zODQtLjQ2LjY4Mi0uMTAzLjI5OC0uMTU0LjY4Mi0uMTU0IDEuMTUxVjUuMjNjMCAuODY3LS4yNDkgMS41ODYtLjc0NSAyLjE1NS0uNDk3LjU2OS0xLjE1OCAxLjAwNC0xLjk4MyAxLjMwNXYuMjE3Yy44MjUuMyAxLjQ4Ni43MzYgMS45ODMgMS4zMDUuNDk2LjU3Ljc0NSAxLjI4Ny43NDUgMi4xNTR2MS4wMjFjMCAuNDcuMDUxLjg1NC4xNTMgMS4xNTIuMTAzLjI5OC4yNTYuNTI1LjQ2MS42ODIuMTkzLjE1Ny40MzcuMjYuNzMyLjMxMi4yOTUuMDUuNjIzLjA3Ni45ODQuMDc2aC45ODVabTE0LjMxNC03LjcwNmgtLjU4OGMtMS4xMDggMC0xLjg4OC4yMjMtMi4zNC42NjktLjQ1LjQ0NS0uNjc3IDEuMTc3LS42NzcgMi4xOTVWMTQuMWMwIDEuMTQ0LS4zNCAyLjAxMy0xLjAyIDIuNjA2LS42OC41OTMtMS42MDUuODktMi43NzQuODloLTIuMzg0di0xLjk4OGguOTg0Yy4zNjIgMCAuNjg4LS4wMjcuOTgtLjA4LjI5Mi0uMDU1LjUzOC0uMTU3LjczNy0uMzA4LjIwNC0uMTU3LjM1OC0uMzg0LjQ2LS42ODIuMTAzLS4yOTguMTU0LS42ODIuMTU0LTEuMTUydi0xLjAyYzAtLjg2OC4yNDgtMS41ODYuNzQ1LTIuMTU1LjQ5Ny0uNTcgMS4xNTgtMS4wMDQgMS45ODMtMS4zMDV2LS4yMTdjLS44MjUtLjMwMS0xLjQ4Ni0uNzM2LTEuOTgzLTEuMzA1LS40OTctLjU3LS43NDUtMS4yODgtLjc0NS0yLjE1NXYtMS4wMmMwLS40Ny0uMDUxLS44NTQtLjE1NC0xLjE1Mi0uMTAyLS4yOTgtLjI1Ni0uNTI2LS40Ni0uNjgyYTEuNzE5IDEuNzE5IDAgMCAwLS43MzctLjMwNyA1LjM5NSA1LjM5NSAwIDAgMC0uOTgtLjA4MmgtLjk4NFYwaDIuMzg0YzEuMTY5IDAgMi4wOTMuMjk3IDIuNzc0Ljg5LjY4LjU5MyAxLjAyIDEuNDYyIDEuMDIgMi42MDZ2MS4zNDZjMCAxLjAxOC4yMjYgMS43NS42NzggMi4xOTUuNDUxLjQ0NiAxLjIzMS42NjggMi4zNC42NjhoLjU4N3oiIGZpbGw9IiNmZmYiLz48L3N2Zz4=)](https://thanks.dev/soywod)
[![PayPal](https://img.shields.io/badge/-PayPal-0079c1?logo=PayPal&logoColor=ffffff)](https://www.paypal.com/paypalme/soywod)

himalaya-repl

himalaya-repl 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

himalaya-repl

himalaya-repl 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README