Ability to customize emails

[Powersource]

Of what I understand this isn't supported yet? Would it be enough to follow this or would other steps/methods be required?

[garronej]

I am not sure I understand what you mean by customising emails?
Do you mean whitelisting emails domain that are allowed to register? If it's that, it is supported.
If not what page are you referring to?

[Powersource]

I mean the emails that keycloak sends to users when they e.g. sign up and need to verify their email.

[garronej]

Ahh yeah of course, I see.

Yes this is probably something that we would like to support in the future but that is out of scope for now.

[garronej]

Note, however, that we will never be able to implement the emails in React, we can't bundle JS into emails.
If I provide a solution il will probably be based on eta...

[Powersource]

Thought about it a bit more. For our usecase we don't yet need full easy theming of the emails, being able to easily replace the "message" files at the same time as loading the rest of the theme would be enough. In our case it's keycloak/themes/customtheme/email/messages/messages_en.properties. It would be cool if we could put that in some folder of static files and then it would be inserted by keycloakify in the right location in the jar file :)

[garronej]

Agreed,
I put that in my todo list but i'll encourage you to implement an alternative solution in the meantime as I don't know when I will have the time to implement it.

[ialisyed]

Hi @Powersource,

How did you customize emails? Could you please share some insight?

TIA,
Syed

[Powersource]

@ialisyed As a first solution we just went onto the server and I think manually copied the file in there. See https://github.com/Edgeryders-Participio/multi-dreams/blob/b81caca02f190a464e4814e0c96d0bdf8ae45ddc/keycloak-theme/readme.txt#L33-L45

But now we're in the process of removing keycloak completely from our app and moving to passport instead cobudget/cobudget#321 Things like email customization being so hard and hacky, and other similar things that keycloak made more convoluted than they felt like they needed to be made us want to switch.

[garronej]

I just want to reiterate that email customisation is something that I want to support with Keycloakify eventually.

[abforman]

I did a hack to shove an email/ directory into the theme JAR by adding some commands in package.json:

"scripts": {
        "build": "react-scripts build",
        "keycloak": "yarn build && yarn emails && build-keycloak-theme && yarn emails2",
        "emails": "mkdir -p build_keycloak/src/main/resources/theme/THEME_NAME/email; cp -R email build_keycloak/src/main/resources/theme/THEME_NAME/",
        "emails2": "jar -uf ./build_keycloak/target/THEME_NAME-keycloak-theme-VERSION.jar -C . META-INF/keycloak-themes.json",
...

Both the email/ directory hierarchy and the keycloak-themes.json are just static files.

The only reason for the keycloak-themes overlay is to add "email" to the array of types so that it will show up as an entry in the drop-down.

[garronej]

It's done