# Generate Mc Trx Email
> Generate a new Mailchimp transactional email template set (HTML, txt, metadata). Use when the user asks to generate a transactional email, create an email template, or add a trx email.
- Skill: `aravinds-wick/generate-mc-trx-email` (Agent Skill)
- Install (CLI): `npx skillmds@latest add aravinds-wick/generate-mc-trx-email`
- Raw SKILL.md: https://api.skillmd.com/api/skills/aravinds-wick/generate-mc-trx-email/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Web & Frontend
- Author: AravindS-Wick (https://skillmd.com/u/aravinds-wick)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/aravinds-wick/generate-mc-trx-email
---
# Generate Mailchimp Transactional Email
## Overview
Generate a new transactional email template set following Mailchimp's email template standards. See `.agent/rules/transactional-email-html.mdc` for usage patterns.
## Required Information
**Gather the following from the user before proceeding:**
1. **Template Name** (snake_case): e.g., `my_new_email_template`
2. **Display Name**: Human-readable name, e.g., "My New Email Template"
3. **Email Type**: One of:
- `Transactional (No Opt)` - User cannot opt out
- `Transactional (Opt In/Out)` - User can opt in/out
- `Time-based Send` - Scheduled sends
4. **Description/Notes**: Brief description of when this email is sent
5. **Category**: e.g., `user notification`, `billing`, `compliance`, `onboarding`, `security`, `access`, `mcco`, `GDPR`, `audiences`, etc.
6. **Active**: Usually `Y` (yes) or `N` (no)
7. **Subject Line**: The email subject
8. **Preview Text**: Short preview text for email clients
9. **Email Content**: Main body content (headline, body paragraphs, CTA button text and URL)
10. **Merge Variables** (optional at this stage): List of dynamic variables needed (e.g., `*|USERNAME|*`, `*|ACCOUNT_NAME|*`)
> **Note on Merge Variables:** There are two types of merge variables:
> - **Data merge variables**: Dynamic data like `*|USERNAME|*`, `*|ACCOUNT_NAME|*`, `*|CTA_URL|*`
> - **Translation merge variables**: Translatable strings like `*|HEADING_TEXT|*`, `*|BODY_TEXT|*`, `*|CTA_TEXT|*`
>
> **You don't need all merge variables defined upfront.** If merge variables aren't available yet, use the hardcoded text from the design. The template can be updated later to use merge variables when they're ready. This should not block template creation.
## Files to Create/Update
### 1. Create Template Folder
Create folder: `data/email_templates/{template_name}/`
### 2. Create `email.html`
Use the template structure from `.agent/rules/transactional-email-html.mdc`. The HTML should include:
- Transaction ID comment: `` (next available ID)
- Standard reset and client-specific styles
- Mobile responsive media queries (480px breakpoint)
- Mailchimp logo
- Headline (H1 with Georgia serif font stack)
- Body content (Helvetica Neue sans-serif font stack)
- CTA button (usually teal #017E89)
- Standard footer with copyright, Contact Us, Terms of Use, Privacy Policy
**Example HTML structure:**
```html
*|SUBJECT|*
```
### 3. Create `email.txt`
Plain text version of the email. Key formatting rules:
- **Hyperlinks**: Always in parentheses, e.g., `(https://www.mailchimp.com)`
- **Button area**: 20 dashes (`--------------------`) above and below the button text/URL
- **Footer separator**: 30 dashes (`------------------------------`) to separate footer from body
- **No HTML or special characters**: This is plain text only
**Example structure:**
```
Headline
Body content goes here. Hyperlinks in plain text layouts are always in parentheses like this (https://www.mailchimp.com).
Additional paragraph content as needed.
--------------------
Button Text: https://mailchimp.com/link_to_button
--------------------
------------------------------
https://www.mailchimp.com
*|MC_MAILING_ADDRESS|*
Contact Us: https://www.mailchimp.com/contact/
Terms of Use: https://mailchimp.com/legal/terms/
Privacy Policy: https://mailchimp.com/legal/privacy/
```
> **Note:** Not having all merge variables should not block creating the `.txt` file. Use hardcoded text from the design.
>
> Some templates may have extra buttons, lists, or other layout items that don't fit this standard schema. For those cases, keep in mind this is plain text with no HTML or special characters. Reference existing `.txt` files in `data/email_templates/` for guidance on handling non-standard layouts.
### 4. Create `metadata.ini`
```ini
type = "Transactional (No Opt)"
name = "Display Name Here"
id = "trx_XXXX"
active = "Y"
notes = "Description of when this email is sent"
category = "user notification"
```
### 5. Update `data/email_templates/metadata.yaml`
Add entry at the end:
```yaml
template_name:
name: Display Name Here
type: Transactional (No Opt)
id: trx_XXXX
active: Y
notes: Description of when this email is sent
category: user notification
```
**Note:** Find the next available `trx_XXXX` ID by checking the highest ID currently in the file and incrementing by 1.
### 6. Update `tests/transactional-emails/test_merge_vars.php`
Add a test function at the appropriate location (either alphabetically or at the end before the closing):
```php
/**
* @db off
*/
function test_template_name()
{
$mail = new MC_Mail();
$mail->setBodyTemplate(
"template_name",
[
'MERGE_VAR_1' => 'Test Value 1',
'MERGE_VAR_2' => 'Test Value 2',
// Add all merge variables used in the template
]
);
$mail->systemSend();
}
```
> **Note:** If merge variables aren't available yet and you can't write a complete test, you can temporarily exclude the template from the test suite by adding it to the `$excluded` array at the top of `test_merge_vars()`:
>
> ```php
> $excluded = [
> // ... existing exclusions ...
> "/your_template_name", // TODO: Add test when merge vars are ready
> ];
> ```
>
> This should not block template creation. Remember to remove the exclusion and add a proper test function once the merge variables are defined.
**Important:** The test function name must be `test_` followed by the template name with:
- `/` replaced with `__` (double underscore)
- `-` replaced with `_` (single underscore)
Example: `branded_domains/error/issuing` → `test_branded_domains__error__issuing`
## Checklist
Before completing, verify:
- [ ] Folder created: `data/email_templates/{template_name}/`
- [ ] `email.html` created with correct trx_ID comment
- [ ] `email.txt` created
- [ ] `metadata.ini` created with unique trx_ID
- [ ] `metadata.yaml` updated with new entry
- [ ] Test function added to `test_merge_vars.php`
- [ ] All merge variables are documented and included in test
- [ ] HTML follows Mailchimp email guidelines (table-based, inline styles, mobile responsive)
## Common Merge Variables
There are two types of merge variables:
### Data Merge Variables
Dynamic data populated at send time:
- `*|CURRENT_YEAR|*` - Current year (e.g., 2024)
- `*|MC_MAILING_ADDRESS|*` - Mailchimp mailing address
- `*|USERNAME|*` - User's username
- `*|FNAME|*` - User's first name
- `*|LNAME|*` - User's last name
- `*|ACCOUNT_NAME|*` - Account name
- `*|EMAIL_ADDRESS|*` - User's email
- `*|UID|*` or `*|USERID|*` - User ID
- `*|CTA_URL|*` - Call-to-action URL
### Translation Merge Variables
Translatable strings that support i18n:
- `*|SUBJECT|*` - Email subject line
- `*|PREVIEW_TEXT|*` - Preview text for email clients
- `*|HEADLINE|*` or `*|HEADING_TEXT|*` - Main headline
- `*|BODY_TEXT|*` - Body content
- `*|CTA_TEXT|*` - Button text
- `*|CONTACT_US|*`, `*|TERMS_OF_USE|*`, `*|PRIVACY_POLICY|*` - Footer links
### Using Hardcoded Text
If merge variables aren't available yet, you can use hardcoded text directly in the template:
```html
*|HEADLINE|*
Your account has been updated
```
The template can be updated later to use merge variables when translation/data systems are ready.
## References
- See `.agent/rules/transactional-email-html.mdc` for complete HTML email guidelines
- Existing templates in `data/email_templates/` for examples
- Test patterns in `tests/transactional-emails/test_merge_vars.php`
