Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

Lettr templates let you manage email designs in the Lettr dashboard while your application provides the dynamic data. This separation means designers can update email layouts without touching application code, and developers can change data without worrying about design. This page covers sending templates, versioning, projects, and syncing templates between Lettr and your local codebase. For type-safe template usage with generated enums and DTOs, see Type Safety.

​
Sending with Templates

The simplest way to send a template: 
use Illuminate\Support\Facades\Mail;

Mail::lettr()
    ->to('user@example.com')
    ->sendTemplate('welcome-email', 'Welcome!', [
        'first_name' => 'John',
        'activation_url' => 'https://example.com/activate/abc123',
    ]);
The array keys correspond to merge tags in your template (e.g., {{first_name}}). If a required merge tag is missing from the array, the tag renders as an empty string in the sent email. See Merge Tags & Template Language for the full syntax including conditionals and loops.

​
Type-Safe Templates

Generate enums, DTOs, and Mailable classes from your templates for compile-time safety: 
php artisan lettr:generate-enum   # Template slug enum
php artisan lettr:generate-dtos   # Merge tag DTOs
This catches typos in template slugs and missing merge tags at compile time rather than in production.

Type Safety

Generate enums, DTOs, and Mailables for compile-time safety

​
Template Versioning

Specify a template version to use a specific iteration: 
Mail::lettr()
    ->to('user@example.com')
    ->sendTemplate(
        templateSlug: 'welcome-email',
        subject: 'Welcome!',
        substitutionData: $data,
        version: 2  // Use version 2 of the template
    );
Omit the version to use the active (published) version. When to use versioning:
  • Production safety — Pin to a known-good version so publishing a new draft doesn’t affect live emails
  • A/B testing — Send different versions to different cohorts and compare metrics in Analytics
  • Gradual rollout — Test a new version with a subset of users before publishing it as the active version
See Versions for how versioning works in the Lettr dashboard.

​
Pull Templates Locally

Download templates from Lettr to edit locally as Blade files: 
php artisan lettr:pull
Options:
  • --template=slug - Pull a specific template
  • --as-html - Save as HTML instead of Blade
  • --with-mailables - Also generate Mailable classes
By default, templates are saved as Blade files to resources/views/emails/lettr/. HTML files go to resources/templates/lettr/. Both paths are configurable in config/lettr.php.
Use --with-mailables to generate ready-to-use Mailable classes alongside the templates. This is the fastest way to scaffold email classes from your existing Lettr templates.

​
Listing Templates

Retrieve available templates via the API: 
use Lettr\Laravel\Facades\Lettr;

$response = Lettr::templates()->list();

foreach ($response->templates as $template) {
    echo $template->name . ' (' . $template->slug . ')';
}
Get a specific template: 
$template = Lettr::templates()->get('welcome-email');

echo $template->name;
echo $template->activeVersion;
print_r($template->mergeTags);
The mergeTags property returns an array of merge tag names defined in the template, which is useful for validating your substitution data before sending.

​
What’s Next

Type Safety

Generate enums, DTOs, and Mailables for compile-time safety

Template Language

Full merge tag syntax including conditionals and loops

Projects & Folders

Organize templates into projects

Topol Editor

Design templates visually in the Lettr dashboard