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.

Sign up for GitHub

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

Jump to bottom

feature: html email templates #14

Merged
merged 41 commits into from
Nov 27, 2024
Merged

feature: html email templates #14

merged 41 commits into from
Nov 27, 2024

Conversation

lucasmenendez
Copy link
Contributor

@lucasmenendez lucasmenendez commented Sep 19, 2024 •
edited
Loading

It includes the support to send email notifications using HTML templates. Now there are 3 templates available:

  • Email verification.
  • Password recovery.
  • Admins invites.

And one more that will be included in the future:

  • Welcome (to be sent after account verification).

@lucasmenendez
initial wrappers to email and sms notifications via sendgrid and twilio
395ba81
@lucasmenendez
initial db methods and api endpoints for email verification
b8ce4a1
@lucasmenendez
working flow
419a2c2
@lucasmenendez
db and api tests
ed27295
@lucasmenendez
fixing linter issues
ac0f926
@lucasmenendez
fix error in api docs
18a440a
@lucasmenendez
fixing linter issues
41ac833
@lucasmenendez
support from and name flags and env vars for mail service
b8cfc91
@lucasmenendez
allowing to verify users with no code if email service is not defined…
351401c 
… (for testing)
@lucasmenendez
new endpoints to request a password recovery and reset user password
345d687
@lucasmenendez
api test for recover and reset password
76846dc
@lucasmenendez
Merge branch 'main' into f/notifications
1a44cd8
@lucasmenendez
Merge branch 'main' into f/notifications
281210e
@lucasmenendez
Merge branch 'main' into f/notifications
25efea9
@lucasmenendez
initial templates for email verification
33b16d3
@lucasmenendez
include sms support in the API layer, some db methods moved between u…
0f9730a 
…sers and verifications packages
@lucasmenendez
Merge branch 'f/notifications' into f/email_templates
2f1cd17
@lucasmenendez
misspelling
e91a4e1
@lucasmenendez
fixing docker compose
e4aaee2
@lucasmenendez
move .env to example.env
e7d59e0
@lucasmenendez
add gitignore
40047bd
@lucasmenendez
Merge branch 'f/notifications' into f/email_templates
d69af69
@lucasmenendez
prevent to block backend when a sms is send, create a internal utils …
0c29f0e 
…to include some internal helpers like email format verification, password hashing or random generation
@lucasmenendez
move sendUserCode method from helpers to users
45d0945
@lucasmenendez
Merge branch 'f/notifications' into f/email_templates
531389a
@lucasmenendez
Merge branch 'main' into f/email_templates
9b01cf8
@lucasmenendez lucasmenendez added the enhancement New feature or request label Sep 19, 2024
@lucasmenendez lucasmenendez self-assigned this Sep 19, 2024
@lucasmenendez lucasmenendez mentioned this pull request Sep 24, 2024
Merged
@lucasmenendez lucasmenendez marked this pull request as ready for review November 20, 2024 12:34
emmdim
emmdim requested changes Nov 20, 2024
View reviewed changes
api/helpers.go Outdated Show resolved Hide resolved
api/const.go Outdated Show resolved Hide resolved
api/users.go Outdated Show resolved Hide resolved
api/helpers.go Outdated Show resolved Hide resolved
@emmdim
Copy link
Member

emmdim commented Nov 20, 2024 •
edited
Loading

Testing the verification flow locally (using the default flags) an email arrived to me that looked correct but the link for the verification (both in HTML and plain text ) is this one:
http://url5778.vocdoni.app/ls/click?upn=u001.OhvMA-2F6-2Fw3SL5oZpOtuifAFj04rAGDzgvNaa2a2UTdW8XDYnR7JbPfgnOtPvZPCnSKAt9NJQlV1DZ0XLV0nNyBiQS3jCPEEiNKOr2rY4kDXUK6c-2F6sQEo18AjgGwfuEwoWrQ_Pdp45fVKBUD-2FrUngFeZ82jaXTmd7xv59CoyPA7B58mVUzwTQEPO6x-2BUlNe-2FtyETj79B3ZAL-2Brlg35xoaY0r8nVLjXidYhCG2bHW4eiYVvcPnVw65qmIdBgYXx3QLeLFwdX4BAdUa6yi1o9ulqljpY9eKUE1-2BdtLS3EIjJTAATE7-2Bo-2FjIKb7TBCwO9r8NAk6fAECWanVT-2F2psoI33qyXpCw-3D-3D
What is this?

More importantly did you test the PR?

@lucasmenendez
Copy link
Contributor Author

Testing the verification flow locally (using the default flags) an email arrived to me that looked correct but the link for the verification (both in HTML and plain text ) is this one: http://url5778.vocdoni.app/ls/click?upn=u001.OhvMA-2F6-2Fw3SL5oZpOtuifAFj04rAGDzgvNaa2a2UTdW8XDYnR7JbPfgnOtPvZPCnSKAt9NJQlV1DZ0XLV0nNyBiQS3jCPEEiNKOr2rY4kDXUK6c-2F6sQEo18AjgGwfuEwoWrQ_Pdp45fVKBUD-2FrUngFeZ82jaXTmd7xv59CoyPA7B58mVUzwTQEPO6x-2BUlNe-2FtyETj79B3ZAL-2Brlg35xoaY0r8nVLjXidYhCG2bHW4eiYVvcPnVw65qmIdBgYXx3QLeLFwdX4BAdUa6yi1o9ulqljpY9eKUE1-2BdtLS3EIjJTAATE7-2Bo-2FjIKb7TBCwO9r8NAk6fAECWanVT-2F2psoI33qyXpCw-3D-3D What is this?

