protonmail-client 0.1.0

IMAP client library for Proton Mail via Proton Bridge
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# protonmail-client

A Rust interface to fetch emails from Proton Mail using
[Proton Bridge](https://proton.me/mail/bridge). This is a read-only IMAP client
that connects over STARTTLS with self-signed certificate support.

The library returns parsed `Email` structs from
[email-parser](https://github.com/LeakIX/email-parser) - it does not implement
its own email types.

- [API Documentation](https://leakix.github.io/protonmail-client)
- [CLI usage](#cli)

## Environment variables

| Variable | Default | Required |
|---|---|---|
| `IMAP_HOST` | `127.0.0.1` | No |
| `IMAP_PORT` | `1143` | No |
| `IMAP_USERNAME` | - | Yes |
| `IMAP_PASSWORD` | - | Yes |

## CLI

The crate includes a `proton-cli` binary for command-line access.

```sh
# List recent emails
cargo run --release --bin proton-cli -- list --limit 10

# List unseen emails
cargo run --release --bin proton-cli -- list --unseen

# Show a single email
cargo run --release --bin proton-cli -- show 42

# List folders
cargo run --release --bin proton-cli -- folders

# IMAP search
cargo run --release --bin proton-cli -- search "FROM alice@example.com"

# JSON output (for scripting)
cargo run --release --bin proton-cli -- list --json --limit 5
```

## MSRV

The minimum supported Rust version is **1.90.0** (edition 2024).

## License

MIT