The email HTML templates added #6146 #6147

2403905 · 2023-04-26T10:15:43Z

Description

The email HTML templates has been added to the notifications service.
The built-in templates can be replaced with custom.

Related Issue

Fixes <issue_link>

Motivation and Context

How Has This Been Tested?

test environment: local
tested manually via inbucket

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Technical debt
Tests only (no source changes)

Checklist:

Code changes
Unit tests added
Acceptance tests added
Documentation ticket raised:

update-docs · 2023-04-26T10:15:47Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

mmattel · 2023-04-26T14:53:47Z

@2403905 this needs an update in README.md in section Email Notification Templates. See how it is rendered atm.

ownclouders · 2023-04-27T14:00:38Z

💥 Acceptance test Core-API-Tests-ocis-storage-10 failed. Further test are cancelled...

2403905 · 2023-04-27T15:13:50Z

@micbar @kobergj Do we need to have the multiple html templates for each kind of message or it can be a single one?
After we move the content to the transifex the templates became very similar.

kobergj

Some suggestions

services/notifications/README.md

kobergj · 2023-04-28T09:53:16Z

services/notifications/pkg/email/email.go

+	var data map[string][]byte
+	data, err = readImages(emailTemplatePath)
 	if err != nil {
-		return "", "", err
+		data, err = readFs()
+		if err != nil {
+			return nil, err
+		}


I don't like the try/catch logic. Two possible alternatives:

(1) Simple Solution: check emailTemplatePath == "" and use readFS if true, otherwise readImages

(2) Master Solution: Make RenderEmailTemplate use an fs.FS instead the emailTemplatePath. On service start create a fs.FS either using templatesFS or os.DirFS(emailTemplatePath)

Sure, I'll change it. I just followed the current approach https://github.com/owncloud/ocis/blob/master/services/notifications/pkg/email/email.go#L49

That's not nice either 😄 Let's do it correctly here.

@kobergj done. These changes impacted the email Template Path and now it shouldn't contain the templates subdirectory. The reason why it happened was the templatesFS contains templates and no way to get the subdirectory for the embed FS. Is it ok?

The NOTIFICATIONS_EMAIL_TEMPLATE_PATH will be like this

{NOTIFICATIONS_EMAIL_TEMPLATE_PATH}/templates/text/email.text.tmpl {NOTIFICATIONS_EMAIL_TEMPLATE_PATH}/templates/html/email.html.tmpl

@micbar @kobergj @dragonchaser are you ok with it?
I updated the readme

services/notifications/pkg/email/email.go

services/notifications/pkg/email/templates.go

services/notifications/pkg/service/service.go

mmattel · 2023-04-28T10:36:20Z

services/notifications/README.md

@@ -35,6 +43,7 @@ templates
 ```

 Custom email templates referenced via `NOTIFICATIONS_EMAIL_TEMPLATE_PATH` must also be located in subfolders `shares` and `spaces` and must have the same names as the embedded templates. It is important that the names of these files and  folders match the embedded ones.
+In the subfolder `html` contains a default HTML template provided by ocis. The images can be embedded in a custom HTML template as a CID source ```<img src="cid:logo-mail.gif" alt="logo-mail"/>``` The image files should be located in `html/img` subfolder. Supported image types are png, jpeg, and gif.


Suggested change

In the subfolder `html` contains a default HTML template provided by ocis. The images can be embedded in a custom HTML template as a CID source ```<img src="cid:logo-mail.gif" alt="logo-mail"/>``` The image files should be located in `html/img` subfolder. Supported image types are png, jpeg, and gif.

The `html` subfolder contains a default HTML template provided by ocis. When using a custom HTML template, images can either be linked with standard HTML code or embedded as a CID source ```<img src="cid:logo-mail.gif" alt="logo-mail"/>``` In the latter case, image files must be located in the `html/img` subfolder. Supported image types are png, jpeg, and gif.

What about svg images, are we open for this when embedding?
Note that I have read (and I may be wrong) that embedding images via CID can cause issues_1 or issues_2 in web clients. Should we drop a note here? like:
Consider that embedding images via a CID resource may not be fully supported in all email web clients.

@mmattel Good points

We do not support svg when embedding.

Let's make a notice about embedding and add that hosted images source are also available like <img src="https://raw.githubusercontent.com/owncloud/core/master/core/img/logo-mail.gif" alt="logo-mail"/>
Or better make the hosted images as a default way?
BTW How it works in ownCloud 10?
FYI @kobergj @micbar

Or better make the hosted images as a default way?

CID linking is ok then admins can see how that has to look like.
Embedding via standard html is imho commonly known.

mmattel · 2023-04-28T10:39:29Z

Note that the blank line 23 in readme.md (between the list items) could be removed. I cant make a suggestable commit...

services/notifications/README.md

services/notifications/pkg/channels/channels.go

services/notifications/README.md

Julian is on vacation 😄

micbar

I agree with the suggestions.

All in all it looks really awesome to me. Thank you @2403905

mmattel

OK from the docs pov

Co-authored-by: Martin <github@diemattels.at>

sonarcloud · 2023-05-03T08:20:49Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
3 Vulnerabilities
0 Security Hotspots
3 Code Smells

18.9% Coverage
0.0% Duplication

* The email HTML templates added #6146 * use a single palne text email template. use fs.FS * Update services/notifications/README.md Co-authored-by: Martin <github@diemattels.at> * Update services/notifications/README.md Co-authored-by: Martin <github@diemattels.at> * fix md --------- Co-authored-by: Roman Perekhod <rperekhod@owncloud.com> Co-authored-by: Martin <github@diemattels.at>

2403905 force-pushed the issue-6146 branch 2 times, most recently from 7ceab9b to 53c2455 Compare April 27, 2023 13:49

2403905 force-pushed the issue-6146 branch from 53c2455 to 99c26fe Compare April 27, 2023 14:47

2403905 force-pushed the issue-6146 branch 3 times, most recently from e6bf6aa to 8f94a45 Compare April 27, 2023 22:17

2403905 marked this pull request as ready for review April 28, 2023 08:37

kobergj previously requested changes Apr 28, 2023

View reviewed changes

mmattel reviewed Apr 28, 2023

View reviewed changes

mmattel mentioned this pull request May 2, 2023

Update notifications with HTML based eMail templates owncloud/docs-ocis#482

Closed

2403905 force-pushed the issue-6146 branch from 5179b91 to 1708708 Compare May 2, 2023 08:32

dragonchaser requested changes May 2, 2023

View reviewed changes

services/notifications/README.md Outdated Show resolved Hide resolved

services/notifications/pkg/channels/channels.go Show resolved Hide resolved

2403905 force-pushed the issue-6146 branch 3 times, most recently from b82cf3d to 7724950 Compare May 2, 2023 16:15

mmattel reviewed May 2, 2023

View reviewed changes

services/notifications/README.md Outdated Show resolved Hide resolved

mmattel reviewed May 2, 2023

View reviewed changes

services/notifications/README.md Outdated Show resolved Hide resolved

micbar approved these changes May 2, 2023

View reviewed changes

micbar requested a review from dragonchaser May 2, 2023 18:57

dragonchaser approved these changes May 3, 2023

View reviewed changes

mmattel approved these changes May 3, 2023

View reviewed changes

2403905 and others added 3 commits May 3, 2023 10:02

The email HTML templates added owncloud#6146

95b7999

use a single palne text email template. use fs.FS

e761e04

Update services/notifications/README.md

c3a91a3

Co-authored-by: Martin <github@diemattels.at>

2403905 and others added 2 commits May 3, 2023 10:02

Update services/notifications/README.md

9df83cd

Co-authored-by: Martin <github@diemattels.at>

fix md

7d7cecf

2403905 force-pushed the issue-6146 branch from 195d3ba to 7d7cecf Compare May 3, 2023 08:12

2403905 merged commit 27322c5 into owncloud:master May 3, 2023

mmattel mentioned this pull request May 3, 2023

Update notifications service email description owncloud/docs-ocis#485

Merged

micbar mentioned this pull request May 3, 2023

Release 3.0.0 RC1 #6105

Closed

89 tasks

ScharfViktor mentioned this pull request May 4, 2023

Release 3.0.0 RC4, RC5 and final #6230

Closed

86 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The email HTML templates added #6146 #6147

The email HTML templates added #6146 #6147

2403905 commented Apr 26, 2023

update-docs bot commented Apr 26, 2023

mmattel commented Apr 26, 2023 •

edited

Loading

ownclouders commented Apr 27, 2023

2403905 commented Apr 27, 2023 •

edited

Loading

kobergj left a comment

kobergj Apr 28, 2023

2403905 Apr 28, 2023

kobergj Apr 28, 2023

2403905 May 2, 2023 •

edited

Loading

2403905 May 2, 2023

mmattel Apr 28, 2023 •

edited

Loading

2403905 May 2, 2023

mmattel May 2, 2023

mmattel commented Apr 28, 2023

micbar left a comment

mmattel left a comment

sonarcloud bot commented May 3, 2023

	In the subfolder `html` contains a default HTML template provided by ocis. The images can be embedded in a custom HTML template as a CID source ```<img src="cid:logo-mail.gif" alt="logo-mail"/>``` The image files should be located in `html/img` subfolder. Supported image types are png, jpeg, and gif.
	The `html` subfolder contains a default HTML template provided by ocis. When using a custom HTML template, images can either be linked with standard HTML code or embedded as a CID source ```<img src="cid:logo-mail.gif" alt="logo-mail"/>``` In the latter case, image files must be located in the `html/img` subfolder. Supported image types are png, jpeg, and gif.

The email HTML templates added #6146 #6147

The email HTML templates added #6146 #6147

Conversation

2403905 commented Apr 26, 2023

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

update-docs bot commented Apr 26, 2023

mmattel commented Apr 26, 2023 • edited Loading

ownclouders commented Apr 27, 2023

2403905 commented Apr 27, 2023 • edited Loading

kobergj left a comment

Choose a reason for hiding this comment

kobergj Apr 28, 2023

Choose a reason for hiding this comment

2403905 Apr 28, 2023

Choose a reason for hiding this comment

kobergj Apr 28, 2023

Choose a reason for hiding this comment

2403905 May 2, 2023 • edited Loading

Choose a reason for hiding this comment

2403905 May 2, 2023

Choose a reason for hiding this comment

mmattel Apr 28, 2023 • edited Loading

Choose a reason for hiding this comment

2403905 May 2, 2023

Choose a reason for hiding this comment

mmattel May 2, 2023

Choose a reason for hiding this comment

mmattel commented Apr 28, 2023

micbar left a comment

Choose a reason for hiding this comment

mmattel left a comment

Choose a reason for hiding this comment

sonarcloud bot commented May 3, 2023

mmattel commented Apr 26, 2023 •

edited

Loading

2403905 commented Apr 27, 2023 •

edited

Loading

2403905 May 2, 2023 •

edited

Loading

mmattel Apr 28, 2023 •

edited

Loading