# vomit-sync
[](https://crates.io/crates/vomit-sync)
[](https://builds.sr.ht/~bitfehler/vomit-sync/commits?)
[](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
The goal is to provide full two-way synchronization between an IMAP server and
a local maildir, either by running periodically, or as a deamon.
Syncing in either direction or both ways (assuming no conflicts) is
implemented, but currently only by running periodically.
As of version 0.7, vsync supports arbitrary IMAP hierarchy delimiters.
## Building
If you want to build yourself rather than `cargo install`, you can build the
library with `cargo build` and the `vsync` tool with `cargo build -p vsync`.
## 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"