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
  30
  31 =item --in-format=MAIL_FORMAT
  32
  33 Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
  34 C<mboxo>.
  35
  36 Default: C<eml>
  37
  38 =item -q
  39
  40 =item --quiet
  41
  42 Suppress feedback messages.
  43
  44 =back
  45
  46 =head1 LABELS
  47
  48 Labels are user-defined values analogous to IMAP/JMAP mailbox
  49 names.  They must only contain lowercase characters, digits, and
  50 a limited amount of punctuation (e.g. C<.>, C<->, C<@>).
  51
  52 Messages may have multiple labels.
  53
  54 =head1 KEYWORDS
  55
  56 Keywords are "flags" in Maildir and IMAP terminology.
  57 Common keywords include: C<seen>, C<answered>, C<flagged>, and
  58 C<draft>, though C<forwarded>, C<phishing>, C<junk>, and C<notjunk>
  59 are also supported.
  60
  61 When writing to various mboxes, the common keywords will be
  62 mapped to the C<Status> and C<X-Status> headers.
  63
  64 Messages may have multiple keywords.
  65
  66 =head1 CONTACT
  67
  68 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  69
  70 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  71 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  76
  77 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  78
  79 =head1 SEE ALSO
  80
  81 L<lei-add-external(1)>