1NOTMUCH-RESTORE(1)                  notmuch                 NOTMUCH-RESTORE(1)
2
3
4

NAME

6       notmuch-restore  -  restores  the tags from the given file (see notmuch
7       dump)
8

SYNOPSIS

10       notmuch restore [--accumulate]  [--format=(auto|batch-tag|sup)]  [--in‐
11       put=<filename>]
12

DESCRIPTION

14       Restores the tags from the given file (see notmuch-dump).
15
16       The input is read from the given filename, if any, or from stdin.
17
18       Supported options for restore include
19
20       --accumulate
21              The  union  of  the existing and new tags is applied, instead of
22              replacing each message's tags as they are read in from the  dump
23              file.
24
25       --format=(sup|batch-tag|auto)
26              Notmuch  restore supports two plain text dump formats, with each
27              line specifying a message-id and a set of tags. For  details  of
28              the actual formats, see notmuch-dump.
29
30              sup    The  sup  dump  file  format is specifically chosen to be
31                     compatible with the format of files produced by sup-dump.
32                     So if you've previously been using sup for mail, then the
33                     notmuch restore command provides you a way to import  all
34                     of your tags (or labels as sup calls them).
35
36              batch-tag
37                     The  batch-tag  dump  format  is  intended to more robust
38                     against malformed message-ids and tags containing  white‐
39                     space  or  non-ascii(7)  characters. See notmuch-dump for
40                     details on this format.
41
42                     notmuch restore updates the maildir  flags  according  to
43                     tag  changes  if the maildir.synchronize_flags configura‐
44                     tion option is enabled. See notmuch-config for details.
45
46              auto   This option (the default) tries to guess the format  from
47                     the input. For correctly formed input in either supported
48                     format, this heuristic, based  the  fact  that  batch-tag
49                     format contains no parentheses, should be accurate.
50
51       --include=(config|properties|tags)
52              Control what kind of metadata is restored.
53
54              config Restore configuration data to the database. Each configu‐
55                     ration line starts with "#@ ", followed by a space  sepa‐
56                     rated key-value pair.  Both key and value are hex encoded
57                     if needed.
58
59              properties
60                     Restore  per-message  (key,value)  metadata.   Each  line
61                     starts  with "#= ", followed by a message id, and a space
62                     separated list of key=value pairs.  Ids, keys and  values
63                     are  hex  encoded  if needed.  See notmuch-properties for
64                     more details.
65
66              tags   Restore per-message metadata,  namely  tags.  See  format
67                     above for more details.
68
69              The  default  is to restore all available types of data. The op‐
70              tion can be specified multiple times to select some subset.
71
72       --input=<filename>
73              Read input from given file instead of stdin.
74

GZIPPED INPUT

76       notmuch restore will detect if the input is compressed in gzip(1)  for‐
77       mat  and automatically decompress it while reading. This detection does
78       not depend on file naming and in particular works for standard input.
79

SEE ALSO

81       notmuch, notmuch-config,  notmuch-count,  notmuch-dump,  notmuch-hooks,
82       notmuch-insert,    notmuch-new,    notmuch-properties,   notmuch-reply,
83       notmuch-search, notmuch-search-terms, notmuch-show, notmuch-tag
84

AUTHOR

86       Carl Worth and many others
87

89       2009-2023, Carl Worth and many others
90
91
92
93
940.37                             Jan 19, 2023               NOTMUCH-RESTORE(1)
Impressum