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