~rockorager/offmap

An email synchronizer
f702f573 — Moritz Poldrack 2 years ago
cmd: make syncing run in parallel
332c8521 — Moritz Poldrack 2 years ago
cmd: rename sync function to avoid collisions with stdlib package
cancellation: close after current mailbox finishes sync

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~rockorager/offmap
read/write
git@git.sr.ht:~rockorager/offmap

You can also use your local clone with git send-email.

#offmap

An email synchronizer

#Installation

Installation requires go and scdoc.

$ git clone https://git.sr.ht/~rockorager/offmap
$ cd offmap
$ make
$ sudo make install

Users of Archlinux can install the latest development version using the AUR package offmap-git.

#Usage

Recommended usage includes adding verbosity flags. While offmap is in development, it will be important to watch the log outputs. Each 'v' increases the verbosity one level.

# Sync your mail
$ offmap sync -vvvv

# View the pending changes since last sync
$ offmap diff -vvvv

During development, offmap will not delete directories. Individual emails will be deleted, however full directories will not.

#Configuration

Offmap configuration is intended to be very simple. The configuration file should be kept at: $XDG_CONFIG_HOME/offmap/offmap.toml

[account-name]
maildir         = "/abs/path/to/maildir"
host            = "imap.yourhost.com:993"
username        = "you@yourhost.com"
password        = "your-password"

#Advantages

Offmap aims to improve over existing IMAP <-> maildir synchronization tools in two ways:

  1. Simpler configuration
  2. Usage of IMAP Extensions

Specifically, offmap will attempt to use the following IMAP extensions:

  • UIDPLUS (required)
  • CONDSTORE (optional)
  • LIST-STATUS (optional)
  • QRESYNC (not yet implemented)
  • MULTIAPPEND (not yet implemented)
  • COMPRESS (not yet implemented)