public-inbox-edit(1)

1PUBLIC-INBOX-EDIT(1)       public-inbox user manual       PUBLIC-INBOX-EDIT(1)
2
3
4

NAME

6       public-inbox-edit - destructively edit messages in a public inbox
7

SYNOPSIS

9               public-inbox-edit -m MESSAGE-ID --all|INBOX_DIR
10
11               public-inbox-edit -F RAW_FILE --all|INBOX_DIR [.. INBOX_DIR]
12

DESCRIPTION

14       public-inbox-edit allows editing messages in a given inbox to remove
15       sensitive information.  It is only intended as a last resort, as it
16       will cause discontiguous git history and draw more attention to the
17       sensitive data in mirrors.
18

OPTIONS

20       --all
21           Edit the message in all inboxes configured in
22           ~/.public-inbox/config.  This is an alternative to specifying
23           individual inboxes directories on the command-line.
24
25       -m MESSAGE-ID
26           Edits the message corresponding to the given "MESSAGE-ID".  If the
27           "MESSAGE-ID" is ambiguous, "--force" or using the "--file" of the
28           original will be required.
29
30       -F FILE
31           Edits the message corresponding to the Message-ID: header and
32           content given in "FILE".  This requires the unmodified raw message,
33           and the contents of "FILE" will not itself be modified.  This is
34           useful if a Message-ID is ambiguous due to filtering/munging rules
35           or other edits.
36
37       --force
38           Forcibly perform the edit even if Message-ID is ambiguous.
39
40       --raw
41           Do not perform "From " line escaping.  By default, this generates a
42           mboxrd variant file to detect unpurged messages in the new mbox.
43           This makes sense if your configured "publicinbox.mailEditor" is a
44           regular editor and not something like "mutt -f"
45

CONFIGURATION

47       publicinbox.mailEditor
48               The command to perform the edit with.  An example of this would
49               be "mutt -f", and the user would then use the facilities in
50               mutt(1) to edit the mail.  This is useful for editing
51               attachments or Base64-encoded emails which are more difficult
52               to edit with a normal editor (configured via "GIT_EDITOR",
53               "VISUAL" or "EDITOR").
54
55               Default: none
56

ENVIRONMENT

58       GIT_EDITOR / VISUAL / EDITOR
59               public-inbox-edit will fall back to using one of these
60               variables (in that order) if "publicinbox.mailEditor" is unset.
61
62       PI_CONFIG
63               The default config file, normally "~/.public-inbox/config".
64               See public-inbox-config(5)
65

LIMITATIONS

67       Only v2 repositories are supported.
68
69       This is safe to run while normal inbox writing tools
70       (public-inbox-mda(1), public-inbox-watch(1), public-inbox-learn(1)) are
71       active.
72
73       Running this in parallel with public-inbox-xcpdb(1) or
74       "public-inbox-index --reindex" can lead to errors or edited data
75       remaining indexed.
76
77       Incremental public-inbox-index(1) (without "--reindex") is fine.
78
79       Keep in mind this is a last resort, as it will be disruptive to anyone
80       using git(1) to mirror the inbox being edited.
81

CONTACT

83       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
84
85       The mail archives are hosted at <https://public-inbox.org/meta/> and
86       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
87

COPYRIGHT

89       Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org>
90
91       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
92