# vomit-sync

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

Vomit-sync is a Rust library for IMAP to maildir synchronization. If you just
want something to do this, you are looking for [vsync][1], a thin application
wrapper around vomit-sync. It lives in the `cli/` folder of this repo and also
has a [README][4].

[1]: https://crates.io/crates/vsync "vsync on crates.io"
[4]: https://git.sr.ht/~bitfehler/vomit-sync/tree/master/item/cli/README.md "vsync README"

## Goals and status

⚠️⚠️⚠️  **IMPORTANT:** ⚠️⚠️⚠️ both vomit-sync and vsync are **unmaintained and
deprecated**. Their official successors are [vomit-m2sync][5] and the
corresponding [m2sync tool][6]. Using them will however require switching your
local mail store from maildir to [m2dir][7]. Sorry for the inconvenience.

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

## 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"

## Contact

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"