NAME

       lei - an overview of lei mail synchronization

DESCRIPTION

       lei(1) provides several plumbing-level commands to synchronize mail and keywords (flags)
       between lei/store and existing IMAP and Maildir stores.  Nothing documented in this
       manpage is required for day-to-day use against externals.

       Mail and keyword synchronization is currently a clunky process.  Future work will be done
       to improve it and add IMAP IDLE support.

TYPICAL WORKFLOW

         # import mail from a user's IMAP inbox and give it the "inbox" label:
         lei import +L:inbox imaps://user@example.com/INBOX

         # dump "inbox" labeled files from the past week to a Maildir
         lei q L:inbox rt:last.week.. -o /tmp/results

         # open /tmp/results in your favorite mail agent.  If inotify or kevent
         # works, keyword changes (e.g. marking messages as `seen') are
         # synchronized automatically.

         # If the inotify queue overflows, or if lei-daemon crashes,
         # "lei index" will tell lei about keyword changes:
         lei index /tmp/results

         # Optional: cleanup stale entries from mail_sync.sqlite3
         lei refresh-mail-sync /tmp/results

         # to export keyword changes back to IMAP
         lei export-kw imaps://user@example.com/INBOX

CONTACT

       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>

       The mail archives are hosted at <https://public-inbox.org/meta/> and
       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

COPYRIGHT

       Copyright all contributors <mailto:meta@public-inbox.org>

       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

SEE ALSO

       lei-import(1), lei-q(1), lei-index(1), lei-refresh-mail-sync(1), lei-export-kw(1)