libre.sh/keycloak-scim
2
0
Fork 0
Code Issues 14 Pull requests Releases Packages Activity Actions 6

Merge pull request #43 from thomasdarimont/issue/42-document-new-email-settings-3.0.0

Browse source 
42 - Document new email settings
This commit is contained in:
Stian Thorgersen 2017-04-06 15:34:50 +02:00 committed by GitHub
commit c19a3a0d4a
2 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
server_admin/images/email-simple-example.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 39 KiB

21
server_admin/topics/realms/email.adoc
View file

@ -11,6 +11,27 @@ item and click the `Email` tab.
.Email Tab
image:../../{{book.images}}/email-tab.png[]
Host::
`Host` denotes the SMTP server hostname used for sending emails.
Port::
`Port` denotes the SMTP server port.
From::
`From` denotes the address used for the `From` SMTP-Header for the emails sent.
From Display Name::
`From Display Name` allows to configure an user friendly email address aliases (optional). If not set the plain `From` email address will be displayed in email clients.
Reply To::
`Reply To` denotes the address used for the `Reply-To` SMTP-Header for the mails sent (optional). If not set the plain `From` email address will be used.
Reply To Display Name::
`Reply To Display Name` allows to configure an user friendly email address aliases (optional). If not set the plain `Reply To` email address will be displayed.
Envelope From::
`Envelope From` denotes the https://en.wikipedia.org/wiki/Bounce_address[Bounce Address] used for the `Return-Path` SMTP-Header for the mails sent (optional).
As emails are used for recovering usernames and passwords it's recommended to use SSL or TLS, especially if the SMTP server is on an external network.
To enable SSL click on `Enable SSL` or to enable TLS click on `Enable TLS`.
You will most likely also need to change the `Port` (the default port for SSL/TLS is 465).