public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob 8cb9e736b6e74acd9924dd0339edec3ec0490987 2136 bytes (raw)
$ git show HEAD:Documentation/lei-tag.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
 
=head1 NAME

lei-tag - set/unset metadata on messages

=head1 SYNOPSIS

lei tag [OPTIONS] FILE [FILE...] METADATA [METADATA...]

lei tag [OPTIONS] (-|--stdin) METADATA [METADATA...]

=head1 DESCRIPTION

Set or unset volatile metadata on messages.  In JMAP terms, "volatile
metadata" includes "mailboxes" (analogous to a folder or label) and a
restricted set of "keywords".  This supported keywords are the
combination of system keywords (seen, answered, flagged, and draft),
which map to Maildir flags and mbox Status/X-Status headers, as well
as reserved keywords (forwarded, phishing, junk, and notjunk).

To add a label or keyword, prefix it with "+L:" and "+kw:",
respectively.  To remove a label or keyword, use "-L:" or "-kw:".  For
example, "+kw:flagged" would set the "flagged" keyword for the
specified messages, and "-L:INBOX" would remove the "INBOX" label.

=head1 OPTIONS

=over

=item -F MAIL_FORMAT

=item --in-format=MAIL_FORMAT

Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
C<mboxo>.

Default: C<eml>

=item -q

=item --quiet

Suppress feedback messages.

=back

=head1 LABELS

Labels are user-defined values analogous to IMAP/JMAP mailbox
names.  They must only contain lowercase characters, digits, and
a limited amount of punctuation (e.g. C<.>, C<->, C<@>).

Messages may have multiple labels.

=head1 KEYWORDS

Keywords are "flags" in Maildir and IMAP terminology.
Common keywords include: C<seen>, C<answered>, C<flagged>, and
C<draft>, though C<forwarded>, C<phishing>, C<junk>, and C<notjunk>
are also supported.

When writing to various mboxes, the common keywords will be
mapped to the C<Status> and C<X-Status> headers.

Messages may have multiple keywords.

=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 2021 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-add-external(1)>

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