Documentation/lei-mail-sync-overview.pod

   1 =head1 NAME
   2
   3 lei - an overview of lei mail synchronization
   4
   5 =head1 DESCRIPTION
   6
   7 L<lei(1)> provides several plumbing-level commands to synchronize
   8 mail and keywords (flags) between lei/store and existing IMAP
   9 and Maildir stores.  Nothing documented in this manpage is required
  10 for day-to-day use against externals.
  11
  12 Mail and keyword synchronization is currently a clunky process.
  13 Future work will be done to improve it and add IMAP IDLE support.
  14
  15 =head1 TYPICAL WORKFLOW
  16
  17   # import mail from a user's IMAP inbox and give it the "inbox" label:
  18   lei import +L:inbox imaps://user@example.com/INBOX
  19
  20   # dump "inbox" labeled files from the past week to a Maildir
  21   lei q L:inbox rt:last.week.. -o /tmp/results
  22
  23   # open /tmp/results in your favorite mail agent.  If inotify or kevent
  24   # works, keyword changes (e.g. marking messages as `seen') are
  25   # synchronized automatically.
  26
  27   # If the inotify queue overflows, or if lei-daemon crashes,
  28   # "lei index" will tell lei about keyword changes:
  29   lei index /tmp/results
  30
  31   # Optional: cleanup stale entries from mail_sync.sqlite3
  32   lei refresh-mail-sync /tmp/results
  33
  34   # to export keyword changes back to IMAP
  35   lei export-kw imaps://user@example.com/INBOX
  36
  37 =head1 CONTACT
  38
  39 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  40
  41 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  42 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  43
  44 =head1 COPYRIGHT
  45
  46 Copyright all contributors L<mailto:meta@public-inbox.org>
  47
  48 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  49
  50 =head1 SEE ALSO
  51
  52 L<lei-import(1)>, L<lei-q(1)>, L<lei-index(1)>,
  53 L<lei-refresh-mail-sync(1)>, L<lei-export-kw(1)>