From e452dd19a6060c09cbf9722fe68f381c79b08f87 Mon Sep 17 00:00:00 2001
From: Roman <roman.kysil@redturtle.it>
Date: Wed, 29 May 2024 14:30:54 +0200
Subject: [PATCH 1/9] Configurable header and footer

---
 .../formsupport/browser/send_mail_template.pt  | 18 ++++++++++++++----
 .../browser/send_mail_template_table.pt        | 14 ++++++++++++--
 .../restapi/services/submit_form/post.py       |  1 +
 3 files changed, 27 insertions(+), 6 deletions(-)

diff --git a/src/collective/volto/formsupport/browser/send_mail_template.pt b/src/collective/volto/formsupport/browser/send_mail_template.pt
index 53387cdc..c8c4b57a 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template.pt
@@ -2,7 +2,12 @@
     i18n:domain="collective.volto.formsupport"
     define="parameters python:options.get('parameters', {});
             url python:options.get('url', '');
-            title python:options.get('title', '');">
+            title python:options.get('title', '');
+            block python:options.get('block', '');
+            ">
+  <header>
+    <tal:element tal:replace="structure python:block.get('mail_header', '')"></tal:element>
+  </header>
   <ul>
     <tal:field repeat="field parameters">
       <li tal:define="value field/value|nothing;
@@ -11,7 +16,12 @@
       </li>
     </tal:field>
   </ul>
-  <p i18n:translate="send_mail_text">
-    A new form has been submitted from <a href="${url}"><strong i18n:name="url">${url}</strong></a>
-  </p>
+  <tal:element tal:condition="python:not block.get('mail_footer', '')">
+    <p i18n:translate="send_mail_text">
+      A new form has been submitted from <a href="${url}"><strong i18n:name="url">${url}</strong></a>
+    </p>
+  </tal:element>
+  <footer>
+    <tal:element tal:replace="structure python:block.get('mail_footer', '')"></tal:element>
+  </footer>
 </tal:root>
diff --git a/src/collective/volto/formsupport/browser/send_mail_template_table.pt b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
index ac1ced69..40c79d16 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template_table.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
@@ -2,14 +2,21 @@
   i18n:domain="collective.volto.formsupport"
   define="parameters python:options.get('parameters', {});
             url python:options.get('url', '');
-            title python:options.get('title', '');">
+            title python:options.get('title', '');
+            block python:options.get('block', '');
+            ">
   <style>
     th {
         text-align: start;
     }
   </style>
+  <header>
+    <tal:element tal:replace="structure python:block.get('mail_header', '')"></tal:element>
+  </header>
   <table border="1">
-    <caption i18n:translate="send_mail_text_table">Form submission data for ${title}</caption>
+    <tal:element tal:condition="python:not block.get('mail_header', '')">
+      <caption i18n:translate="send_mail_text_table">Form submission data for ${title}</caption>
+    <tal:element>
     <thead>
       <tr role="row">
         <th align="left"
@@ -33,6 +40,9 @@
       </tal:field>
     </tbody>
   </table>
+  <footer>
+    <tal:element tal:replace="structure python:block.get('mail_footer', '')"></tal:element>
+  </footer>
 </tal:root>
 
 
diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index 5caa7f8a..be5812fc 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -413,6 +413,7 @@ def prepare_message(self):
             "parameters": self.filter_parameters(),
             "url": self.context.absolute_url(),
             "title": self.context.Title(),
+            "block": self.block,
         }
         return message_template(**parameters)
 

From 5ee860b863b32288975d6a7be5174a130f55c1ad Mon Sep 17 00:00:00 2001
From: Roman <roman.kysil@redturtle.it>
Date: Wed, 29 May 2024 14:36:53 +0200
Subject: [PATCH 2/9] Changes

---
 CHANGES.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/CHANGES.rst b/CHANGES.rst
index 648e3b76..7d64eefb 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -4,7 +4,8 @@ Changelog
 3.0.3 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Configurable header and footer for email message.
+  [folix-01]
 
 
 3.0.2 (2024-05-05)

From 35a09f41fa33858dce0e7dc0fe7dc9602c258716 Mon Sep 17 00:00:00 2001
From: Roman <roman.kysil@redturtle.it>
Date: Fri, 31 May 2024 10:20:10 +0200
Subject: [PATCH 3/9] Review requests

---
 .../formsupport/browser/send_mail_template.pt   | 17 +++++++++--------
 .../browser/send_mail_template_table.pt         | 13 +++++++------
 .../restapi/services/submit_form/post.py        |  3 ++-
 3 files changed, 18 insertions(+), 15 deletions(-)

