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

SEE ALSO

68       aerc(1) aerc-config(5)
69

AUTHORS

71       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
72       open source contributors. For more information about aerc development,
73       see https://git.sr.ht/~sircmpwn/aerc.
74
75
76
77                                  2021-07-21                      aerc-imap(5)