More importantly did you test the PR?

Yes, I noticed that, but I think it is something on the Mailchimp side, when you click or paste the link in the address bar, it is redirected to the correct location, including the correct parameters.

@emmdim
Copy link
Member

emmdim commented Nov 21, 2024

Testing the verification flow locally (using the default flags) an email arrived to me that looked correct but the link for the verification (both in HTML and plain text ) is this one: http://url5778.vocdoni.app/ls/click?upn=u001.OhvMA-2F6-2Fw3SL5oZpOtuifAFj04rAGDzgvNaa2a2UTdW8XDYnR7JbPfgnOtPvZPCnSKAt9NJQlV1DZ0XLV0nNyBiQS3jCPEEiNKOr2rY4kDXUK6c-2F6sQEo18AjgGwfuEwoWrQ_Pdp45fVKBUD-2FrUngFeZ82jaXTmd7xv59CoyPA7B58mVUzwTQEPO6x-2BUlNe-2FtyETj79B3ZAL-2Brlg35xoaY0r8nVLjXidYhCG2bHW4eiYVvcPnVw65qmIdBgYXx3QLeLFwdX4BAdUa6yi1o9ulqljpY9eKUE1-2BdtLS3EIjJTAATE7-2Bo-2FjIKb7TBCwO9r8NAk6fAECWanVT-2F2psoI33qyXpCw-3D-3D What is this?
More importantly did you test the PR?

Yes, I noticed that, but I think it is something on the Mailchimp side, when you click or paste the link in the address bar, it is redirected to the correct location, including the correct parameters.

No it doesn't :-P

@lucasmenendez
Copy link
Contributor Author

Testing the verification flow locally (using the default flags) an email arrived to me that looked correct but the link for the verification (both in HTML and plain text ) is this one: http://url5778.vocdoni.app/ls/click?upn=u001.OhvMA-2F6-2Fw3SL5oZpOtuifAFj04rAGDzgvNaa2a2UTdW8XDYnR7JbPfgnOtPvZPCnSKAt9NJQlV1DZ0XLV0nNyBiQS3jCPEEiNKOr2rY4kDXUK6c-2F6sQEo18AjgGwfuEwoWrQ_Pdp45fVKBUD-2FrUngFeZ82jaXTmd7xv59CoyPA7B58mVUzwTQEPO6x-2BUlNe-2FtyETj79B3ZAL-2Brlg35xoaY0r8nVLjXidYhCG2bHW4eiYVvcPnVw65qmIdBgYXx3QLeLFwdX4BAdUa6yi1o9ulqljpY9eKUE1-2BdtLS3EIjJTAATE7-2Bo-2FjIKb7TBCwO9r8NAk6fAECWanVT-2F2psoI33qyXpCw-3D-3D What is this?
More importantly did you test the PR?

Yes, I noticed that, but I think it is something on the Mailchimp side, when you click or paste the link in the address bar, it is redirected to the correct location, including the correct parameters.

No it doesn't :-P

I swear to God it does:

image

@emmdim
Copy link
Member

emmdim commented Nov 21, 2024

Testing the verification flow locally (using the default flags) an email arrived to me that looked correct but the link for the verification (both in HTML and plain text ) is this one: http://url5778.vocdoni.app/ls/click?upn=u001.OhvMA-2F6-2Fw3SL5oZpOtuifAFj04rAGDzgvNaa2a2UTdW8XDYnR7JbPfgnOtPvZPCnSKAt9NJQlV1DZ0XLV0nNyBiQS3jCPEEiNKOr2rY4kDXUK6c-2F6sQEo18AjgGwfuEwoWrQ_Pdp45fVKBUD-2FrUngFeZ82jaXTmd7xv59CoyPA7B58mVUzwTQEPO6x-2BUlNe-2FtyETj79B3ZAL-2Brlg35xoaY0r8nVLjXidYhCG2bHW4eiYVvcPnVw65qmIdBgYXx3QLeLFwdX4BAdUa6yi1o9ulqljpY9eKUE1-2BdtLS3EIjJTAATE7-2Bo-2FjIKb7TBCwO9r8NAk6fAECWanVT-2F2psoI33qyXpCw-3D-3D What is this?
More importantly did you test the PR?

Yes, I noticed that, but I think it is something on the Mailchimp side, when you click or paste the link in the address bar, it is redirected to the correct location, including the correct parameters.

No it doesn't :-P

I swear to God it does:

image

Hm, but I think there is my + missing in the email there...

@lucasmenendez
include plain version when html body is defined in smtp emails, new n…
223ffa2 
…otification flag to enable or disable link tracking (using filters in X-SMTPAPI header), issues with query params encoding fixed
@lucasmenendez lucasmenendez marked this pull request as draft November 21, 2024 12:08
@lucasmenendez lucasmenendez marked this pull request as ready for review November 21, 2024 17:22
@lucasmenendez
moving all the mail templates stuff to notification package
b9d41d0
@lucasmenendez
generateVerificationCode reimplemented to a generic method to generat…
3a7ebdb 
…e a verification code and link for any kind of database code type, org invite verification code included
@lucasmenendez lucasmenendez merged commit 2ff488e into main Nov 27, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emmdim emmdim emmdim approved these changes

Assignees

@lucasmenendez lucasmenendez

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lucasmenendez @emmdim