diff --git a/src/collective/volto/formsupport/browser/send_mail_template.pt b/src/collective/volto/formsupport/browser/send_mail_template.pt
index c8c4b57a..4518c3ba 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template.pt
@@ -3,10 +3,11 @@
     define="parameters python:options.get('parameters', {});
             url python:options.get('url', '');
             title python:options.get('title', '');
-            block python:options.get('block', '');
+            mail_header python:options.get('mail_header', '');
+            mail_footer python:options.get('mail_footer', '');
             ">
   <header>
-    <tal:element tal:replace="structure python:block.get('mail_header', '')"></tal:element>
+    <tal:element tal:replace="structure mail_header"></tal:element>
   </header>
   <ul>
     <tal:field repeat="field parameters">
@@ -16,12 +17,12 @@
       </li>
     </tal:field>
   </ul>
-  <tal:element tal:condition="python:not block.get('mail_footer', '')">
-    <p i18n:translate="send_mail_text">
-      A new form has been submitted from <a href="${url}"><strong i18n:name="url">${url}</strong></a>
-    </p>
-  </tal:element>
   <footer>
-    <tal:element tal:replace="structure python:block.get('mail_footer', '')"></tal:element>
+    <tal:element tal:replace="structure mail_footer"></tal:element>
+    <tal:element tal:condition="python:not mail_footer ">
+      <p i18n:translate="send_mail_text">
+        A new form has been submitted from <a href="${url}"><strong i18n:name="url">${url}</strong></a>
+      </p>
+    </tal:element>
   </footer>
 </tal:root>
diff --git a/src/collective/volto/formsupport/browser/send_mail_template_table.pt b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
index 40c79d16..edf6a6af 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template_table.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
@@ -3,7 +3,8 @@
   define="parameters python:options.get('parameters', {});
             url python:options.get('url', '');
             title python:options.get('title', '');
-            block python:options.get('block', '');
+            mail_header python:options.get('mail_header', '');
+            mail_footer python:options.get('mail_footer', '');
             ">
   <style>
     th {
@@ -11,12 +12,12 @@
     }
   </style>
   <header>
-    <tal:element tal:replace="structure python:block.get('mail_header', '')"></tal:element>
-  </header>
-  <table border="1">
-    <tal:element tal:condition="python:not block.get('mail_header', '')">
+    <tal:element tal:replace="structure mail_header"></tal:element>
+    <tal:element tal:condition="python:not mail_footer">
       <caption i18n:translate="send_mail_text_table">Form submission data for ${title}</caption>
     <tal:element>
+  </header>
+  <table border="1">
     <thead>
       <tr role="row">
         <th align="left"
@@ -41,7 +42,7 @@
     </tbody>
   </table>
   <footer>
-    <tal:element tal:replace="structure python:block.get('mail_footer', '')"></tal:element>
+    <tal:element tal:replace="structure mail_footer"></tal:element>
   </footer>
 </tal:root>
 
diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index be5812fc..d9df32df 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -413,7 +413,8 @@ def prepare_message(self):
             "parameters": self.filter_parameters(),
             "url": self.context.absolute_url(),
             "title": self.context.Title(),
-            "block": self.block,
+            "mail_header": self.block.get("mail_header", None),
+            "mail_footer": self.block.get("mail_footer", None),
         }
         return message_template(**parameters)
 

From 652fb2580d39171be79981f949dd099174cd0574 Mon Sep 17 00:00:00 2001
From: Roman <72063601+folix-01@users.noreply.github.com>
Date: Thu, 27 Jun 2024 15:24:57 +0200
Subject: [PATCH 4/9] Update post.py

---
 .../volto/formsupport/restapi/services/submit_form/post.py    | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index d9df32df..70dcdd10 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -413,8 +413,8 @@ def prepare_message(self):
             "parameters": self.filter_parameters(),
             "url": self.context.absolute_url(),
             "title": self.context.Title(),
-            "mail_header": self.block.get("mail_header", None),
-            "mail_footer": self.block.get("mail_footer", None),
+            "mail_header": self.block.get("mail_header", {}).get('data', {}),
+            "mail_footer": self.block.get("mail_footer", {}).get('data', {}),
         }
         return message_template(**parameters)
 

