Hello world
", + subject="Test Email", + ) + email.write_quarto_json("email_metadata.json") + ``` + + Notes + ------ + The output JSON includes:\n + - email_subject: The subject line + - email_attachments: List of attachment file paths + - email_body_html: The HTML content of the email + - email_body_text: Plain text version (if present) + - email_images: Dictionary of base64-encoded inline images (only if not empty) + - email_suppress_report_attachment: Suppression flag for report attachments + - email_suppress_scheduled: Suppression flag for scheduled sending + """ + metadata = { + "email_subject": self.subject, + "email_attachments": self.external_attachments or [], + "email_body_html": self.html, + } + + # Add optional text field if present + if self.text: + metadata["email_body_text"] = self.text + + # Add inline images only if not empty + if self.inline_attachments: + metadata["email_images"] = self.inline_attachments + + # Add suppression flags if they are set (not None) + if self.email_suppress_report_attachment is not None: + metadata["email_suppress_report_attachment"] = ( + self.email_suppress_report_attachment + ) + + if self.email_suppress_scheduled is not None: + metadata["email_suppress_scheduled"] = self.email_suppress_scheduled + + with open(out_file, "w", encoding="utf-8") as f: + json.dump(metadata, f, indent=2) + + diff --git a/nbmail/tests/test_egress.py b/nbmail/tests/test_egress.py index fb98b13..0dfae1a 100644 --- a/nbmail/tests/test_egress.py +++ b/nbmail/tests/test_egress.py @@ -2,6 +2,10 @@ import pytest +import json +import tempfile +import os + from nbmail.egress import ( send_email_with_redmail, send_email_with_yagmail, @@ -11,6 +15,7 @@ send_quarto_email_with_gmail, ) from nbmail.structs import Email +from nbmail.ingress import quarto_json_to_email def make_basic_email(): @@ -286,3 +291,142 @@ def test_not_implemented_functions(send_func): email = make_basic_email() with pytest.raises(NotImplementedError): send_func(email) + + +# Tests for Email.write_quarto_json() method +def test_email_write_quarto_json_basic(): + email = Email( + html="Test email
", + subject="Test Subject", + text="Plain text version", + external_attachments=["file1.pdf", "file2.csv"], + inline_attachments={"img1": "base64data123"}, + email_suppress_report_attachment=True, + email_suppress_scheduled=False, + ) + + with tempfile.TemporaryDirectory() as tmpdir: + json_path = os.path.join(tmpdir, "test.json") + email.write_quarto_json(json_path) + + with open(json_path, "r") as f: + data = json.load(f) + + # Check that all expected fields are present (with prefix for Quarto compatibility) + assert data["email_subject"] == "Test Subject" + assert data["email_body_html"] == "Test email
" + assert data["email_body_text"] == "Plain text version" + assert data["email_attachments"] == ["file1.pdf", "file2.csv"] + assert data["email_images"] == {"img1": "base64data123"} + assert data["email_suppress_report_attachment"] is True + assert data["email_suppress_scheduled"] is False + + +def test_email_write_quarto_json_minimal(): + """Test writing a minimal email to Quarto JSON format.""" + email = Email( + html="Minimal", + subject="Minimal Subject", + ) + + with tempfile.TemporaryDirectory() as tmpdir: + json_path = os.path.join(tmpdir, "minimal.json") + email.write_quarto_json(json_path) + + with open(json_path, "r") as f: + data = json.load(f) + + # Check minimal fields + assert data["email_subject"] == "Minimal Subject" + assert data["email_body_html"] == "Minimal" + assert data["email_attachments"] == [] + + # Optional fields should not be present + assert "email_body_text" not in data + assert "email_images" not in data + assert "email_suppress_report_attachment" not in data + assert "email_suppress_scheduled" not in data + + +def test_email_write_quarto_json_round_trip(): + """Test writing and reading back a Quarto JSON email.""" + original_email = Email( + html="Quarto email
", + subject="Quarto Test", + text="Plain text version", + external_attachments=["output.pdf"], + inline_attachments={"img1": "base64encodedstring"}, + email_suppress_report_attachment=True, + email_suppress_scheduled=False, + ) + + with tempfile.TemporaryDirectory() as tmpdir: + json_path = os.path.join(tmpdir, "roundtrip.json") + original_email.write_quarto_json(json_path) + + # Read it back + read_email = quarto_json_to_email(json_path) + + # Verify all fields match + assert read_email.subject == original_email.subject + assert read_email.html == original_email.html + assert read_email.text == original_email.text + assert read_email.external_attachments == original_email.external_attachments + assert read_email.inline_attachments == original_email.inline_attachments + assert read_email.email_suppress_report_attachment == original_email.email_suppress_report_attachment + assert read_email.email_suppress_scheduled == original_email.email_suppress_scheduled + + +def test_email_write_quarto_json_no_attachments(): + """Test writing an email without attachments or images.""" + email = Email( + html="No attachments", + subject="No Attachments", + ) + + with tempfile.TemporaryDirectory() as tmpdir: + json_path = os.path.join(tmpdir, "no_attachments.json") + email.write_quarto_json(json_path) + + with open(json_path, "r") as f: + data = json.load(f) + + # Check that attachments and images are empty + assert data["email_attachments"] == [] + assert "email_images" not in data + + +def test_email_write_quarto_json_no_text(): + """Test writing an email without plain text version.""" + email = Email( + html="HTML only", + subject="HTML Only", + ) + + with tempfile.TemporaryDirectory() as tmpdir: + json_path = os.path.join(tmpdir, "html_only.json") + email.write_quarto_json(json_path) + + with open(json_path, "r") as f: + data = json.load(f) + + # Plain text should not be present + assert "email_body_text" not in data + + +def test_email_write_quarto_json_custom_filename(): + email = Email( + html="Custom", + subject="Custom Filename", + ) + + with tempfile.TemporaryDirectory() as tmpdir: + custom_path = os.path.join(tmpdir, "my_custom_file.json") + email.write_quarto_json(custom_path) + + assert os.path.exists(custom_path) + + with open(custom_path, "r") as f: + data = json.load(f) + + assert data["email_subject"] == "Custom Filename" diff --git a/nbmail/tests/test_ingress.py b/nbmail/tests/test_ingress.py index 148c4cd..c70fc4b 100644 --- a/nbmail/tests/test_ingress.py +++ b/nbmail/tests/test_ingress.py @@ -225,8 +225,8 @@ def test_quarto_json_to_email_basic(tmp_path): "rsc_output_files": ["output.pdf"], "rsc_email_attachments": ["attachment.csv"], "rsc_email_images": {"img1": "base64encodedstring"}, - "rsc_email_supress_report_attachment": True, - "rsc_email_supress_scheduled": False, + "rsc_email_suppress_report_attachment": True, + "rsc_email_suppress_scheduled": False, } json_file = tmp_path / "metadata.json" @@ -240,8 +240,8 @@ def test_quarto_json_to_email_basic(tmp_path): assert result.text == "Plain text version" assert result.external_attachments == ["output.pdf", "attachment.csv"] assert result.inline_attachments == {"img1": "base64encodedstring"} - assert result.rsc_email_supress_report_attachment is True - assert result.rsc_email_supress_scheduled is False + assert result.email_suppress_report_attachment is True + assert result.email_suppress_scheduled is False def test_quarto_json_to_email_minimal(tmp_path): @@ -261,8 +261,8 @@ def test_quarto_json_to_email_minimal(tmp_path): assert result.text == "" assert result.external_attachments == [] assert result.inline_attachments == {} - assert result.rsc_email_supress_report_attachment is False - assert result.rsc_email_supress_scheduled is False + assert result.email_suppress_report_attachment is False + assert result.email_suppress_scheduled is False def test_quarto_json_to_email_empty_lists(tmp_path): diff --git a/nbmail/tests/test_structs.py b/nbmail/tests/test_structs.py index 60d9847..d5d4d37 100644 --- a/nbmail/tests/test_structs.py +++ b/nbmail/tests/test_structs.py @@ -37,8 +37,8 @@ def test_subject_inserts_after_body(tmp_path): email = Email( html=html, subject="Test Subject", - rsc_email_supress_report_attachment=False, - rsc_email_supress_scheduled=False, + email_suppress_report_attachment=False, + email_suppress_scheduled=False, ) out_file = tmp_path / "preview.html"