aerc-imap(5)

1aerc-imap(5)                  File Formats Manual                 aerc-imap(5)
2
3
4

NAME

6       aerc-imap - IMAP configuration for aerc(1)
7

SYNOPSIS

9       aerc implements the IMAP protocol as specified by RFC 3501, with the
10       following IMAP extensions:
11
12       •   IDLE (RFC 2177)
13
14

CONFIGURATION

16       IMAP configuration may be done interactively with the :new-account com‐
17       mand.
18
19       In accounts.conf (see aerc-config(5)), the following IMAP-specific op‐
20       tions are available:
21
22       source
23           imap[s][+insecure|+oauthbearer|+xoauth2]://username[:pass‐
24           word]@hostname[:port]?[:oauth2_params]
25
26           Remember that all fields must be URL encoded. The "@" symbol, when
27           URL encoded, is %40.
28
29           The meaning of the scheme component is:
30
31           imap://:
32               IMAP with STARTTLS
33
34           imap+insecure://:
35               IMAP without STARTTLS
36
37           imaps:
38               IMAP with TLS/SSL
39
40           imaps+oauthbearer://
41               IMAP with TLS/SSL using OAUTHBEARER Authentication
42
43               oauth2_params:
44
45               If specified and a token_endpoint is provided, the configured
46               password is used as a refresh token to obtain an access token.
47               If token_endpoint is omitted, refresh token exchange is
48               skipped, and the password acts like an access token instead.
49
50               •   token_endpoint (optional)
51               •   client_id (optional)
52               •   client_secret (optional)
53               •   scope (optional)
54
55
56               Example: imaps+oauthbearer://...?token_end‐
57               point=https://...&client_id=
58
59           imaps+xoauth2://
60               IMAP with TLS/SSL using XOAUTH2 Authentication. Parameters are
61               the same as OAUTHBEARER.
62
63       source-cred-cmd
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 pass‐
66           word is specified in the source option, the password will take
67           precedence over this command.
68
69           Example:
70
71           pass hostname/username
72
73       connection-timeout
74           Maximum delay to establish a connection to the IMAP server. See
75           https://pkg.go.dev/time#ParseDuration.
76
77           Default: 30s
78
79       keepalive-period
80           The interval between the last data packet sent (simple ACKs are not
81           considered data) and the first keepalive probe. After the connec‐
82           tion is marked to need keepalive, this counter is not used any fur‐
83           ther. See https://pkg.go.dev/time#ParseDuration.
84
85           By default, the system tcp socket settings are used.
86
87       keepalive-probes
88           The number of unacknowledged probes to send before considering the
89           connection dead and notifying the application layer.
90
91           By default, the system tcp socket settings are used. If keepalive-
92           period is specified, this option defaults to 3 probes.
93
94           This option is only supported on linux. On other platforms, it will
95           be ignored.
96
97       keepalive-interval
98           The interval between subsequential keepalive probes, regardless of
99           what the connection has exchanged in the meantime. Fractional sec‐
100           onds are truncated.
101
102           By default, the system tcp socket settings are used. If keepalive-
103           period is specified, this option defaults to 3s.
104
105           This option is only supported on linux. On other platforms, it will
106           be ignored.
107
108       check-mail-include
109           Specifies the comma separated list of folders to include when
110           checking for new mail with check-mail. Names prefixed with ~ are
111           interpreted as regular expressions.
112
113           Default: all folders
114
115       check-mail-exclude
116           Specifies the comma separated list of folders to exclude when
117           checking for new mail with check-mail. Names prefixed with ~ are
118           interpreted as regular expressions. Note that this overrides any‐
119           thing from check-mail-include.
120
121           Default: no folders
122
123       cache-headers
124           If set to true, headers will be cached. The cached headers will be
125           stored in $XDG_CACHE_HOME/aerc, which defaults to ~/.cache/aerc.
126
127           Default: false
128
129       cache-max-age
130           Defines the maximum age of cached files. Note: the longest unit of
131           time cache-max-age can be specified in is hours. Set to 0 to dis‐
132           able cleaning the cache
133
134           Default: 720h (30 days)
135
136       idle-timeout
137           The length of time the client will wait for the server to send any
138           final update before the IDLE is closed.
139
140           Default: 10ms
141
142       idle-debounce
143           Specifies the length of time from the last client command until the
144           idler starts.
145
146           Default: 10ms
147

AUTHORS

152       Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
153       Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
154       tributors. For more information about aerc development, see
155       https://sr.ht/~rjarry/aerc/.
156
157
158
159                                  2022-11-02                      aerc-imap(5)

NAME

SYNOPSIS

CONFIGURATION

SEE ALSO

AUTHORS