From 12a95cdbe1b316b20cb3b62768ad97eaa0126d3b Mon Sep 17 00:00:00 2001
From: Roman <72063601+folix-01@users.noreply.github.com>
Date: Fri, 28 Jun 2024 14:09:25 +0200
Subject: [PATCH 5/9] Update post.py

---
 .../restapi/services/submit_form/post.py            | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index 70dcdd10..a7309f9d 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -395,6 +395,15 @@ def send_data(self):
                 self.send_mail(msg=acknowledgement_mail, charset=charset)
 
     def prepare_message(self):
+        from bs4 import BeautifulSoup
+
+        mail_header = self.block.get("mail_header", {}).get("data", "")
+        mail_footer = self.block.get("mail_footer", {}).get("data", "")
+
+        # Check if there is content
+        mail_header = BeautifulSoup(mail_header).get_text() and mail_header or None
+        mail_footer = BeautifulSoup(mail_footer).get_text() and mail_footer or None
+        
         email_format_page_template_mapping = {
             "list": "send_mail_template",
             "table": "send_mail_template_table",
@@ -413,8 +422,8 @@ def prepare_message(self):
             "parameters": self.filter_parameters(),
             "url": self.context.absolute_url(),
             "title": self.context.Title(),
-            "mail_header": self.block.get("mail_header", {}).get('data', {}),
-            "mail_footer": self.block.get("mail_footer", {}).get('data', {}),
+            "mail_header": mail_header,
+            "mail_footer": mail_footer,
         }
         return message_template(**parameters)
 

From f72d628a1a5cf20ad2635dd9a08536847f5b0692 Mon Sep 17 00:00:00 2001
From: Mauro Amico <mauro.amico@gmail.com>
Date: Thu, 4 Jul 2024 13:41:50 +0200
Subject: [PATCH 6/9] fix dependencies

---
 pyproject.toml                                                | 1 +
 setup.py                                                      | 1 +
 .../volto/formsupport/restapi/services/submit_form/post.py    | 4 ++--
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 9af5bc47..e3f2e35e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -84,6 +84,7 @@ Zope = [
 ]
 python-dateutil = ['dateutil']
 'souper.plone' = ['souper', 'repoze.catalog']
