1AERC-IMAP(5) File Formats Manual AERC-IMAP(5)
2
6 aerc-imap - IMAP configuration for aerc(1)
7
9 aerc implements the IMAP protocol as specified by RFC 3501, with the
10 following IMAP extensions:
11 • IDLE (RFC 2177)
13 • LIST-STATUS (RFC 5819)
14
17 IMAP configuration may be done interactively with the :new-account com‐
18 mand.
19 In accounts.conf (see aerc-accounts(5)), the following IMAP-specific
21 options are available:
22 source = <scheme>://<username>[:<password>]@<host‐
24 name>[:<port>]?[<oauth2_params>]
25 Remember that all fields must be URL encoded. The @ symbol, when
26 URL encoded, is %40.
27 Possible values of <scheme> are:
29 imap
31 IMAP with STARTTLS
32 imap+insecure
34 IMAP without STARTTLS
35 imaps
37 IMAP with TLS/SSL
38 imaps+oauthbearer
40 IMAP with TLS/SSL using OAUTHBEARER Authentication
41 <oauth2_params>:
43 If specified and a token_endpoint is provided, the configured
45 password is used as a refresh token to obtain an access token.
46 If token_endpoint is omitted, refresh token exchange is
47 skipped, and the password acts like an access token instead.
48 • token_endpoint (optional)
50 • client_id (optional)
51 • client_secret (optional)
52 • scope (optional)
53 Example:
56 imaps+oauthbearer://...?token_end‐
57 point=https://...&client_id=
58 imaps+xoauth2
60 IMAP with TLS/SSL using XOAUTH2 Authentication. Parameters are
61 the same as OAUTHBEARER.
62 source-cred-cmd = <command>
64 Specifies the command to run to get the password for the IMAP ac‐
65 count. This command will be run using sh -c command. If a password
66 is specified in the source option, the password will take prece‐
67 dence over this command.
68 Example:
70 source-cred-cmd = pass hostname/username
71 connection-timeout = <duration>
73 Maximum delay to establish a connection to the IMAP server. See
74 https://pkg.go.dev/time#ParseDuration.
75 Default: 30s
77 keepalive-period = <duration>
79 The interval between the last data packet sent (simple ACKs are not
80 considered data) and the first keepalive probe. After the connec‐
81 tion is marked to need keepalive, this counter is not used any fur‐
82 ther. See https://pkg.go.dev/time#ParseDuration.
83 By default, the system tcp socket settings are used.
85 keepalive-probes = <int>
87 The number of unacknowledged probes to send before considering the
88 connection dead and notifying the application layer.
89 By default, the system tcp socket settings are used. If keepalive-
91 period is specified, this option defaults to 3 probes.
92 This option is only supported on linux. On other platforms, it will
94 be ignored.
95 keepalive-interval = <duration>
97 The interval between subsequential keepalive probes, regardless of
98 what the connection has exchanged in the meantime. Fractional sec‐
99 onds are truncated.
100 By default, the system tcp socket settings are used. If keepalive-
102 period is specified, this option defaults to 3s.
103 This option is only supported on linux. On other platforms, it will
105 be ignored.
106 check-mail-include = <folder1,folder2,folder3...>
108 Specifies the comma separated list of folders to include when
109 checking for new mail with :check-mail. Names prefixed with ~ are
110 interpreted as regular expressions. This setting is ignored if your
111 IMAP server supports the LIST-STATUS command, in which case all
112 folders will be checked.
113 By default, all folders are included.
115 check-mail-exclude = <folder1,folder2,folder3...>
117 Specifies the comma separated list of folders to exclude when
118 checking for new mail with :check-mail. Names prefixed with ~ are
119 interpreted as regular expressions. This setting is ignored if your
120 IMAP server supports the LIST-STATUS command, in which case all
121 folders will be checked. Note that this overrides anything from
122 check-mail-include.
123 By default, no folders are excluded.
125 cache-headers = true|false
127 If set to true, headers will be cached. The cached headers will be
128 stored in $XDG_CACHE_HOME/aerc, which defaults to ~/.cache/aerc.
129 Default: false
131 cache-max-age = <duration>
133 Defines the maximum age of cached files. Note: the longest unit of
134 time cache-max-age can be specified in is hours. Set to 0 to dis‐
135 able cleaning the cache
136 Default: 720h (30 days)
138 idle-timeout = <duration>
140 The length of time the client will wait for the server to send any
141 final update before the IDLE is closed.
142 Default: 10ms
144 idle-debounce = <duration>
146 Specifies the length of time from the last client command until the
147 idler starts.
148 Default: 10ms
150
152 aerc(1) aerc-accounts(5)
153
155 Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
156 Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
157 tributors. For more information about aerc development, see
158 https://sr.ht/~rjarry/aerc/.
159 2023-07-19 AERC-IMAP(5)