Missing email template descriptions
Why is this an issue?
An email template's wording goes out to customers, often automatically, and neither its name nor its subject line says what triggers it or who receives it. A description is where that can be recorded, alongside the template itself. Descriptions help administrators:
Understand when a template is sent, and by what, before editing its wording
Tell templates apart when several have similar names or subject lines
Examples
Example of incorrect metadata:
<EmailTemplate>
<name>Renewal Reminder</name>
<subject>Your renewal is due</subject>
</EmailTemplate>
Example of correct metadata:
<EmailTemplate>
<description>Sent 30 days before a subscription renews. Triggered by the Renewal Reminder flow.</description>
<name>Renewal Reminder</name>
<subject>Your renewal is due</subject>
</EmailTemplate>
How can I fix violations?
Add a description saying when the template is sent and what sends it.
The Setup path depends on the kind of template: classic templates are managed under Classic Email Templates, and Lightning templates are managed from the Email Templates tab. In both cases, open the template for editing, fill in its Description field, and save.
You can also set it directly in metadata:
<description>Sent 30 days before a subscription renews. Triggered by the Renewal Reminder flow.</description>
When should I disable this rule?
You may dismiss specific violations for templates kept only for testing or migration.
Resources