support write_yaml_metadata_block as a path for passing recipients

Author: juleswg23

src/resources/filters/quarto-post/email.lua

@@ -401,7 +401,41 @@ function process_div(div)
         table.insert(remaining_content, child)
       end
     end
-    
+
+    -- Check for recipients attribute on the email div itself
+    -- This allows referencing metadata set via write_yaml_metadata_block()
+    if div.attributes.recipients then
+      local meta_key = div.attributes.recipients
+      local meta_value = quarto.metadata.get(meta_key)
+
+      if meta_value then
+        -- Convert metadata to recipients array
+        if quarto.utils.type(meta_value) == "List" then
+          local recipients_from_meta = {}
+          for _, item in ipairs(meta_value) do
+            local recipient_str = pandoc.utils.stringify(item)
+            if recipient_str ~= "" then
+              table.insert(recipients_from_meta, recipient_str)
+            end
+          end
+
+          -- If recipients were also found in child divs, merge them
+          if #current_email.recipients > 0 then
+            quarto.log.warning("Recipients found in both attribute and child div. Merging both lists.")
+            for _, recipient in ipairs(recipients_from_meta) do
+              table.insert(current_email.recipients, recipient)
+            end
+          else
+            current_email.recipients = recipients_from_meta
+          end
+        else
+          quarto.log.warning("Recipients metadata '" .. meta_key .. "' is not a list. Expected format: ['email1@example.com', 'email2@example.com']")
+        end
+      else
+        quarto.log.warning("Recipients attribute references metadata key '" .. meta_key .. "' which does not exist.")
+      end
+    end
+
     -- Create a modified div without metadata for processing
     local email_without_metadata = pandoc.Div(remaining_content, div.attr)
 

tests/docs/email/email-recipients-all-patterns-python.qmd

@@ -0,0 +1,69 @@
+---
+title: Email Recipients - All Patterns (Python)
+author: Jules Walzer-Goldfeld
+format: email
+email-version: 2
+---
+
+```{python}
+#| echo: false
+import yaml
+from IPython.display import Markdown
+
+def write_yaml_metadata_block(**kwargs):
+    """Write YAML metadata block that will be parsed by Quarto."""
+    yaml_content = yaml.dump(
+        kwargs,
+        default_flow_style=False,
+        allow_unicode=True,
+        sort_keys=False
+    )
+    yaml_block = f"---\n{yaml_content}---\n"
+    return Markdown(yaml_block)
+```
+
+Test document demonstrating both recipient patterns with Python.
+
+```{python}
+#| output: asis
+# Email 1: Metadata attribute pattern
+metadata_recipients = ["metadata1@example.com", "metadata2@example.com"]
+write_yaml_metadata_block(metadata_recipients=metadata_recipients)
+```
+
+::: {.email recipients=metadata_recipients}
+
+::: {.subject}
+Email 1: Metadata Attribute Pattern
+:::
+
+::: {.email-text}
+This email uses the metadata attribute pattern.
+:::
+
+First email using metadata attribute pattern with Python.
+
+:::
+
+```{python}
+# Email 2: Inline recipients pattern
+inline_recipients = ["inline1@example.com", "inline2@example.com"]
+```
+
+::: {.email}
+
+::: {.subject}
+Email 2: Inline Recipients Pattern
+:::
+
+::: {.recipients}
+`{python} inline_recipients`
+:::
+
+::: {.email-text}
+This email uses the inline recipients pattern.
+:::
+
+Second email using inline recipients pattern with Python.
+
+:::

tests/docs/email/email-recipients-all-patterns-r.qmd

