1AERC-ACCOUNTS(5) File Formats Manual AERC-ACCOUNTS(5)
2
6 aerc-accounts - account configuration file format for aerc(1)
7
9 The accounts.conf file is used for configuring each mail account used
10 for aerc. It is expected to be in your XDG config home plus aerc, which
11 defaults to ~/.config/aerc/accounts.conf. This file must be kept se‐
12 cret, as it may include your account credentials.
13 If accounts.conf does not exist, the :new-account configuration wizard
15 will be executed automatically on first startup.
16 This file is written in the ini format where each [section] is the name
18 of an account you want to configure, and the keys & values in that sec‐
19 tion specify details of that account's configuration. In addition to
20 the options documented here, specific transports for incoming and out‐
21 going emails may have additional configuration parameters, documented
22 on their respective man pages.
23
25 Note that many of these configuration options are written for you, such
26 as source and outgoing, when you run the account configuration wizard
27 (:new-account).
28 archive = <folder>
30 Specifies a folder to use as the destination of the :archive com‐
31 mand.
32 Default: Archive
34 check-mail = <duration>
36 Specifies an interval to check for new mail. Mail will be checked
37 at startup, and every interval. IMAP accounts will check for mail
38 in all unselected folders, and the selected folder will continue to
39 receive PUSH mail notifications. Maildir/Notmuch folders must use
40 check-mail-cmd in conjunction with this option. See aerc-maildir(5)
41 and aerc-notmuch(5) for more information.
42 Setting this option to 0 will disable check-mail
44 Example:
46 check-mail = 5m
47 Default: 0
49 copy-to = <folder>
51 Specifies a folder to copy sent mails to, usually Sent.
52 default = <folder>
54 Specifies the default folder to open in the message list when aerc
55 configures this account.
56 Default: INBOX
58 folders = <folder1,folder2,folder3...>
60 Specifies the comma separated list of folders to display in the
61 sidebar. Names prefixed with ~ are interpreted as regular expres‐
62 sions.
63 By default, all folders are displayed.
65 folders-exclude = <folder1,folder2,folder3...>
67 Specifies the comma separated list of folders to exclude from the
68 sidebar. Names prefixed with ~ are interpreted as regular expres‐
69 sions. Note that this overrides anything from folders.
70 By default, no folders are excluded.
72 enable-folders-sort = true|false
74 If true, folders are sorted, first by specified folders (see fold‐
75 ers-sort), then alphabetically.
76 Default: true
78 folders-sort = <folder1,folder2,folder3...>
80 Specifies a comma separated list of folders to be shown at the top
81 of the list in the provided order. Remaining folders will be sorted
82 alphabetically.
83 from = <address>
85 The default value to use for the From header in new emails. This
86 should be an RFC 5322-compatible string, such as Your Name <you@ex‐
87 ample.org>.
88 aliases = <address1,address2,address3...>
90 All aliases of the current account. These will be used to fill in
91 the From: field. Make sure that your email server accepts this
92 value, or for example use aerc-sendmail(5) in combination with
93 msmtp(1) and --read-envelope-from.
94 outgoing = <uri>
96 Specifies the transport for sending outgoing emails on this ac‐
97 count. It should be a connection string, and the specific meaning
98 of each component varies depending on the protocol in use. See each
99 protocol's man page for more details:
100 • aerc-sendmail(5)
102 • aerc-smtp(5)
103 outgoing-cred-cmd = <command>
106 Specifies an optional command that is run to get the outgoing ac‐
107 count's password. See each protocol's man page for more details.
108 outgoing-cred-cmd-cache = true|false
110 By default, the credentials returned by the command will be cached
111 until aerc is shut down. If set to false, outgoing-cred-cmd will be
112 executed every time an email is to be sent.
113 Default: true
115 pgp-auto-sign = true|false
117 If true, all outgoing emails from this account will be signed (if a
118 signing key is available).
119 Default: false
121 pgp-error-level = none|warn|error
123 The level of error to display when opportunistic encryption cannot
124 be performed. See pgp-opportunistic-encryption.
125 Default: warn
127 pgp-key-id = <key-id>
129 Specify the key id to use when signing a message. Can be either
130 short or long key id. If unset, aerc will look up the key by email.
131 pgp-opportunistic-encrypt = true|false
133 If true, any outgoing email from this account will be encrypted
134 when all recipients (including Cc and Bcc field) have a public key
135 available in the keyring. The level of error to display when a mes‐
136 sage can't be encrypted can be configured with pgp-error-level.
137 Default: false
139 postpone = <folder>
141 Specifies the folder to save postponed messages to.
142 Default: Drafts
144 send-as-utc = true|false
146 Converts the timestamp of the Date header to UTC.
147 Default: false
149 source = <uri>
151 Specifies the source for reading incoming emails on this account.
152 This key is required for all accounts. It should be a connection
153 string, and the specific meaning of each component varies depending
154 on the protocol in use. See each protocol's man page for more de‐
155 tails:
156 • aerc-imap(5)
158 • aerc-maildir(5)
159 • aerc-notmuch(5)
160 source-cred-cmd = <command>
163 Specifies an optional command that is run to get the source ac‐
164 count's password. See each protocol's man page for more details.
165 signature-file = <path>
167 Specifies the file to read in order to obtain the signature to be
168 added to emails sent from this account.
169 Please note that by convention the Usenet signature style of two
171 dashes, followed by a space ("-- ") should be placed at the top of
172 the signature to separate content and signature. Aerc will add that
173 delimiter if it is not already present.
174 signature-cmd = <command>
176 Specifies the command to execute with sh -c in order to obtain the
177 signature to be added to emails sent from this account. If the com‐
178 mand fails then signature-file is used instead.
179 trusted-authres = <host1,host2,host3...>
181 Comma-separated list of trustworthy hostnames from which the Au‐
182 thentication Results header will be displayed. Entries can be regu‐
183 lar expressions. If you want to trust any host (e.g. for debug‐
184 ging), use the wildcard *.
185 subject-re-pattern = <regexp>
187 When replying to a message, this is the regular expression that
188 will be used to match the prefix of the original message's subject
189 that has to be removed, to create the subject line of the new mes‐
190 sage. Typically, this will be used to avoid a repetition of the Re:
191 prefix in the subject header. The default will match known transla‐
192 tions for the common Re:.
193 Default: (?i)^((AW|RE|SV|VS|ODP|R): ?)+
195
197 aerc(1) aerc-config(5) aerc-imap(5) aerc-maildir(5) aerc-notmuch(5)
198 aerc-sendmail(5) aerc-smtp(5)
199
201 Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
202 Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
203 tributors. For more information about aerc development, see
204 https://sr.ht/~rjarry/aerc/.
205 2023-07-16 AERC-ACCOUNTS(5)