Skip to content

Commit e10aa2f

Browse files
committed
imapc_sasl_mechanisms: Document supported values
1 parent 5e594b2 commit e10aa2f

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

data/settings.js

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6545,7 +6545,7 @@ This setting is used to limit maximum memory usage.`
65456545

65466546
imapc_password: {
65476547
tags: [ 'imapc' ],
6548-
seealso: [ 'imapc_master_user', 'imapc_user' ],
6548+
seealso: [ 'imapc_master_user', 'imapc_user', 'imapc_sasl_mechanisms' ],
65496549
values: setting_types.STRING,
65506550
text: `
65516551
The authentication password for the remote IMAP server.
@@ -6583,7 +6583,23 @@ imapc_sasl_mechanisms {
65836583
plain = yes
65846584
login = yes
65856585
}
6586-
\`\`\``
6586+
\`\`\`
6587+
6588+
Supported mechanisms are:
6589+
6590+
* ANONYMOUS
6591+
* EXTERNAL
6592+
* LOGIN
6593+
* OAUTHBEARER
6594+
* PLAIN
6595+
* SCRAM-SHA-1
6596+
* SCRAM-SHA-1-PLUS
6597+
* SCRAM-SHA-256
6598+
* SCRAM-SHA-256-PLUS
6599+
* XOAUTH2
6600+
6601+
Note that [[setting,imapc_password]] is ignored for \`ANONYMOUS\` and \`EXTERNAL\` mechanisms.
6602+
For \`OAUTHBEARER\` and \`XOAUTH2\` [[setting,imapc_password]] should be bearer token.`
65876603
},
65886604

65896605
imapc_ssl: {
@@ -6622,7 +6638,7 @@ Only used if [[setting,imapc_ssl]] is enabled.`
66226638

66236639
imapc_user: {
66246640
tags: [ 'imapc', 'imapc-auth' ],
6625-
seealso: [ 'imapc_master_user', 'imapc_password' ],
6641+
seealso: [ 'imapc_master_user', 'imapc_password', 'imapc_sasl_mechanisms' ],
66266642
values: setting_types.STRING,
66276643
default: '%{owner_user}',
66286644
text: `

0 commit comments

Comments
 (0)