summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/thread.rst
blob: 096d7c20b5a7c6c8dd541177293ea49c427ac50b (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
.. CAUTION: THIS FILE IS AUTO-GENERATED!


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

.. _cmd_thread_pipeto:
.. index:: pipeto

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 command's stdout as notification message.

.. _cmd_thread_editnew:
.. index:: editnew

editnew
_______

edit message in as new

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

.. _cmd_thread_toggleheaders:
.. index:: toggleheaders

toggleheaders
_____________

display all headers

optional arguments
	:---all: affect all messages.

.. _cmd_thread_print:
.. index:: print

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:
.. index:: remove

remove
______

remove message(s) from the index

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

.. _cmd_thread_togglesource:
.. index:: togglesource

togglesource
____________

display message source

optional arguments
	:---all: affect all messages.

.. _cmd_thread_retag:
.. index:: retag

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_fold:
.. index:: fold

fold
____

fold message(s)

optional arguments
	:---all: fold all messages.

.. _cmd_thread_tag:
.. index:: tag

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_untag:
.. index:: untag

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').

.. _cmd_thread_unfold:
.. index:: unfold

unfold
______

unfold message(s)

optional arguments
	:---all: unfold all messages.

.. _cmd_thread_forward:
.. index:: forward

forward
_______

forward message

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

.. _cmd_thread_reply:
.. index:: reply

reply
_____

reply to message

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

.. _cmd_thread_save:
.. index:: save

save
____

save attachment(s)

argument
	path to save to

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

.. _cmd_thread_toggletags:
.. index:: toggletags

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_select:
.. index:: select

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