summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/thread.rst
blob: 1520e3cccb788a251b3c8a4d66280ef09b6a8029 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
.. CAUTION: THIS FILE IS AUTO-GENERATED!


Commands in `thread` mode
-------------------------
The following commands are available in thread mode

.. _cmd.thread.bounce:

.. describe:: bounce

    directly re-send selected message


.. _cmd.thread.editnew:

.. describe:: editnew

    edit message in as new

    optional arguments
        :---spawn: open editor in new window.

.. _cmd.thread.fold:

.. describe:: fold

    fold message(s)

    argument
        query used to filter messages to affect


.. _cmd.thread.forward:

.. describe:: forward

    forward message

    optional arguments
        :---attach: attach original mail.
        :---spawn: open editor in new window.

.. _cmd.thread.indent:

.. describe:: indent

    change message/reply indentation

    argument
        None


.. _cmd.thread.move:

.. describe:: move

    move focus in current buffer

    argument
        up, down, [half]page up, [half]page down, first, last,                   parent, first reply, last reply,                   next sibling, previous sibling, next, previous,                   next unfolded, previous unfolded,                   next NOTMUCH_QUERY, previous NOTMUCH_QUERY


.. _cmd.thread.pipeto:

.. describe:: pipeto

    pipe message(s) to stdin of a shellcommand

    argument
        shellcommand to pipe to

    optional arguments
        :---all: pass all messages.
        :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw').
        :---separately: call command once for each message.
        :---background: don't stop the interface.
        :---add_tags: add 'Tags' header to the message.
        :---shell: let the shell interpret the command.
        :---notify_stdout: display cmd's stdout as notification.
        :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput').

.. _cmd.thread.print:

.. describe:: print

    print message(s)

    optional arguments
        :---all: print all messages.
        :---raw: pass raw mail string.
        :---separately: call print command once for each message.
        :---add_tags: add 'Tags' header to the message.

.. _cmd.thread.remove:

.. describe:: remove

    remove message(s) from the index

    optional arguments
        :---all: remove whole thread.

.. _cmd.thread.reply:

.. describe:: reply

    reply to message

    optional arguments
        :---all: reply to all.
        :---list: reply to list.
        :---spawn: open editor in new window.

.. _cmd.thread.retag:

.. describe:: retag

    set message(s) tags.

    argument
        comma separated list of tags

    optional arguments
        :---all: tag all messages in thread.
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').

.. _cmd.thread.retagprompt:

.. describe:: retagprompt

    prompt to retag selected thread's or message's tags


.. _cmd.thread.save:

.. describe:: save

    save attachment(s)

    argument
        path to save to

    optional arguments
        :---all: save all attachments.

.. _cmd.thread.select:

.. describe:: select

    select focussed element. The fired action depends on the focus:
        - if message summary, this toggles visibility of the message,
        - if attachment line, this opens the attachment


.. _cmd.thread.tag:

.. describe:: tag

    add tags to message(s)

    argument
        comma separated list of tags

    optional arguments
        :---all: tag all messages in thread.
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').

.. _cmd.thread.toggleheaders:

.. describe:: toggleheaders

    display all headers

    argument
        query used to filter messages to affect


.. _cmd.thread.togglesource:

.. describe:: togglesource

    display message source

    argument
        query used to filter messages to affect


.. _cmd.thread.toggletags:

.. describe:: toggletags

    flip presence of tags on message(s)

    argument
        comma separated list of tags

    optional arguments
        :---all: tag all messages in thread.
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').

.. _cmd.thread.unfold:

.. describe:: unfold

    unfold message(s)

    argument
        query used to filter messages to affect


.. _cmd.thread.untag:

.. describe:: untag

    remove tags from message(s)

    argument
        comma separated list of tags

    optional arguments
        :---all: tag all messages in thread.
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').