https://github.com/duesee/imap-next
https://github.com/duesee/imap-next
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/duesee/imap-next
- Owner: duesee
- License: apache-2.0
- Created: 2023-10-08T18:17:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T17:06:06.000Z (3 months ago)
- Last Synced: 2025-04-03T00:38:03.370Z (about 2 months ago)
- Language: Rust
- Size: 451 KB
- Stars: 14
- Watchers: 7
- Forks: 3
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
[](https://github.com/duesee/imap-next/actions/workflows/main.yml)
[](https://github.com/duesee/imap-next/actions/workflows/audit.yml)
[](https://coveralls.io/github/duesee/imap-next?branch=main)
# imap-next ð“…Ÿ
```mermaid
%%{init: {'theme': 'neutral' } }%%
flowchart LR
imap-types --> imap-codec
imap-codec --> imap-next
imap-next -.-> imap-proxy
imap-next -.-> imap-client
style imap-codec stroke-dasharray: 10 5
style imap-next stroke-width:4px
click imap-types href "https://github.com/duesee/imap-codec/tree/main/imap-types"
click imap-codec href "https://github.com/duesee/imap-codec"
click imap-next href "https://github.com/duesee/imap-next"
click imap-proxy href "https://github.com/duesee/imap-proxy"
click imap-client href "https://github.com/soywod/imap-client"
```
`imap-next` is a thin sans I/O abstraction over IMAP's distinct protocol flows.
These are literal handling, AUTHENTICATE, and IDLE.
The way these protocol flows were defined in IMAP couples networking, parsing, and business logic.
`imap-next` untangles them, providing a minimal interface allowing sending and receiving coherent messages.
It's a thin layer paving the ground for higher-level client or server implementations.
And it's sans I/O enabling the integration in any existing I/O runtime.
## Lower-level Libraries
`imap-next` uses [`imap-codec`](https://github.com/duesee/imap-codec) internally for parsing and serialization, and
re-exposes [`imap-types`](https://github.com/duesee/imap-codec/tree/main/imap-types).
## Higher-level Libraries
* [`imap-proxy`](https://github.com/duesee/imap-proxy) is an IMAP proxy that gracefully forwards unsolicited responses,
abstracts over literals, and `Debug`-prints messages.
* [`imap-client`](https://github.com/soywod/imap-client) is a methods-based client library with
a `client.capability()`, `client.login()`, ... interface.
## Usage
```rust,no_run
use std::error::Error;
use imap_next::{
client::{Client, Event, Options},
imap_types::{
command::{Command, CommandBody},
core::Tag,
},
stream::Stream,
};
use tokio::net::TcpStream;
#[tokio::main]
async fn main() -> Result<(), Box> {
let mut stream = Stream::insecure(TcpStream::connect("127.0.0.1:1143").await?);
let mut client = Client::new(Options::default());
loop {
match stream.next(&mut client).await? {
event => {
println!("{event:?}");
if matches!(event, Event::GreetingReceived { .. }) {
break;
}
}
}
}
let handle = client.enqueue_command(Command::new("A1", CommandBody::login("Al¹cE", "pa²²w0rd")?)?);
loop {
match stream.next(&mut client).await? {
event => println!("{event:?}"),
}
}
}
```
# License
This crate is dual-licensed under Apache 2.0 and MIT terms.
# Thanks
Thanks to the [NLnet Foundation](https://nlnet.nl/) for supporting `imap-next` through
their [NGI Assure](https://nlnet.nl/assure/) program!
