.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LEI-MAIL-SYNC-OVERVIEW 7"
.TH LEI-MAIL-SYNC-OVERVIEW 7 1993-10-02 public-inbox.git "public-inbox user manual"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
lei \- an overview of lei mail synchronization
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBlei\fR\|(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.
.PP
Mail and keyword synchronization is currently a clunky process.
Future work will be done to improve it and add IMAP IDLE support.
.SH "TYPICAL WORKFLOW"
.IX Header "TYPICAL WORKFLOW"
.Vb 2
\&  # import mail from a user\*(Aqs 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\*(Aq) 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
.Ve
.SH CONTACT
.IX Header "CONTACT"
Feedback welcome via plain-text mail to <mailto:meta@public\-inbox.org>
.PP
The mail archives are hosted at <https://public\-inbox.org/meta/> and
<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright all contributors <mailto:meta@public\-inbox.org>
.PP
License: AGPL\-3.0+ <https://www.gnu.org/licenses/agpl\-3.0.txt>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlei\-import\fR\|(1), \fBlei\-q\fR\|(1), \fBlei\-index\fR\|(1),
\&\fBlei\-refresh\-mail\-sync\fR\|(1), \fBlei\-export\-kw\fR\|(1)