3.5. 为域配置电子邮件
Red Hat build of Keycloak 将电子邮件发送到用户,以便在他们忘记其密码时验证其电子邮件地址,或者当管理员需要接收服务器事件通知时。要启用红帽构建的 Keycloak 来发送电子邮件,您可以为红帽构建的 Keycloak 提供 SMTP 服务器设置。
流程
- 单击菜单中的 Realm settings。
单击 Email 选项卡。
电子邮件标签页
- 填写字段并根据需要切换切换。
模板
- from
- From 表示用于发送的电子邮件的 From SMTP 标头使用的地址。
- 从 显示名称
- 从显示名称 中,可以配置用户友好的电子邮件地址别名(可选)。如果没有设置 plain From 电子邮件地址,则会在电子邮件客户端中显示。
- 回复
- reply 表示用于 Reply-To SMTP-Header 用于邮件发送的地址(可选)。如果没有设置普通 地址,则将使用电子邮件地址。
- 回复显示名称
- 通过 回复显示名称,可以配置用户友好的电子邮件地址别名(可选)。如果没有设置普通 Reply To 电子邮件地址,则会显示。
- 信封 from
- 中的信封表示用于 发送邮件的 返回路径 SMTP- Header 的 Bounce 地址(可选)。
连接和验证
- Host
- host 表示用于发送电子邮件的 SMTP 服务器主机名。
- 端口
- port 表示 SMTP 服务器端口。
- Encryption
- 选择其中一个复选框来支持发送电子邮件以恢复用户名和密码,特别是当 SMTP 服务器位于外部网络上时。您可能需要将端口更改为 465,这是 SSL/TLS 的默认端口。
- 身份验证
- 如果您的 SMTP 服务器需要身份验证,请将此开关设置为 ON。
- 用户名
- 所有 authentication-mechanisms 都需要一个用户名。
- 身份验证类型
- 选择验证类型: 'password' 或 'token'。
- 密码
- 仅在选择 Authentication Type 'password' 时才需要。提供密码 。Password 字段的值可以引用来自外部 vault 的值。
- Auth Token URL
- 仅在选择了 Authentication Type 'token' 时才需要。提供用于通过客户端凭据授权获取令牌的 Auth Token URL。
- 验证令牌范围
- 仅在选择了 Authentication Type 'token' 时才需要。提供用于从 Auth Token URL 获取令牌的 Auth Token Scope。
- Auth Token ClientId
- 仅在选择了 Authentication Type 'token' 时才需要。提供用于从 Auth Token URL 获取令牌的 Auth ClientId。
- Auth Token Client Secret
- 仅在选择了 Authentication Type 'token' 时才需要。提供 Auth Client Secret,验证客户端以从 Auth Token URL 获取令牌。Auth Client Secret 字段的值可以引用来自外部 vault 的值。
- 允许 UTF-8
在将地址发送到服务器时,启用到 UTF-8-encode 电子邮件地址。只有邮件服务器通过 SMTPUTF8 扩展支持 UTF-8 时,才会启用此设置。如果禁用,则包含非 ASCII 字符的域名将使用 punycode 进行编码,并且地址中包含非 ASCIII 字符的地址将返回错误。
如果没有启用这个选项,请采取额外的措施来防止用户电子邮件地址中的非 ASCII 字符:
- 验证现有用户没有电子邮件地址在电子邮件地址的本地部分没有非 ASCII 字符。
-
更新电子邮件地址的验证以防止电子邮件地址的本地部分中的非 ASCII 字符,例如,在用户配置集中为类似于
\p{ASCII}*@
documented 的错误消息,与地址的Local 部分类似的错误消息必须只包含 ASCII 字符
。