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


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

    set header value

    positional arguments
        0: header to refine
        1: value


    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

    toggle sign status

    argument
        which key id to use


.. _cmd.envelope.toggleheaders:

.. describe:: toggleheaders

    toggle display of all headers


.. _cmd.envelope.edit:

.. describe:: edit

    edit mail

    optional arguments
        :---spawn: spawn editor in new terminal.
        :---refocus: refocus envelope after editing (Defaults to: 'True').

.. _cmd.envelope.send:

.. describe:: send

    send mail


.. _cmd.envelope.sign:

.. describe:: sign

    mark mail to be signed before sending

    argument
        which key id to use


.. _cmd.envelope.attach:

.. describe:: attach

    attach files to the mail

    argument
        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

    prompt to change the value of a header

    argument
        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

    save draft


.. _cmd.envelope.unsign:

.. describe:: unsign

    mark mail not to be signed before sending


.. _cmd.envelope.unset:

.. describe:: unset

    remove header field

    argument
        header to refine