diff options
Diffstat (limited to 'docs/source/usage/modes/envelope.rst')
-rw-r--r-- | docs/source/usage/modes/envelope.rst | 176 |
1 files changed, 88 insertions, 88 deletions
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 263705b9..ee857cc4 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,143 +5,143 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode -.. _cmd.envelope.toggleheaders: +.. _cmd.envelope.attach: -.. describe:: toggleheaders +.. describe:: attach - toggle display of all headers + attach files to the mail + argument + file(s) to attach (accepts wildcads) -.. _cmd.envelope.unattach: -.. describe:: unattach +.. _cmd.envelope.edit: - remove attachments from current envelope +.. describe:: edit - argument - which attached file to remove + edit mail + optional arguments + :---spawn: spawn editor in new terminal. + :---refocus: refocus envelope after editing (Defaults to: 'True'). -.. _cmd.envelope.rmencrypt: +.. _cmd.envelope.encrypt: -.. describe:: rmencrypt +.. describe:: encrypt - do not encrypt to given recipient key + request encryption of message before sendout argument keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.togglesign: +.. _cmd.envelope.refine: -.. describe:: togglesign +.. describe:: refine - toggle sign status + prompt to change the value of a header argument - which key id to use + header to refine -.. _cmd.envelope.unencrypt: +.. _cmd.envelope.retag: -.. describe:: unencrypt +.. describe:: retag - remove request to encrypt message before sending + set message tags. + argument + comma separated list of tags -.. _cmd.envelope.send: -.. describe:: send +.. _cmd.envelope.rmencrypt: - send mail +.. describe:: rmencrypt + do not encrypt to given recipient key -.. _cmd.envelope.tag: + argument + keyid of the key to encrypt with -.. describe:: tag - add tags to message +.. _cmd.envelope.save: - argument - comma separated list of tags +.. describe:: save + save draft -.. _cmd.envelope.retag: -.. describe:: retag +.. _cmd.envelope.send: - set message tags. +.. describe:: send - argument - comma separated list of tags + send mail -.. _cmd.envelope.encrypt: +.. _cmd.envelope.set: -.. describe:: encrypt +.. describe:: set - request encryption of message before sendout + set header value + + positional arguments + 0: header to refine + 1: value - argument - keyid of the key to encrypt with optional arguments - :---trusted: only add trusted keys. + :---append: keep previous values. -.. _cmd.envelope.toggleencrypt: +.. _cmd.envelope.sign: -.. describe:: toggleencrypt +.. describe:: sign - toggle if message should be encrypted before sendout + mark mail to be signed before sending argument - keyid of the key to encrypt with - - optional arguments - :---trusted: only add trusted keys. - -.. _cmd.envelope.unsign: - -.. describe:: unsign + which key id to use - mark mail not to be signed before sending +.. _cmd.envelope.tag: -.. _cmd.envelope.save: +.. describe:: tag -.. describe:: save + add tags to message - save draft + argument + comma separated list of tags -.. _cmd.envelope.untag: +.. _cmd.envelope.toggleencrypt: -.. describe:: untag +.. describe:: toggleencrypt - remove tags from message + toggle if message should be encrypted before sendout argument - comma separated list of tags + keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.edit: +.. _cmd.envelope.toggleheaders: -.. describe:: edit +.. describe:: toggleheaders - edit mail + toggle display of all headers - optional arguments - :---spawn: spawn editor in new terminal. - :---refocus: refocus envelope after editing (Defaults to: 'True'). -.. _cmd.envelope.unset: +.. _cmd.envelope.togglesign: -.. describe:: unset +.. describe:: togglesign - remove header field + toggle sign status argument - header to refine + which key id to use .. _cmd.envelope.toggletags: @@ -154,47 +154,47 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.sign: +.. _cmd.envelope.unattach: -.. describe:: sign +.. describe:: unattach - mark mail to be signed before sending + remove attachments from current envelope argument - which key id to use + which attached file to remove -.. _cmd.envelope.refine: - -.. describe:: refine +.. _cmd.envelope.unencrypt: - prompt to change the value of a header +.. describe:: unencrypt - argument - header to refine + remove request to encrypt message before sending -.. _cmd.envelope.attach: +.. _cmd.envelope.unset: -.. describe:: attach +.. describe:: unset - attach files to the mail + remove header field argument - file(s) to attach (accepts wildcads) + header to refine -.. _cmd.envelope.set: +.. _cmd.envelope.unsign: -.. describe:: set +.. describe:: unsign - set header value + mark mail not to be signed before sending - positional arguments - 0: header to refine - 1: value +.. _cmd.envelope.untag: + +.. describe:: untag + + remove tags from message + + argument + comma separated list of tags - optional arguments - :---append: keep previous values. |