# vomit-m2sync

[![Crates.io](https://img.shields.io/crates/v/vomit-m2sync.svg)](https://crates.io/crates/vomit-m2sync)
[![builds.sr.ht status](https://builds.sr.ht/~bitfehler/vomit-m2sync/commits.svg)](https://builds.sr.ht/~bitfehler/vomit-m2sync/commits?)
[![Documentation](https://docs.rs/vomit-m2sync/badge.svg)](https://docs.rs/vomit-m2sync)

Vomit-m2sync is a Rust library for IMAP to [m2dir][4] synchronization. If you
just want something to do this, you are looking for [m2sync][1], a thin
CLI wrapper around vomit-m2sync.

[1]: https://crates.io/crates/m2sync "m2sync on crates.io"
[4]: https://sr.ht/~bitfehler/m2dir "m2dir homepage"

## Goals and status

The goal is to provide full two-way synchronization between an IMAP server and
a local m2dir, 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.

⚠️ **NOTE:** ⚠️ until vomit-m2sync has reached version 1.0 it has to be considered
experimental, and it is entirely possible that it will **delete your email**!

See the [m2sync README][1] for some advice.

## Building

If you want to build yourself rather than `cargo install`, you can build the
library with `cargo build -p vomit-m2sync` and the `m2sync` tool with `cargo
build -p m2sync`.

## The Vomit project

Both vomit-m2sync and m2sync 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"