]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-tag.pod
treewide: update to v3 Tor onions
[public-inbox.git] / Documentation / lei-tag.pod
1 =head1 NAME
2
3 lei-tag - set/unset metadata on messages
4
5 =head1 SYNOPSIS
6
7 lei tag [OPTIONS] FILE [FILE...] METADATA [METADATA...]
8
9 lei tag [OPTIONS] (-|--stdin) METADATA [METADATA...]
10
11 =head1 DESCRIPTION
12
13 Set or unset volatile metadata on messages.  In JMAP terms, "volatile
14 metadata" includes "mailboxes" (analogous to a folder or label) and a
15 restricted set of "keywords".  This supported keywords are the
16 combination of system keywords (seen, answered, flagged, and draft),
17 which map to Maildir flags and mbox Status/X-Status headers, as well
18 as reserved keywords (forwarded, phishing, junk, and notjunk).
19
20 To add a label or keyword, prefix it with "+L:" and "+kw:",
21 respectively.  To remove a label or keyword, use "-L:" or "-kw:".  For
22 example, "+kw:flagged" would set the "flagged" keyword for the
23 specified messages, and "-L:INBOX" would remove the "INBOX" label.
24
25 =head1 OPTIONS
26
27 =over
28
29 =item -F MAIL_FORMAT, --in-format=MAIL_FORMAT
30
31 Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
32 C<mboxo>.
33
34 Default: C<eml>
35
36 =item -q, --quiet
37
38 Suppress feedback messages.
39
40 =back
41
42 =head1 CONTACT
43
44 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
45
46 The mail archives are hosted at L<https://public-inbox.org/meta/> and
47 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
48
49 =head1 COPYRIGHT
50
51 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
52
53 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
54
55
56 =head1 SEE ALSO
57
58 L<lei-add-external(1)>