summaryrefslogtreecommitdiff
path: root/docs/source/configuration/accounts_table
blob: 2215df5127b02f7f86e49b6ce442deca1b49a9ad (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
.. CAUTION: THIS FILE IS AUTO-GENERATED
    from the inline comments of specfile defaults/alot.rc.spec.

    If you want to change its content make your changes
    to that spec to ensure they woun't be overwritten later.

.. _address:

.. describe:: address

     your main email address

    :type: string

.. _realname:

.. describe:: realname

     used to format the (proposed) From-header in outgoing mails

    :type: string

.. _aliases:

.. describe:: aliases

     used to clear your addresses/ match account when formatting replies

    :type: string list
    :default: ,


.. _alias-regexp:

.. describe:: alias_regexp

     a regex for catching further aliases (like + extensions).

    :type: string
    :default: None


.. _sendmail-command:

.. describe:: sendmail_command

     sendmail command. This is the shell command used to send out mails via the sendmail protocol

    :type: string
    :default: "sendmail -t"


.. _sent-box:

.. describe:: sent_box

     where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`.
     You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL.

     .. note:: If you want to add outgoing mails automatically to the notmuch index
               you must use maildir in a path within your notmuch database path.

    :type: mail_container
    :default: None


.. _draft-box:

.. describe:: draft_box

     where to store draft mails, e.g. `maildir:///home/you/mail/Drafts`.
     You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL.

     .. note:: You will most likely want drafts indexed by notmuch to be able to
               later access them within alot. This currently only works for
               maildir containers in a path below your notmuch database path.

    :type: mail_container
    :default: None


.. _sent-tags:

.. describe:: sent_tags

     list of tags to automatically add to outgoing messages

    :type: string list
    :default: sent


.. _draft-tags:

.. describe:: draft_tags

     list of tags to automatically add to draft messages

    :type: string list
    :default: draft


.. _replied-tags:

.. describe:: replied_tags

     list of tags to automatically add to replied messages

    :type: string list
    :default: replied


.. _passed-tags:

.. describe:: passed_tags

     list of tags to automatically add to passed messages

    :type: string list
    :default: passed


.. _signature:

.. describe:: signature

     path to signature file that gets attached to all outgoing mails from this account, optionally
     renamed to :ref:`signature_filename <signature-filename>`.

    :type: string
    :default: None


.. _signature-as-attachment:

.. describe:: signature_as_attachment

     attach signature file if set to True, append its content (mimetype text)
     to the body text if set to False.

    :type: boolean
    :default: False


.. _signature-filename:

.. describe:: signature_filename

     signature file's name as it appears in outgoing mails if
     :ref:`signature_as_attachment <signature-as-attachment>` is set to True

    :type: string
    :default: None


.. _sign-by-default:

.. describe:: sign_by_default

     Outgoing messages will be GPG signed by default if this is set to True.

    :type: boolean
    :default: False


.. _encrypt-by-default:

.. describe:: encrypt_by_default

     Alot will try to GPG encrypt outgoing messages by default when this
     is set to `all` or `trusted`.  If set to `all` the message will be
     encrypted for all recipients for who a key is available in the key
     ring.  If set to `trusted` it will be encrypted to all
     recipients if a trusted key is available for all recipients (one
     where the user id for the key is signed with a trusted signature).

     .. note:: If the message will not be encrypted by default you can
               still use the :ref:`toggleencrypt
               <cmd.envelope.toggleencrypt>`, :ref:`encrypt
               <cmd.envelope.encrypt>` and :ref:`unencrypt
               <cmd.envelope.unencrypt>` commands to encrypt it.
     .. deprecated:: 0.4
               The values `True` and `False` are interpreted as `all` and
               `none` respectively. `0`, `1`, `true`, `True`, `false`,
               `False`, `yes`, `Yes`, `no`, `No`, will be removed before
               1.0, please move to `all`, `none`, or `trusted`.

    :type: option, one of ['all', 'none', 'trusted', 'True', 'False', 'true', 'false', 'Yes', 'No', 'yes', 'no', '1', '0']
    :default: none


.. _encrypt-to-self:

.. describe:: encrypt_to_self

     If this is true when encrypting a message it will also be encrypted
     with the key defined for this account.

     .. warning::

        Before 0.6 this was controlled via gpg.conf.

    :type: boolean
    :default: True


.. _gpg-key:

.. describe:: gpg_key

     The GPG key ID you want to use with this account.

    :type: string
    :default: None


.. _case-sensitive-username:

.. describe:: case_sensitive_username

     Whether the server treats the address as case-senstive or
     case-insensitve (True for the former, False for the latter)

     .. note:: The vast majority (if not all) SMTP servers in modern use
               treat usernames as case insenstive, you should only set
               this if you know that you need it.

    :type: boolean
    :default: False