Feature/parse json make email body

[anurampalli]

Two-Step Flow Designer Action: JSON Parsing and Email Notification

This is a design document for a reusable, two-step Flow Designer Action for parsing a JSON payload and sending its contents in a well-formatted email (Text or HTML).

---

1. Action Name & Description

Field	Value
Action Name	JSON Parser & Email Sender
Description	Recursively parses JSON data and sends a formatted email (Text or HTML) to specified recipients. Ideal for incident notifications.
Use Case	Automatically alert support teams and management of high-priority incidents, including all relevant fields, in a well-formatted email.

---

2. Step 1: Script - JSON Parser

This step contains the core logic for recursive JSON parsing and formatting.

2.1 Inputs

Input Name	Type	Description	Required
jsonString	String	The raw JSON string to be parsed (e.g., the payload from an inbound integration).	Yes
emailSubject	String	The subject for the outgoing email.	Yes
emailTo	String	Comma or semicolon-separated list of email addresses.	Yes
outputFormat	String (Choice)	text or html. Determines the formatting of the emailBody.	Yes

2.2 Script Logic (Pseudo-code/Summary)

1. Input Validation: Check if jsonString is null or empty. If so, set emailBody to an error message and status to 'Error'.
2. Parsing Attempt: Attempt to parse jsonString using a built-in JSON parser function (e.g., JSON.parse()).
3. Error Handling (Invalid JSON):
   • If parsing fails, set status to 'Error'.
   • Set emailBody to a descriptive error message: "Error: Invalid JSON structure provided. Details: [Parsing Error Message]".
4. Recursive Formatting Function (formatJson(data, format)):
   • Handles Objects: Iterates over key/value pairs. If the value is another object or array, it calls itself recursively.
     • HTML: Formats data into an HTML <table> or ordered/unordered list (<ol>, <ul>).
     • Text: Formats data using clear key-value pairs with indentation and line breaks.
   • Handles Arrays: Iterates over elements. If an element is complex, calls itself recursively.
   • Handles Primitive Types (string, number, boolean): Appends the key and value to the body string, respecting the output format.
5. Output Generation: Call formatJson(parsedData, outputFormat). Set the returned string to emailBody.
6. Set status to 'Success'.

2.3 Outputs

Output Name	Type	Description
emailBody	String	The fully formatted email content (Text or HTML).
status	String	'Success' or 'Error'. Used for conditional logic in Step 2.
emailSubject	String	Passed through from input.
emailTo	String	Passed through from input.

---

3. Step 2: Email - Send Formatted Email

This step is a standard Email action that consumes the outputs from Step 1.

3.1 Inputs

Field	Value (Mapped from Step 1)	Notes
Target Email	$Step 1.emailTo	Multiple recipients handled by the system's email action.
Subject	$Step 1.emailSubject
Body (HTML/Text)	$Step 1.emailBody	Crucially, the email action must respect the outputFormat choice.

3.2 Conditional Logic

• HTML Email: If $Step 1.outputFormat is 'html', ensure the email body is sent as HTML content.
• Text Email: If $Step 1.outputFormat is 'text', ensure the email body is sent as plain text content.

---

4. Notable Features & Testing Summary

• Modular Design: Step 1 (JSON Parser) is self-contained and reusable in other actions requiring JSON to structured text/HTML conversion.
• outputFormat Choice: Allows the caller to easily switch between simple text (for plain terminals/low-fidelity) and rich HTML (for better readability/branding).
• Robust Error Handling:
  • The flow does not fail silently on invalid/empty JSON.
  • The error message is captured in the $Step 1.emailBody and sent in the notification, immediately alerting the recipients to the parsing issue (e.g., a bad integration payload).
• Testing Confirmation:
  • Confirmed formatting correctness for both Text and HTML outputs.
  • Verified email delivery to multiple addresses using comma/semicolon separators in emailTo.

[github-actions]

✅ Valid PR for ActionPack

Thank you for your contribution. This PR complies with the CONTRIBUTING.md.
A maintainer will review this shortly. In the meantime, Happy Hacking!

[rohi-v]

Thanks for your submission.
It appears that this pull request contains more files than described in the title. Please review and update the pull request to either remove the extra/unintended files or to update the description to be more comprehensive. Ensure your contributions are meaningful and adhere to the project’s standards. [If applicable: You can create a new branch on your forked repository to avoid accidental inclusions of new commits in the future.]. Closing this for now. Once you make additional changes, feel free to re-open this Pull Request or create a new one.

[anurampalli]

Thank you Rohila. After my earlier Pull Request was approved, I created another feature branch and used that to create this PR. Looks like that caused the issue. Deleted the fork, forked the ActionPack repo again and ... and submitted a fresh PR with no conflicts. Another PR, another learning :-D

…

On Sat, 4 Oct 2025 at 21:50, Rohila V ***@***.***> wrote: Closed #54 <#54>. — Reply to this email directly, view it on GitHub <#54 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BQUBSOS3W2TADNR5BAY3RQT3V6X7HAVCNFSM6AAAAACII2XXE6VHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMRQGA4TKOBZHE2TINY> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>