summaryrefslogtreecommitdiff
path: root/docs/source/configuration/accounts_table
blob: 265bc34bf4c03d866d3eb6952f823bf647e34d7e (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
.. 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,


.. _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.
     .. note:: The values `True` and `False` are interpreted as `all` and
               `none` respectively.  They are kept for backwards
               compatibility to give users a change to migrate to the new
               option type.  They might become deprecated in future
               versions.

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


.. _gpg-key:

.. describe:: gpg_key

     The GPG key ID you want to use with this account. If unset, alot will
     use your default key.

    :type: string
    :default: None