@@ -0,0 +1,69 @@
+---
+title: Email Recipients - All Patterns (R)
+author: Jules Walzer-Goldfeld
+format: email
+email-version: 2
+---
+
+```{r}
+#| echo: false
+# Simple metadata block writer for testing
+# (Ideally we use the quarto R package: install.packages("quarto"))
+# We are awiting PR #
+write_yaml_metadata_block <- function(...) {
+  args <- list(...)
+  if (length(args) == 0) {
+    return()
+  }
+
+  yaml_content <- yaml::as.yaml(args)
+  yaml_block <- paste0("---\n", yaml_content, "---\n")
+  knitr::asis_output(yaml_block)
+}
+```
+
+Test document demonstrating both recipient patterns with R.
+
+```{r}
+#| output: asis
+# Email 1: Metadata attribute pattern
+metadata_recipients <- c("metadata1@example.com", "metadata2@example.com")
+write_yaml_metadata_block(metadata_recipients = metadata_recipients)
+```
+
+::: {.email recipients=metadata_recipients}
+
+::: {.subject}
+Email 1: Metadata Attribute Pattern
+:::
+
+::: {.email-text}
+This email uses the metadata attribute pattern.
+:::
+
+First email using metadata attribute pattern with R.
+
+:::
+
+```{r}
+# Email 2: Inline recipients pattern
+inline_recipients <- c("inline1@example.com", "inline2@example.com")
+```
+
+::: {.email}
+
+::: {.subject}
+Email 2: Inline Recipients Pattern
+:::
+
+::: {.recipients}
+`{r} inline_recipients`
+:::
+
+::: {.email-text}
+This email uses the inline recipients pattern.
+:::
+
+Second email using inline recipients pattern with R.
+
+:::

tests/smoke/render/render-email.test.ts

@@ -312,6 +312,64 @@ testRender(docs("email/email-recipients-formats.qmd"), "email", false, [
     "SPARK_CONNECT_USER_AGENT": "posit-connect/2026.03.0"
   }
 });
+
+// Test both recipient patterns with Python (metadata attribute + inline)
+testRender(docs("email/email-recipients-all-patterns-python.qmd"), "email", false, [
+  fileExists(previewFileV2_1),
+  fileExists(previewFileV2_2),
+  validJsonWithMultipleEmails(jsonFile, 2, {
+    "0": {
+      "email_id": 1,
+      "subject": "Email 1: Metadata Attribute Pattern",
+      "recipients": ["metadata1@example.com", "metadata2@example.com"],
+      "attachments": [],
+      "suppress_scheduled": false,
+      "send_report_as_attachment": false
+    },
+    "1": {
+      "email_id": 2,
+      "subject": "Email 2: Inline Recipients Pattern",
+      "recipients": ["inline1@example.com", "inline2@example.com"],
+      "attachments": [],
+      "suppress_scheduled": false,
+      "send_report_as_attachment": false
+    }
+  })
+], {
+  ...cleanupCtx,
+  env: {
+    "SPARK_CONNECT_USER_AGENT": "posit-connect/2026.03.0"
+  }
+});
+
+// Test both recipient patterns with R (metadata attribute + inline)
+testRender(docs("email/email-recipients-all-patterns-r.qmd"), "email", false, [
+  fileExists(previewFileV2_1),
+  fileExists(previewFileV2_2),
+  validJsonWithMultipleEmails(jsonFile, 2, {
+    "0": {
+      "email_id": 1,
+      "subject": "Email 1: Metadata Attribute Pattern",
+      "recipients": ["metadata1@example.com", "metadata2@example.com"],
+      "attachments": [],
+      "suppress_scheduled": false,
+      "send_report_as_attachment": false
+    },
+    "1": {
+      "email_id": 2,
+      "subject": "Email 2: Inline Recipients Pattern",
+      "recipients": ["inline1@example.com", "inline2@example.com"],
+      "attachments": [],
+      "suppress_scheduled": false,
+      "send_report_as_attachment": false
+    }
+  })
+], {
+  ...cleanupCtx,
+  env: {
+    "SPARK_CONNECT_USER_AGENT": "posit-connect/2026.03.0"
+  }
+});
 // Render in a project with an output directory set in _quarto.yml and confirm that everything ends up in the output directory
 testProjectRender(docs("email/project/email-attach.qmd"), "email", (outputDir: string) => {
   const verify: Verify[]= [];