Home / Email Templates / Template Guide

Email Template Creation Guide

Last Edited: 2026-07-07 02:27

This document serves as a guide for humans and AI agents to write markdown email templates that are fully compatible with the Email Composer tool (both the browser utility and CLI scripts).

1. Structure of a Template File

A standard template file should be structured as follows:

---
subject: "Accessing your AI Roadmap & Uberall dashboard"
---

Hi [Client First Name],

As part of your subscription with Online Access, we have set up your custom AI Roadmap.

You can view your baseline AI Roadmap [here]([AI Roadmap Link]).

Best,

Frontmatter (YAML)

• You can include a YAML frontmatter block at the top of the file containing a subject property.
• The Email Composer will automatically detect this and pre-populate the Email Subject line.
• Alternatively, you can include **Subject:** Scheduling your Session on the first line of the body.

2. Formatting Placeholders & Variables

Variables are identified by enclosing them in single brackets: [Variable Name].

• Plain Text Variables: e.g., [Client First Name] or [Credentials Info].
• Case-Sensitivity: Variable names are case-insensitive. [Client First Name] and [client first name] will map to the same field.
• Default Behaviors:
  • Variables containing the word name default to there if left empty.
  • Variables containing credentials or info default to Check inbox for setup link.
  • Variables containing link or url default to empty and follow smart hyperlinking.

3. Zoho-Friendly Hyperlinking

To keep emails looking human, we format links over words (e.g. here) rather than pasting raw URLs.

• Syntax: Use the standard markdown link format, putting the variable placeholder inside the URL parentheses:
  You can view your report [here]([AI Roadmap Link]).
• Fallback logic:
  • If the user types a link (e.g. https://docs.google.com/test), it renders as:
    You can view your report <a href="https://docs.google.com/test">here</a>. (Arial 10pt)
  • If the link field is left empty or default, it renders as plain text:
    You can view your report [insert ai roadmap link here]. (No active link is generated).

4. Markdown Formatting Support

The Email Composer translates standard Markdown syntax into Zoho-compatible, inline-styled HTML blocks:

5. Programmatic Compilation (AI / CLI)

AI agents can compile this file automatically by running:

node execution/compile_email.js --template "vault/Obsidian Vault/garden/Templates/Template Guide.md" --vars "{\"Client First Name\": \"John\", \"AI Roadmap Link\": \"https://link.com\"}"