.. CAUTION: THIS FILE IS AUTO-GENERATED!


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

.. _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.

.. _cmd.thread.editnew:

.. describe:: editnew

    edit message in as new

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

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

.. _cmd.thread.toggleheaders:

.. describe:: toggleheaders

    display all headers

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

.. _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.bounce:

.. describe:: bounce

    directly re-send selected message


.. _cmd.thread.togglesource:

.. describe:: togglesource

    display message source

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

.. _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.fold:

.. describe:: fold

    fold message(s)

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

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

.. describe:: remove

    remove message(s) from the index

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

.. _cmd.thread.unfold:

.. describe:: unfold

    unfold message(s)

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

.. _cmd.thread.forward:

.. describe:: forward

    forward message

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

.. _cmd.thread.reply:

.. describe:: reply

    reply to message

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

.. _cmd.thread.save:

.. describe:: save

    save attachment(s)

    argument
        path to save to

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

.. _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.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