+beautifulsoup4 = ['bs4']
 # extra packages
 ignore-packages = [
   # these are packages defined in extras_require
diff --git a/setup.py b/setup.py
index e097ab42..0e1a9bb9 100644
--- a/setup.py
+++ b/setup.py
@@ -68,6 +68,7 @@
         "Products.PortalTransforms",
         "souper.plone",
         "click",
+        "beautifulsoup4",
         "pyotp",
     ],
     extras_require={
diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index a38064fc..9cc9fc5a 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -1,3 +1,4 @@
+from bs4 import BeautifulSoup
 from collective.volto.formsupport import _
 from collective.volto.formsupport.interfaces import ICaptchaSupport
 from collective.volto.formsupport.interfaces import IFormDataStore
@@ -418,7 +419,6 @@ def send_data(self):
                 self.send_mail(msg=acknowledgement_mail, charset=charset)
 
     def prepare_message(self):
-        from bs4 import BeautifulSoup
 
         mail_header = self.block.get("mail_header", {}).get("data", "")
         mail_footer = self.block.get("mail_footer", {}).get("data", "")
@@ -426,7 +426,7 @@ def prepare_message(self):
         # Check if there is content
         mail_header = BeautifulSoup(mail_header).get_text() and mail_header or None
         mail_footer = BeautifulSoup(mail_footer).get_text() and mail_footer or None
-        
+
         email_format_page_template_mapping = {
             "list": "send_mail_template",
             "table": "send_mail_template_table",

From 0e57d3eade06421bd22992cc600599d58b809549 Mon Sep 17 00:00:00 2001
From: Mauro Amico <mauro.amico@gmail.com>
Date: Thu, 4 Jul 2024 13:46:41 +0200
Subject: [PATCH 7/9] Update
 src/collective/volto/formsupport/restapi/services/submit_form/post.py

---
 .../volto/formsupport/restapi/services/submit_form/post.py    | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/collective/volto/formsupport/restapi/services/submit_form/post.py b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
index 9cc9fc5a..55733591 100644
--- a/src/collective/volto/formsupport/restapi/services/submit_form/post.py
+++ b/src/collective/volto/formsupport/restapi/services/submit_form/post.py
@@ -424,8 +424,8 @@ def prepare_message(self):
         mail_footer = self.block.get("mail_footer", {}).get("data", "")
 
         # Check if there is content
-        mail_header = BeautifulSoup(mail_header).get_text() and mail_header or None
-        mail_footer = BeautifulSoup(mail_footer).get_text() and mail_footer or None
+        mail_header = BeautifulSoup(mail_header).get_text() if mail_header else None
+        mail_footer = BeautifulSoup(mail_footer).get_text() if mail_footer else None
 
         email_format_page_template_mapping = {
             "list": "send_mail_template",

From cd00d6e535ffc2b1af794d73749080dda2ef80d7 Mon Sep 17 00:00:00 2001
From: Mauro Amico <mauro.amico@gmail.com>
Date: Thu, 4 Jul 2024 13:51:27 +0200
Subject: [PATCH 8/9] Update
 src/collective/volto/formsupport/browser/send_mail_template_table.pt

---
 .../volto/formsupport/browser/send_mail_template_table.pt       | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/collective/volto/formsupport/browser/send_mail_template_table.pt b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
index 03b3ef3e..1e0cc718 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template_table.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
@@ -14,7 +14,7 @@
   </style>
   <header>
     <tal:element tal:replace="structure mail_header"></tal:element>
-    <tal:element tal:condition="python:not mail_footer">
+    <tal:element tal:condition="python:not mail_header">
       <caption i18n:translate="send_mail_text_table">Form submission data for ${title}</caption>
     <tal:element>
   </header>

From 9d03658693d51d10afd991b84880414f38c24acc Mon Sep 17 00:00:00 2001
From: Mauro Amico <mauro.amico@gmail.com>
Date: Thu, 4 Jul 2024 13:55:21 +0200
Subject: [PATCH 9/9] zpretty

---
 .../volto/formsupport/browser/send_mail_template.pt   |  9 +++++----
 .../formsupport/browser/send_mail_template_table.pt   | 11 ++++++-----
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/collective/volto/formsupport/browser/send_mail_template.pt b/src/collective/volto/formsupport/browser/send_mail_template.pt
index b402b03b..1d17eff9 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template.pt
@@ -1,14 +1,15 @@
 <tal:root xmlns:i18n="http://xml.zope.org/namespaces/i18n"
-          i18n:domain="collective.volto.formsupport"
           define="
             parameters python:options.get('parameters', {});
             url python:options.get('url', '');
             title python:options.get('title', '');
             mail_header python:options.get('mail_header', '');
             mail_footer python:options.get('mail_footer', '');
-            ">
+          "
+          i18n:domain="collective.volto.formsupport"
+>
   <header>
-    <tal:element tal:replace="structure mail_header"></tal:element>
+    <tal:element tal:replace="structure mail_header" />
   </header>
   <ul>
     <tal:field repeat="field parameters">
@@ -22,7 +23,7 @@
     </tal:field>
   </ul>
   <footer>
-    <tal:element tal:replace="structure mail_footer"></tal:element>
+    <tal:element tal:replace="structure mail_footer" />
     <tal:element tal:condition="python:not mail_footer ">
       <p i18n:translate="send_mail_text">
         A new form has been submitted from
diff --git a/src/collective/volto/formsupport/browser/send_mail_template_table.pt b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
index 1e0cc718..fc5fd2b7 100644
--- a/src/collective/volto/formsupport/browser/send_mail_template_table.pt
+++ b/src/collective/volto/formsupport/browser/send_mail_template_table.pt
@@ -1,22 +1,23 @@
 <tal:root xmlns:i18n="http://xml.zope.org/namespaces/i18n"
-          i18n:domain="collective.volto.formsupport"
           define="
             parameters python:options.get('parameters', {});
             url python:options.get('url', '');
             title python:options.get('title', '');
             mail_header python:options.get('mail_header', '');
             mail_footer python:options.get('mail_footer', '');
-            ">
+          "
+          i18n:domain="collective.volto.formsupport"
+>
   <style>
     th {
         text-align: start;
     }
   </style>
   <header>
-    <tal:element tal:replace="structure mail_header"></tal:element>
+    <tal:element tal:replace="structure mail_header" />
     <tal:element tal:condition="python:not mail_header">
       <caption i18n:translate="send_mail_text_table">Form submission data for ${title}</caption>
-    <tal:element>
+    </tal:element>
   </header>
   <table border="1">
     <thead>
@@ -51,6 +52,6 @@
     </tbody>
   </table>
   <footer>
-    <tal:element tal:replace="structure mail_footer"></tal:element>
+    <tal:element tal:replace="structure mail_footer" />
   </footer>
 </tal:root>