Metadata-Version: 2.1
Name: raven-mail
Version: 0.1.0
Summary: A minimal terminal email client (read + send over IMAP/SMTP)
Author: Dave
License: MIT License
        
        Copyright (c) 2026 Dave
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/r00ster148/raven-mail
Keywords: email,imap,smtp,terminal,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Terminals
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# RAVEN

A minimal terminal email client — read and send, arrow-key navigation, no
Enter-mashing. Zero runtime dependencies: `imaplib`, `smtplib`, `ssl`,
`email`, and `msvcrt` are all Python standard library.

```
 RAVEN — you@gmail.com

  >  Alice                    Re: build broken again
     GitHub                   [repo] New issue opened
     Bob                      lol did you see this

 [↑↓] navigate   [Enter] open   [c] compose   [r] refresh   [q] quit
```

## Install

From this folder:
```
pip install -e .
```
(`-e` = editable install; edit `src/raven/cli.py` and changes take effect
immediately, no reinstall needed. Drop `-e` for a normal install.)

This registers a `raven` command on your PATH — no more `python raven.py`.

## Configure

Copy `raven.ini.example` to `raven.ini` and fill in your details. Put it
in **either**:
- the folder you run `raven` from, or
- `~/.raven/raven.ini` (or `%APPDATA%\raven\raven.ini` on Windows) —
  works from anywhere, recommended once you're happy with it.

```
host = imap.gmail.com
port = 993
smtp_host = smtp.gmail.com
smtp_port = 465
user = you@gmail.com
pass = your-app-password-here
fetch_count = 30
```

**Gmail**: use an [App Password](https://myaccount.google.com/apppasswords),
not your real password (needs 2-Step Verification enabled first). Same
password works for both IMAP and SMTP.

## Run

```
raven
```

| Key | Action |
|---|---|
| ↑ / ↓ | move selection |
| Enter | open message |
| c | compose new message |
| r | refresh |
| q | quit |
| any key | (in message/compose views) go back / confirm |

## Notes

- `raven.ini` is a plaintext credentials file — don't commit it, don't
  share it. It's not part of the installed package; it's your local config.
- Prefers a message's plain-text part. HTML-only messages go through a
  small built-in HTML→text reducer (strips scripts/styles/hidden preheader
  text, keeps link URLs inline).
- No message caching between runs — `r` re-fetches from the server.

## Uninstall

```
pip uninstall raven-mail
```
