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]://username[:password]@host‐
24           name[: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, the configured password is used as an refresh to‐
46               ken that is exchanged with an access token
47
48               •   token_endpoint (required)
49               •   client_id (optional)
50               •   client_secret (optional)
51               •   scope (optional)
52
53
54               Example: imaps+oauthbearer://...?token_end‐
55               point=https://...&client_id=
56
57       source-cred-cmd
58           Specifies the command to run to get the password for the IMAP ac‐
59           count. This command will be run using `sh -c [command]`. If a pass‐
60           word is specified in the source option, the password will take
61           precedence over this command.
62
63           Example:
64
65           pass hostname/username
66
67       connection-timeout
68           Maximum delay to establish a connection to the IMAP server. See
69           https://pkg.go.dev/time#ParseDuration.
70
71           Default: 30s
72
73       keepalive-period
74           The interval between the last data packet sent (simple ACKs are not
75           considered data) and the first keepalive probe. After the connec‐
76           tion is marked to need keepalive, this counter is not used any fur‐
77           ther. See https://pkg.go.dev/time#ParseDuration.
78
79           By default, the system tcp socket settings are used.
80
81       keepalive-probes
82           The number of unacknowledged probes to send before considering the
83           connection dead and notifying the application layer.
84
85           By default, the system tcp socket settings are used. If keepalive-
86           period is specified, this option defaults to 3 probes.
87
88           This option is only supported on linux. On other platforms, it will
89           be ignored.
90
91       keepalive-interval
92           The interval between subsequential keepalive probes, regardless of
93           what the connection has exchanged in the meantime. Fractional sec‐
94           onds are truncated.
95
96           By default, the system tcp socket settings are used. If keepalive-
97           period is specified, this option defaults to 3s.
98
99           This option is only supported on linux. On other platforms, it will
100           be ignored.
101

SEE ALSO

103       aerc(1) aerc-config(5)
104

AUTHORS

106       Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
107       Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
108       tributors. For more information about aerc development, see
109       https://sr.ht/~rjarry/aerc/.
110
111
112
113                                  2022-06-18                      aerc-imap(5)
Impressum