public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob 31d6db1329d6a89465f614d665ceda21f83890c9 2716 bytes (raw)
$ git show HEAD:Documentation/lei-import.pod	# shows this blob on the CLI

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
 
=head1 NAME

lei-import - one-time import of messages into local store

=head1 SYNOPSIS

lei import [OPTIONS] LOCATION [LOCATION...] [+L:LABEL]

lei import [OPTIONS] (--stdin|-)

=head1 DESCRIPTION

Import messages into the local storage of L<lei(1)>
(aka L<leiE<sol>store|lei-store-format(5)>).  C<LOCATION> is a
source of messages: a directory (Maildir), a file, or a URL
(C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>).  URLs requiring
authentication use L<git-credential(1)> to
fill in the username and password.

For a regular file, the C<LOCATION> must have a C<E<lt>formatE<gt>:>
prefix specifying one of the following formats: C<mboxrd>,
C<mboxcl2>, C<mboxcl>, or C<mboxo>.

=head1 OPTIONS

=over

=item -F MAIL_FORMAT

=item --in-format=MAIL_FORMAT

Message input format.  Unless messages are given on stdin, using a
format prefix with C<LOCATION> is preferred.

=item --stdin

Read messages from stdin.

=item --lock

L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or
C<none>.

Default: fcntl,dotlock

=item +L:LABEL

Add the given C<LABEL> to all messages imported, where C<LABEL>
is an arbitrary user-defined value consisting of lowercase and digits.
See L<lei-tag(1)> for more info on labels.

For example, specifying C<+L:inbox> applies the C<inbox> label
to all messages being imported.

May be specified multiple times to apply multiple labels.

Default: none

=item +kw:KEYWORD

Apply C<KEYWORD> to all messages being imported in addition
to any per-message keywords from the store (unless C<--no-kw>
is specified).  See L<lei-tag(1)> for more info on keywords.

May be specified multiple times to apply multiple keywords.

Default: none

=item --no-kw

Don't import message keywords (or "flags" in IMAP terminology).

=item --no-incremental

Import already seen IMAP and NNTP articles.

=item --torsocks=auto|no|yes

=item --no-torsocks

Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>.

Default: C<auto>

=item --proxy=PROTOCOL://HOST[:PORT]

Use the specified proxy (e.g., C<socks5h://0:9050>).

Consider L<imap.proxy> and L<nntp.proxy> which can be persistently
configured on a per-host basis in L<lei-config(1)>.

=back

See L<lei-config(1)> for various C<imap.*> and C<nntp.*> options.

=head1 CONTACT

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

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

=head1 COPYRIGHT

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

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

=head1 SEE ALSO

L<lei-config(1)>, L<lei-index(1)>, L<lei-store-format(5)>

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git