diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2013-02-19 10:11:11 +0000 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2013-02-19 10:11:11 +0000 |
commit | ae4a4b28c2f461219344c2b8503dab2a9a8c1d3b (patch) | |
tree | eb2c19eaf288c6812158610ee496db0c0e1e8d39 /docs | |
parent | 17ac6c9539986f3a8e3c079e7cfe56812d7da384 (diff) | |
parent | 15cd4894ed3ad9a9b16484ea0b1dc58e6975040f (diff) |
Merge branch '0.3.3-feature-cryptomails-543'
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/crypto/index.rst | 7 | ||||
-rw-r--r-- | docs/source/usage/modes/envelope.rst | 37 |
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/source/crypto/index.rst b/docs/source/crypto/index.rst index 4c79f4b2..52fb356a 100644 --- a/docs/source/crypto/index.rst +++ b/docs/source/crypto/index.rst @@ -3,6 +3,7 @@ Cryptography ************ At the moment alot only supports signing of outgoing mails via PGP/MIME (:rfc:`3156`). +Encryption via PGP/MIME (:rfc:`3156`) is in an experimental stadium. .. note:: To use GPG with alot, you need to have `gpg-agent` running. @@ -37,4 +38,10 @@ instead of the default graphical pinentry. You can do that by setting up your pinentry-program /usr/bin/pinentry-curses +.. rubric:: Encrypt outgoing emails +You can use the commands `encrypt` and `unencrypt` in envelope mode to +encrypt the mail. You have to give a hint string as argument to the `encrypt` +command. This hint would normally be a fingerprint of the key. + +Encryption is done after signing (if signing is enabled) the email. diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index b3f478be..d7f9c4b8 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,6 +5,13 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode +.. _cmd.envelope.unencrypt: + +.. describe:: unencrypt + + remove request to encrypt message before sending + + .. _cmd.envelope.set: .. describe:: set @@ -19,6 +26,16 @@ The following commands are available in envelope mode optional arguments :---append: keep previous values. +.. _cmd.envelope.encrypt: + +.. describe:: encrypt + + request encryption of message before sendout + + argument + keyid of the key to encrypt with + + .. _cmd.envelope.togglesign: .. describe:: togglesign @@ -73,6 +90,16 @@ The following commands are available in envelope mode file(s) to attach (accepts wildcads) +.. _cmd.envelope.rmencrypt: + +.. describe:: rmencrypt + + do not encrypt to given recipient key + + argument + keyid of the key to encrypt with + + .. _cmd.envelope.refine: .. describe:: refine @@ -83,6 +110,16 @@ The following commands are available in envelope mode header to refine +.. _cmd.envelope.toggleencrypt: + +.. describe:: toggleencrypt + + toggle whether message should be encrypted before sendout + + argument + keyid of the key to encrypt with + + .. _cmd.envelope.save: .. describe:: save |