# vsync IMAP to maildir synchronization

![This crate is deprecated](https://img.shields.io/badge/maintenance-deprecated-red.svg)
[![Crates.io](https://img.shields.io/crates/v/vsync.svg)](https://crates.io/crates/vsync)
[![builds.sr.ht status](https://builds.sr.ht/~bitfehler/vomit-sync/commits.svg)](https://builds.sr.ht/~bitfehler/vomit-sync/commits?)

Vsync is a small CLI wrapper around [vomit-sync][1]. It aims to provide access
to all functions that vomit-sync offers. Currently, syncing a local maildir
and a remote IMAP mailbox in both directions is supported. Vsync has to be run
periodically to keep the two synchronized.

⚠️⚠️⚠️  **IMPORTANT:** ⚠️⚠️⚠️  vsync is **unmaintained and deprecated**. Its official
successor is [m2sync tool][6]. Using that will however require switching your
local mail store from maildir to [m2dir][7]. Sorry for the inconvenience.

[6]: https://crates.io/crates/m2sync "m2sync on crates.io"
[7]: https://sr.ht/~bitfehler/m2sir "m2dir homepage"

# Configuration

vsync uses [vomit-config][4], which means the default configuration file
location is `$XDG_CONFIG_DIR/vomit/config.toml` (usually
`~/.config/vomit/config.toml`).

[4]: https://docs.rs/vomit-config

Example configuration file:

```
[myaccount]
local = "~/.maildir"
remote = "imap.example.com:993"
user = "myusername"
pass-cmd = "pass show mail/myaccount"
# or use this:
#password = "s3cr34"
```

## The Vomit project

Both vomit-sync and vsync are part of the [Vomit project][2].

[2]: https://sr.ht/~bitfehler/vomit "Vomit project page on SourceHut"

## Contributing

Please send patches to the [vomit mailing list][3].

## Feedback

The [mailing list][3] is open for all kinds of feedback, questions, and
discussions.

[3]: https://lists.sr.ht/~bitfehler/vomit "The Vomit mailing list"