[pmg-devel] [RFC pmg-gui] fix #4311: add quarantine help-page for end-users

[Stoiko Ivanov <s.ivanov@proxmox.com>]

Having a short explanation of what the quarantine interface provides,
in the end-user interface should help users who wonder why they get
mails from some system, and what quarantine means. Instead of adding
this to the regular documentation and linking it in the top-bar as we
do in the admin-view having a short description directly rendered on
the main panel should increase the chances of it getting read.

the code is inspired by the notesview (I found it when clicking
through a PBS system of mine looking for how to address this).

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
Sending as RFC as I'm not quite sure if having this as static entry in
the GUI is a good fit. If we want to keep it this way, I'd replace the
`Proxmox.Markdown.parse` call with the rendered html.

One alternative that came to my mind while writing this is having the
markdown text in the backend as a template. This would give admins an
easy way to customize this to their needs, and provide it in their
local language.

Additionally of course feedback on the (rather terse) phrasing itself
is of course also appreciated.


 js/Makefile               |  1 +
 js/QuarantineView.js      |  8 +++++++
 js/QuarantineViewAbout.js | 44 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 js/QuarantineViewAbout.js

diff --git a/js/Makefile b/js/Makefile
index 2fb7d19..d1fab9b 100644
--- a/js/Makefile
+++ b/js/Makefile
@@ -31,6 +31,7 @@ JSSRC=							\
 	SpamQuarantine.js				\
 	UserBlackWhiteList.js				\
 	QuarantineView.js				\
+	QuarantineViewAbout.js				\
 	Dashboard.js					\
 	dashboard/MailProcessing.js			\
 	dashboard/NodeInfo.js				\
diff --git a/js/QuarantineView.js b/js/QuarantineView.js
index 5b70487..17f1847 100644
--- a/js/QuarantineView.js
+++ b/js/QuarantineView.js
@@ -1,4 +1,5 @@
 Ext.define('PMG.QuarantineNavigationTree', {
+
     extend: 'Ext.list.Tree',
     xtype: 'quarantinenavigationtree',
 
@@ -32,6 +33,13 @@ Ext.define('PMG.QuarantineNavigationTree', {
 			},
 		    ],
 		},
+		{
+		    text: gettext('Help'),
+		    iconCls: 'fa fa-support',
+		    path: 'pmgQuarantineAbout',
+		    leaf: true,
+		    expanded: true,
+		},
 	    ],
 	},
     },
diff --git a/js/QuarantineViewAbout.js b/js/QuarantineViewAbout.js
new file mode 100644
index 0000000..252a757
--- /dev/null
+++ b/js/QuarantineViewAbout.js
@@ -0,0 +1,44 @@
+// Needs to be its own xtype for `path` to work in `NavigationTree`
+Ext.define('PMG.QuarantineAboutPage', {
+    extend: 'Ext.panel.Panel',
+    xtype: 'pmgQuarantineAbout',
+
+    bodyPadding: 10,
+    title: 'Proxmox Mail Gateway Quarantine Help',
+
+    html: Proxmox.Markdown.parse(
+`# About
+This is the email quarantine interface for end-users provided by your email provider.
+
+Proxmox Mail Gateway is Software used to scan emails for threats like spam or viruses.
+
+Usually emails that contain viruses or are detected as being certain spam are blocked by your
+provider.
+Emails that are not classified as certain spam may be put into quarantine, where the recipient can
+decide if they want to receive or delete them. In most setups you will receive a Spam Report email
+to notify you, if your address has mail put in its quarantine.
+
+Additionally you have the option to block or welcome certain addresses in general.
+* Welcoming, in the Whitelist menu, results in the mails being directly delivered,
+instead of being stored in quarantine.
+* Blocking, in the Blacklist menu, results in the mails being directly deleted,
+instead of being stored in quarantine.
+
+
+**Note:** The sending of Spam Report emails and this Webpage are controlled by your email provider.
+
+Proxmox Server Solutions GmbH develops the software and is not running mail services for users.
+
+## Shortcuts
+
+When you have selected an entry in your quarantine you can use the following keyboard short-cuts
+in place of the buttons on top:
+
+* **D:** Deliver the mail
+* **Delete:** Delete the mail
+* **B:** Add the sender to the Blocklist/Blacklist
+* **W:** Add the sender to the Welcomelist/Whitelist
+`),
+
+});
+
-- 
2.39.5



_______________________________________________
pmg-devel mailing list
pmg-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel