feature: add extras field to store msg headers

ckanext/mailcraft/mailer.py

@@ -114,16 +114,17 @@ def mail_recipients(
             self.add_attachments(msg, attachments)
 
         try:
-            import ipdb
-
-            ipdb.set_trace()
             # print(msg.get_body(("html",)).get_content())  # type: ignore
             if mc_config.stop_outgoing_emails():
-                self._save_email(msg, body_html, state=mc_model.Email.State.stopped)
+                self._save_email(
+                    msg, body_html, mc_model.Email.State.stopped, dict(msg.items())
+                )
             else:
                 self._send_email(recipients, msg)
         except MailerException:
-            self._save_email(msg, body_html, state=mc_model.Email.State.failed)
+            self._save_email(
+                msg, body_html, mc_model.Email.State.failed, dict(msg.items())
+            )
         else:
             if not mc_config.stop_outgoing_emails():
                 self._save_email(msg, body_html)
@@ -188,8 +189,9 @@ def _save_email(
         msg: EmailMessage,
         body_html: str,
         state: str = mc_model.Email.State.success,
+        extras: Optional[dict[str, Any]] = None,
     ) -> None:
-        mc_model.Email.save_mail(msg, body_html, state)
+        mc_model.Email.save_mail(msg, body_html, state, extras or {})
 
     def _send_email(self, recipients, msg: EmailMessage):
         conn = self.get_connection()

ckanext/mailcraft/migration/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py

@@ -5,9 +5,10 @@
 Create Date: 2023-09-14 11:53:58.371935
 
 """
-from alembic import op
 import sqlalchemy as sa
 
+from alembic import op
+from sqlalchemy.dialects import postgresql
 
 # revision identifiers, used by Alembic.
 revision = "9f83e5bfff72"
@@ -31,6 +32,7 @@ def upgrade():
         sa.Column("recipient", sa.Text),
         sa.Column("message", sa.Text),
         sa.Column("state", sa.Text, server_default="success"),
+        sa.Column("extras", postgresql.JSONB(astext_type=sa.Text()), nullable=True),
     )
 
 

ckanext/mailcraft/model.py

@@ -7,6 +7,8 @@
 
 from sqlalchemy import Column, DateTime, Integer, Text
 from sqlalchemy.orm import Query
+from sqlalchemy.dialects.postgresql import JSONB
+from sqlalchemy.ext.mutable import MutableDict
 from typing_extensions import Self
 
 import ckan.model as model
@@ -31,6 +33,7 @@ class State:
     recipient = Column(Text)
     message = Column(Text)
     state = Column(Text, nullable=False, default=State.success)
+    extras = Column("extras", MutableDict.as_mutable(JSONB))
 
     @classmethod
     def all(cls) -> list[dict[str, Any]]:
@@ -39,14 +42,15 @@ def all(cls) -> list[dict[str, Any]]:
         return [mail.dictize({}) for mail in query.all()]
 
     @classmethod
-    def save_mail(cls, msg: EmailMessage, body_html: str, state: str) -> Email:
+    def save_mail(cls, msg: EmailMessage, body_html: str, state: str, extras: dict[str, Any]) -> Email:
         mail = cls(
             subject=msg["Subject"],
             timestamp=msg["Date"],
             sender=msg["From"],
             recipient=msg["To"],
             message=body_html,
             state=state,
+            extras=extras
         )
 
         model.Session.add(mail)
@@ -63,6 +67,7 @@ def dictize(self, context):
             "recipient": self.recipient,
             "message": self.message,
             "state": self.state,
+            "extras": self.extras or {}
         }
 
     @classmethod

ckanext/mailcraft/templates/mailcraft/mail_read.html

@@ -10,7 +10,20 @@
 {% endblock breadcrumb_content %}
 
 {% block ap_content %}
+    {% if mail.extras %}
+        <div class="mailcraft-mail-meta">
+            <h3>{{ _("Email headers") }}</h3>
+            <ul>
+                {% for key, value in mail.extras.items() %}
+                    <li><b>{{ key }}</b>: {{ value }}</li>
+                {% endfor %}
+            </ul>
+        </div>
+    {% endif %}
+
     <div class="mailcraft-mail-body">
+        <h3>{{ _("Email body") }}</h3>
+
         {{ mail.message | safe}}
     </div>
 {% endblock ap_content %}