Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(keycloak): Adjust verification email copy #2331

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

theosanderson
Copy link
Member

@theosanderson theosanderson commented Jul 24, 2024

Adjust email copy in the hope of avoiding spam filters

@theosanderson theosanderson added the preview Triggers a deployment to argocd label Jul 24, 2024
@corneliusroemer
Copy link
Contributor

Would be good to see what the real email looks like :)

Here are example emails that made it through Office365
Brave Browser 2024-07-24 13 14 54

image Brave Browser 2024-07-24 13 16 34 Brave Browser 2024-07-24 13 16 17 image

@corneliusroemer
Copy link
Contributor

corneliusroemer commented Jul 24, 2024

Looks like this now:
image

The genericness is on purpose because you want the text to be applicable to not just pathoplexus, right?

If we weren't constrained like that I would add:

  • Add originator in subject line
  • Personalized greeting: Hello {firstname}
  • Mention who "we" are
  • Mention what the support email is
  • Include standard footer with name, legal entity, address, etc.

Co-authored-by: Cornelius Roemer <cornelius.roemer@gmail.com>
@theosanderson
Copy link
Member Author

theosanderson commented Jul 24, 2024

Looks like this now:

Thanks for flagging the {3} - will need to fix that before merging

The genericness is on purpose because you want the text to be applicable to not just pathoplexus, right?

Yes. Also I don't know a way to add e.g. first name (I agree with what you say)

@corneliusroemer
Copy link
Contributor

The keycloakify maintainer is very receptive to Github issues with feedback/questions. I'd probably just ask there, saying we have email deliverability issues and are wondering how we can personalize copy. The docs aren't very clear on that - I guess lack of mention means it's not easy but maybe he has an idea: https://docs.keycloakify.dev/email-customization

@theosanderson
Copy link
Member Author

From a quick look recently I think the can't-include-first-name point may be built into KC

@corneliusroemer
Copy link
Contributor

corneliusroemer commented Jul 24, 2024

What about this? Might be possible to pass in extra details: https://stackoverflow.com/questions/37199200/keycloak-add-users-name-in-email-theme-template

You can add user.username in your .ftl file

open (email/text) *.ftl file and add user.username as one of the parameter like

${msg("passwordResetBody",link, linkExpiration, realmName,user.username)}
and then update actual message body at (email/messages/messages_en.properties) with parameter number like {2} or {3} (in this case it is {3} )

Also see: https://codehumsafar.wordpress.com/2018/09/24/keycloak-get-username-first-name-last-name-and-email-in-email-theme-template/

@theosanderson
Copy link
Member Author

👍 Yes that looks promising!

@theosanderson theosanderson merged commit 2d73317 into main Jul 25, 2024
11 checks passed
@theosanderson theosanderson deleted the Adjust-verification-email-copy branch July 25, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Triggers a deployment to argocd
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants