Custom Email Templates #45

Open
leah wants to merge 9 commits from feature/custom-email-template into main
Owner

image

image

Adds the ability to specify a custom email template using handlebars syntax.

#42

![image](/attachments/bce3a0dd-3a25-46ea-9376-66049896563b) ![image](/attachments/9a3a77ba-bcaf-49df-90c3-5a4ee2e86c08) Adds the ability to specify a custom email template using handlebars syntax. #42
leah added 2 commits 2025-01-19 14:51:29 +00:00
add ability to customize email template
All checks were successful
API report (misskey.js) / report (push) Successful in 3m24s
287306a475
remove comments in template
Some checks failed
API report (misskey.js) / report (pull_request) Successful in 2m45s
Lint / pnpm_install (pull_request) Successful in 2m24s
Test (backend) / unit (22.x) (pull_request) Successful in 7m23s
Test (backend) / e2e (22.x) (pull_request) Failing after 8m27s
Test (frontend) / vitest (22.x) (pull_request) Successful in 3m0s
Test (misskey.js) / test (22.x) (pull_request) Successful in 2m48s
Test (production install and build) / production (22.x) (pull_request) Successful in 3m21s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 3m28s
Lint / lint (backend) (pull_request) Failing after 2m10s
Lint / lint (frontend) (pull_request) Successful in 9m22s
Lint / lint (misskey-js) (pull_request) Successful in 2m34s
Lint / lint (sw) (pull_request) Successful in 2m28s
Lint / typecheck (backend) (pull_request) Failing after 1m53s
Lint / typecheck (misskey-js) (pull_request) Successful in 2m13s
cc7def7593
leah added 1 commit 2025-01-19 14:54:13 +00:00
fix grammar
Some checks failed
API report (misskey.js) / report (pull_request) Successful in 2m39s
Lint / pnpm_install (pull_request) Successful in 2m37s
Test (backend) / unit (22.x) (pull_request) Successful in 7m28s
Test (backend) / e2e (22.x) (pull_request) Failing after 8m30s
Test (frontend) / vitest (22.x) (pull_request) Successful in 3m9s
Test (misskey.js) / test (22.x) (pull_request) Successful in 3m3s
Test (production install and build) / production (22.x) (pull_request) Successful in 2m52s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 3m5s
Lint / lint (backend) (pull_request) Failing after 2m1s
Lint / lint (frontend) (pull_request) Successful in 9m35s
Lint / lint (misskey-js) (pull_request) Successful in 3m13s
Lint / lint (sw) (pull_request) Successful in 2m31s
Lint / typecheck (backend) (pull_request) Failing after 2m15s
Lint / typecheck (misskey-js) (pull_request) Successful in 2m32s
139341d866
First-time contributor

Is there a plaintext fallback?

Is there a plaintext fallback?
leah changed title from Custom Email Teplates to Custom Email Templates 2025-01-19 16:54:05 +00:00
Author
Owner

Is there a plaintext fallback?

Im not sure what you mean. If none is specified it will use a default which is close to what misskey has as the default. When you first edit this field it will be filled with the default config so you have a good base to start with.

Uhh also its handlebars so you technically can write it in plaintext but you wont get any style and it will probably smash it all on one line. If you want to strip the style though you can do that but I dont suggest using plaintext.

If you do plaintext like so:

{{ subject }}

{{ html }}

{{ emailSettingUrl }}

it looks like
image

in short it technically works to some extent but is also not the purpose of this. Its meant for allowing you to customize the style of your email.

> Is there a plaintext fallback? Im not sure what you mean. If none is specified it will use a default which is close to what misskey has as the default. When you first edit this field it will be filled with the default config so you have a good base to start with. Uhh also its handlebars so you technically can write it in plaintext but you wont get any style and it will probably smash it all on one line. If you want to strip the style though you can do that but I dont suggest using plaintext. If you do plaintext like so: ``` {{ subject }} {{ html }} {{ emailSettingUrl }} ``` it looks like ![image](/attachments/941c6e55-5592-48c0-accd-ab8993cc8df7) in short it technically works to some extent but is also not the purpose of this. Its meant for allowing you to customize the style of your email.
leah added 1 commit 2025-01-19 17:16:26 +00:00
added canIEmail help so people can check if the elements used are email supported
Some checks failed
API report (misskey.js) / report (pull_request) Successful in 2m39s
Lint / pnpm_install (pull_request) Successful in 2m12s
Test (backend) / unit (22.x) (pull_request) Successful in 7m4s
Test (backend) / e2e (22.x) (pull_request) Failing after 8m26s
Test (frontend) / vitest (22.x) (pull_request) Successful in 3m14s
Test (misskey.js) / test (22.x) (pull_request) Successful in 2m53s
Test (production install and build) / production (22.x) (pull_request) Successful in 2m47s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 4m31s
Lint / lint (backend) (pull_request) Failing after 2m21s
Lint / lint (frontend) (pull_request) Failing after 8m34s
Lint / lint (misskey-js) (pull_request) Successful in 2m22s
Lint / lint (sw) (pull_request) Successful in 2m10s
Lint / typecheck (backend) (pull_request) Failing after 2m47s
Lint / typecheck (misskey-js) (pull_request) Successful in 3m0s
6d3c66f8c1
leah added 1 commit 2025-01-19 17:17:05 +00:00
remove commented code
Some checks failed
API report (misskey.js) / report (pull_request) Successful in 2m25s
Lint / pnpm_install (pull_request) Successful in 2m27s
Test (backend) / unit (22.x) (pull_request) Successful in 7m8s
Test (backend) / e2e (22.x) (pull_request) Successful in 9m40s
Test (frontend) / vitest (22.x) (pull_request) Successful in 3m13s
Test (misskey.js) / test (22.x) (pull_request) Successful in 2m30s
Test (production install and build) / production (22.x) (pull_request) Successful in 2m36s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 3m11s
Lint / lint (backend) (pull_request) Failing after 2m23s
Lint / lint (frontend) (pull_request) Failing after 8m23s
Lint / lint (misskey-js) (pull_request) Successful in 2m43s
Lint / lint (sw) (pull_request) Successful in 2m16s
Lint / typecheck (backend) (pull_request) Failing after 3m48s
Lint / typecheck (misskey-js) (pull_request) Successful in 2m11s
b8a938ace8
First-time contributor

Sorry, I maybe needed to say it better
Does it also send a plaintext fallback in the email, or does it only send the html? Like if my email client doesn't support html, or for accessibility/privacy reasons I have html disabled in the client, do I still get something to see, or is it just empty?

Sorry, I maybe needed to say it better Does it also send a plaintext fallback in the email, or does it only send the html? Like if my email client doesn't support html, or for accessibility/privacy reasons I have html disabled in the client, do I still get something to see, or is it just empty?
Author
Owner

Sorry, I maybe needed to say it better
Does it also send a plaintext fallback in the email, or does it only send the html? Like if my email client doesn't support html, or for accessibility/privacy reasons I have html disabled in the client, do I still get something to see, or is it just empty?

usually those providers will strip the content of the HTML and make it plaintext so I assume it should be fine?

> Sorry, I maybe needed to say it better > Does it also send a plaintext fallback in the email, or does it only send the html? Like if my email client doesn't support html, or for accessibility/privacy reasons I have html disabled in the client, do I still get something to see, or is it just empty? > usually those providers will strip the content of the HTML and make it plaintext so I assume it should be fine?
leah added 1 commit 2025-02-03 15:09:20 +00:00
fix linter issues
Some checks failed
API report (misskey.js) / report (pull_request) Successful in 2m40s
Test (backend) / unit (22.x) (pull_request) Successful in 3m59s
Test (frontend) / vitest (22.x) (pull_request) Successful in 1m43s
Test (misskey.js) / test (22.x) (pull_request) Successful in 1m8s
Test (production install and build) / production (22.x) (pull_request) Successful in 1m20s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 2m1s
Test (backend) / e2e (22.x) (pull_request) Successful in 6m56s
Lint / pnpm_install (pull_request) Successful in 3m48s
Lint / lint (backend) (pull_request) Successful in 1m31s
Lint / lint (misskey-js) (pull_request) Successful in 1m47s
Lint / lint (sw) (pull_request) Successful in 1m22s
Lint / typecheck (misskey-js) (pull_request) Successful in 1m45s
Lint / lint (frontend) (pull_request) Successful in 8m54s
Lint / typecheck (backend) (pull_request) Failing after 1m14s
1090365cc0
leah added 1 commit 2025-02-04 17:08:25 +00:00
fix missing thing
All checks were successful
Lint / lint (sw) (pull_request) Has been skipped
Lint / typecheck (misskey-js) (pull_request) Has been skipped
Lint / lint (misskey-js) (pull_request) Has been skipped
Test (production install and build) / production (22.x) (pull_request) Successful in 3m19s
Test (misskey.js) / test (22.x) (pull_request) Successful in 3m24s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 4m5s
Lint / pnpm_install (pull_request) Successful in 1m18s
Check Misskey JS version / Check version (pull_request) Successful in 45s
Test (frontend) / vitest (22.x) (pull_request) Successful in 2m4s
API report (misskey.js) / report (pull_request) Successful in 2m30s
Test (backend) / unit (22.x) (pull_request) Successful in 3m8s
Lint / lint (backend) (pull_request) Successful in 1m31s
Lint / typecheck (backend) (pull_request) Successful in 1m57s
Test (backend) / e2e (22.x) (pull_request) Successful in 7m53s
Lint / lint (frontend) (pull_request) Successful in 9m4s
edaf9170dd
ashten added 1 commit 2025-02-05 04:31:29 +00:00
Merge branch 'main' into feature/custom-email-template
All checks were successful
Lint / pnpm_install (pull_request) Successful in 1m56s
API report (misskey.js) / report (pull_request) Successful in 2m13s
API report (misskey.js) / report (push) Successful in 2m24s
Test (misskey.js) / test (22.x) (pull_request) Successful in 51s
Test (frontend) / vitest (22.x) (pull_request) Successful in 2m55s
Test (production install and build) / production (22.x) (pull_request) Successful in 1m5s
Lint / lint (backend) (pull_request) Successful in 1m6s
Lint / lint (misskey-js) (pull_request) Successful in 37s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 1m34s
Test (backend) / unit (22.x) (pull_request) Successful in 4m8s
Lint / lint (sw) (pull_request) Successful in 35s
Lint / typecheck (misskey-js) (pull_request) Successful in 37s
Lint / typecheck (backend) (pull_request) Successful in 1m24s
Test (backend) / e2e (22.x) (pull_request) Successful in 8m7s
Lint / lint (frontend) (pull_request) Successful in 7m46s
d08b97f7d6
ashten added 1 commit 2025-02-05 04:40:49 +00:00
Merge branch 'main' into feature/custom-email-template
All checks were successful
Lint / pnpm_install (pull_request) Successful in 37s
API report (misskey.js) / report (push) Successful in 46s
API report (misskey.js) / report (pull_request) Successful in 52s
Test (misskey.js) / test (22.x) (pull_request) Successful in 49s
Test (production install and build) / production (22.x) (pull_request) Successful in 1m4s
Test (frontend) / vitest (22.x) (pull_request) Successful in 1m21s
Test (backend) / unit (22.x) (pull_request) Successful in 2m34s
Lint / lint (misskey-js) (pull_request) Successful in 36s
Lint / lint (backend) (pull_request) Successful in 1m5s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 1m29s
Lint / lint (sw) (pull_request) Successful in 35s
Lint / typecheck (misskey-js) (pull_request) Successful in 35s
Lint / typecheck (backend) (pull_request) Successful in 1m26s
Test (backend) / e2e (22.x) (pull_request) Successful in 6m34s
Lint / lint (frontend) (pull_request) Successful in 7m23s
e2cc20d4bc
Owner

im experiencing a blank screen when i test this branch 😢

image

im experiencing a blank screen when i test this branch 😢 ![image](/attachments/02d1e350-e67a-4b6f-9e27-1100a6357efa)
Author
Owner

im experiencing a blank screen when i test this branch 😢

image

works on my machine... weird. Guess ill have a look with you on call later?

> im experiencing a blank screen when i test this branch 😢 > > ![image](/attachments/02d1e350-e67a-4b6f-9e27-1100a6357efa) works on my machine... weird. Guess ill have a look with you on call later?
All checks were successful
Lint / pnpm_install (pull_request) Successful in 37s
API report (misskey.js) / report (push) Successful in 46s
API report (misskey.js) / report (pull_request) Successful in 52s
Test (misskey.js) / test (22.x) (pull_request) Successful in 49s
Test (production install and build) / production (22.x) (pull_request) Successful in 1m4s
Test (frontend) / vitest (22.x) (pull_request) Successful in 1m21s
Test (backend) / unit (22.x) (pull_request) Successful in 2m34s
Lint / lint (misskey-js) (pull_request) Successful in 36s
Lint / lint (backend) (pull_request) Successful in 1m5s
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 1m29s
Lint / lint (sw) (pull_request) Successful in 35s
Lint / typecheck (misskey-js) (pull_request) Successful in 35s
Lint / typecheck (backend) (pull_request) Successful in 1m26s
Test (backend) / e2e (22.x) (pull_request) Successful in 6m34s
Lint / lint (frontend) (pull_request) Successful in 7m23s
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin feature/custom-email-template:feature/custom-email-template
git checkout feature/custom-email-template

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout main
git merge --no-ff feature/custom-email-template
git checkout feature/custom-email-template
git rebase main
git checkout main
git merge --ff-only feature/custom-email-template
git checkout feature/custom-email-template
git rebase main
git checkout main
git merge --no-ff feature/custom-email-template
git checkout main
git merge --squash feature/custom-email-template
git checkout main
git merge --ff-only feature/custom-email-template
git checkout main
git merge feature/custom-email-template
git push origin main
Sign in to join this conversation.
No description provided.