Vermonta // Technical documentation

Literra.Magento 2 manual for email templates, installation and deployment

Beautiful emails. No extra work.

This manual guides you through installing the Literra extension for Magento 2, choosing from twelve designs and the custom option, previewing emails, sending tests and enabling Literra in production. It also covers updates, static content deployment and troubleshooting typical Magento email issues.

Module: Vermonta_LiterraPlatform: Magento 2Frontend: Not dependent on Hyvä
Chapter 01

Overview and features

Literra is a Magento 2 extension that applies a consistent visual design to standard HTML emails that have already been rendered . Rather than replacing every Magento template manually, you select a design in the admin. Literra applies its styling through the supported Magento template renderer.

One design for customer communication after checkout.Literra handles presentation. Magento and your installed store modules continue to supply message content, order values, shipping details, payment information and email delivery.
Design

12 + 1 options

Twelve visible presets from the Classic, Modern and Minimal families, plus Custom / Store Colors.

Configuration

Per Store View

Design, primary and accent colors, and activation are configured within the selected scope.

Preview

21 email types

Sales and status emails use real data; other standard emails use safe sample data.

Daily workflow

Preview and test email

Preview in the Literra dashboard or directly from an order; test sending for suitable real emails.

Additional features include storefront color detection, the existing Magento email logo, responsive styling, carefully structured payment information, a test address saved per Store View and a deliberately streamlined admin interface.

No new mail engine: Literra is not an SMTP provider, a newsletter system, a drag-and-drop editor or a generator for invoices or PDFs. It does not replace the content of Magento email templates or modify prices or payment methods.
Chapter 02

Requirements before installation

AreaRequirementNotes
MagentoMagento 2 with a working admin and email templatesVerify your specific Magento and PHP combination in a test environment. This manual does not provide an exhaustive verified compatibility matrix.
PHPA PHP version supported by your Magento installationFollow the system requirements for your Magento version and the technical requirements of the Literra package supplied to you.
PermissionsShell access to the Magento root directory and suitable admin ACL permissionsRequired for module installation, compilation, deployment and cache operations.
Email deliveryConfigured Magento mail transportTest emails use the existing delivery configuration. Literra does not install an SMTP server.
Color detectioncURL and a publicly accessible storefrontColor detection reads storefront HTML/CSS only when explicitly requested. Password-protected staging sites may not be fully analyzable.
FrontendNo specific storefront theme requiredLiterra is not limited to Hyvä. Still test customizations and third-party modules.
Store operationWorking Magento orders and, where relevant, existing shipment, invoice and credit memo documentsRequired for realistic previews and test emails.
Before installing in production: Create current file and database backups, retain the previous module version and test the package on a staging instance first. Run commands as the Magento file owner.
Chapter 03

Installing Literra in Magento 2

Magento installation commands

Shell · Initial installation
php bin/magento module:enable Vermonta_Literra
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f de_DE de_CH en_US
php bin/magento cache:flush
php bin/magento module:status Vermonta_Literra

The module files must already be present in app/code/Vermonta/Literra/ before you run these commands from the Magento root directory. Include your actual admin locales when deploying static content; your installation may need additional locales. In development mode, static content deployment may not be necessary after every change. For production, it is part of a proper release process.

Installation successful: module:status lists Vermonta_Literra as enabled, Literra appears in the Magento admin and the design previews load correctly.
Chapter 04

Deploying to production

Deploying a module to a live Magento 2 store should be controlled. Back up the store, transfer the tested module and follow your Magento environment's normal maintenance procedures. The commands in Chapter 03 include compilation, static content deployment and cache clearing.

Maintenance note: If you use Magento maintenance mode during deployment, leave it enabled until the commands have completed successfully and you have performed a functional check. If errors occur, resolve them or restore the previously tested version.

Why static content deployment matters

The Literra dashboard uses admin CSS and JavaScript for design tiles, color detection, previews and interactions. Missing assets after an update can cause an unstyled screen or nonfunctional controls. Compilation alone does not reliably publish these browser assets.

Shell · When admin assets are missing
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f de_DE en_US
php bin/magento cache:flush

Manually deleting entire directories such as vendor/ or generated/ is not necessary for a normal Literra installation. Respect existing CI/CD workflows, file ownership, symlinks and release directories managed by your hosting provider.

Chapter 05

Opening Literra in the Magento admin

In the Magento admin, navigate to Marketing → Communications → Literra. The main Literra dashboard contains Store View selection, design tiles, custom colors, activation, email previews and test sending.

Select the Store View at the top left

Choose the specific Store View for which you want to configure Literra. Existing orders retain their original Store View context.

Choose a design

All twelve presets are displayed at once in large tiles. Select Custom / Store Colors to use your own colors instead.

Set colors if using Custom

Enter a primary and an accent color manually or start the built-in color detection.

Save settings

Use Save settings to apply your selection. Simply clicking a suggested color does not save it permanently.

Check the email preview

Choose an email type, select a real order if needed, and generate a preview. Also test delivery for eligible emails.

Enable Literra

Enable Literra in the selected Store View only after successful testing, then save your settings again.

Minimal settings: There is no separate salutation option. Existing Magento email text and greetings remain authoritative. Continue to manage the email logo in Magento.
Chapter 06

The twelve email designs and Custom

Literra includes twelve ready-made designs divided into three style families. The entire selection is visible in the admin at once. There are no hidden groups or tabs to navigate.

Style familyDesign presetsAppearance
ClassicClassic Navy
Classic Olive
Classic Burgundy
Classic Charcoal
Understated, classic color schemes with clear visual hierarchy.
ModernModern Ocean
Modern Coral
Modern Violet
Modern Forest
More vivid color accents and contemporary spacing.
MinimalMinimal Ink
Minimal Sand
Minimal Blue
Minimal Moss
Restrained color palettes and calm email layouts.
CustomCustom / Store ColorsYour own primary and accent colors based on the Modern layout.
What “twelve designs” means: Literra provides twelve coordinated presets, not twelve independent email rendering engines. Differences come from the style families, their colors and presentation. All use the same central Magento email process.

Choosing a preset

Select the correct Store View, click your preferred design tile, save the settings and check the result using a real email preview. Enable Literra for that Store View only when both design and content look right.

Chapter 07

Automatically detecting store colors

The thirteenth option, Custom / Store Colors , provides exactly two key values: primary and accent color. You can enter both manually. Literra can also check the public storefront and suggest suitable colors.

Select a Store View

Color detection uses the configured public URL of the selected Store View.

Choose Custom / Store Colors

Open the option with your own primary and accent colors.

Click “Use colors from my store”

Literra retrieves the publicly accessible storefront and a limited number of relevant CSS files.

Review the suggestions

Choose suggested primary, accent and, if offered, alternative colors. Check whether the detected values match your brand.

Save settings

Apply the chosen values and then check an email preview.

How color detection works

Literra examines HTML and CSS from the public storefront, including CSS variables and prominent colors used in buttons and navigation. It does not run continuously in the background or rely on an external AI service. The request happens only when initiated in the admin.

Network protection: Requests are restricted to the configured store domain and permitted public destinations. Time, size, redirect and CSS-file limits help prevent unintended access. Internal networks and arbitrary third-party hosts are not allowed as analysis targets.
If suitable colors cannot be found: Password-protected staging sites, blocked SSL connections, CSS hosted outside the store domain, or colors generated only by JavaScript can limit detection. Enter primary and accent colors manually instead.
Chapter 08

Store Views and activation

Magento stores can serve different languages, countries or brands through Store Views. Literra respects these boundaries, allowing a German Store View to use a different email design from an international one.

SettingEffect
Store View selectionSets the store context you are currently editing.
Enable / disable LiterraTurns Literra styling on or off for the selected Store View.
DesignSelects one of twelve presets or the Custom option.
Primary color / Accent colorSets the Custom colors for the selected Store View.
Test addressSaved separately for each Store View; Magento's General Contact address is used as a fallback if none has been saved.
Order Store View: A preview opened from an order uses that order's Store View. Take care not to evaluate a design under the wrong store context.

Recommended order for multiple Store Views

Start with one Store View. Test order and shipping emails, enable Literra and repeat setup for each remaining relevant Store View. Pay special attention to different languages, logo configurations and sender addresses.

Chapter 09

The 21 email types in Literra Preview

The admin preview provides 21 selectable standard email typesthrough one central selector. You do not need to trigger every Magento email just to evaluate its general design.

Two preview data sources: Sales-related messages and their status updates are rendered from suitable real orders or associated documents. Other email types use safe sample data. Sample previews are for visual inspection only and cannot be test-sent.
CategoryPreview contentData source
OrdersOrder confirmation and related status notificationsReal order from the selected Store View
ShipmentsShipping notification and related status updatesReal order with an existing shipment
InvoicesInvoice notification and related status updatesReal order with an existing invoice
Credit memosCredit memo notification and related status updatesReal order with an existing credit memo
Customer accountsWelcome email, account confirmation, passwords, account information changes and related Magento account messagesSafe sample data
NewslettersSubscription, confirmation and unsubscribe messages from Magento standard templatesSafe sample data
ContactStandard message from the Magento contact formSafe sample data

Previewing an order email

Choose a Store View

Select the Store View to which the order belongs.

Choose an email type

For example, order confirmation, shipment, invoice or credit memo.

Find a suitable order

Use the order picker. The order must belong to the selected Store View.

Use existing documents when required

Shipment, invoice and credit memo previews require the corresponding Magento documents to exist.

Show preview

Check the header, logo, products, prices, totals, addresses, payment details and mobile layout.

Sample previews

Account, password, newsletter and contact messages can be previewed without accessing someone else's account or triggering real password actions. Literra uses neutral sample data for these. Test sending is disabled in this mode.

Chapter 10

Literra Preview directly from an order

You can open Literra Preview without first visiting the main design dashboard. This is useful when a real order includes particular products, payment methods, shipping options or long billing addresses.

Open Magento orders

Navigate to Sales → Orders and open a suitable order.

Choose “Literra Preview”

Launch the preview using the action in the order view.

Choose an email type and review

Literra automatically uses the order's Store View and displays the saved design using that order's real information.

No order changes: Opening a preview does not create an order, change its status or send the regular customer email.
Chapter 11

Sending a test email from the admin

A browser preview is the first step. Seeing the actual message in Gmail, Outlook or Apple Mail is the second. For eligible real email types, Literra can send a test message to an address of your choice.

Search for an order in the input field

Type the order number directly into the order selection field. Literra displays matching orders for you to select. Choose the appropriate order and an email type for which real documents are available.

Check the test address

The address saved for the current Store View is prefilled. If none is saved, Magento's General Contact address is used.

Change and save the address if needed

You can save a test address for that Store View so it is available next time.

Send the test email

Use the test email function in Literra. Check the recipient inbox, spam folder and rendering in the email client.

General Contact: You can normally find Magento's default address under Stores → Configuration → General → Store Email Addresses → General Contact. This is the fallback test recipient, not automatically the destination for regular customer emails.
Check delivery status: A successful handoff to Magento's mail transport does not guarantee delivery to the recipient's inbox. Also check your email server, sending logs and spam folder.
Chapter 12

Which Magento 2 emails does Literra style?

Literra is designed for common Magento 2 standard HTML emails , including orders, shipments, invoices, credit memos, status notices and many account, password, newsletter and contact messages, provided they use supported Magento template processing.

What Literra deliberately does not replace

  • Magento rules for sender, recipient and when messages are sent
  • Order, tax, shipping, discount and early-payment discount calculations
  • Payment methods and their bank or PayPal information
  • Magento transactional data and existing documents
  • Custom plain-text emails, third-party renderers and other mail systems that bypass Magento template rendering
Chapter 14

Responsive emails and email clients

Literra uses the table structures commonly used in HTML emails and email-client-friendly formatting. The goal is consistent headers, content, product details and totals on desktop and mobile devices.

Recommended testing

  • Check mobile widths around 320 px, 360 px and 390 px.
  • Test long product names, bank names and dynamic payment details.
  • Check Gmail in the browser and in its mobile app.
  • Test Outlook and Apple Mail where relevant to your customers.
  • Pay special attention to widths, table wrapping, legibility and visible order totals.
Different rendering engines: Even responsive emails may look slightly different across clients because each renders HTML and CSS differently. No single design can guarantee identical rendering in every application or with every third-party HTML fragment.
Design guidance

Less is more: readability and deliverability

Transactional emails should make information clear and quick to access. Use legible text, clear headings and primary and accent colors sparingly. Additional animation, decorative images and extensive custom HTML are generally unnecessary for order and shipping notifications.

No spam guarantee: A restrained layout alone does not guarantee inbox delivery. Sender authentication (such as SPF, DKIM and DMARC), reputation, actual content and the chosen mail service's configuration also matter. Literra does not change these delivery settings.

The two color pickers on the public Literra product page are illustrative only. They do not send color selections to a server or modify Magento settings. Choose or detect actual store colors inside the Literra admin after installation.

Chapter 15

Pre-launch checklist

Run these checks for each Store View. Use orders with the payment and shipping methods your store actually offers.

  • Module is enabled; admin CSS and JavaScript load without errors.
  • Correct Store View selected, preferred preset or Custom option saved.
  • Custom colors and optional storefront color detection checked.
  • Magento email logo appears in both preview and real test email.
  • Order confirmation checked with real items, totals, taxes and shipping charges.
  • PayPal and bank transfer, including long payment details, tested without duplicate headings.
  • Shipments, invoices and credit memos checked using existing documents.
  • Account, password, newsletter and contact previews reviewed.
  • Test email sent to the correct saved test address and received.
  • Mobile rendering and at least one real email client checked.
  • Literra enabled and saved in the relevant Store View.
  • After launch, verify a regular store email without forcing a test involving live customer data.
Chapter 16

Troubleshooting and diagnostics

SymptomPossible causeWhat to do
Literra does not appear in the menuModule disabled, compilation issue or insufficient admin permissionsmodule:status Check module status, recompile and clear caches, review admin permissions and log in again.
Design tiles unstyled or buttons not workingAdmin CSS/JS not deployed or stale browser cacheDeploy static content for the required locales, clear Magento caches and reload the admin page.
Preview displays wrong language or designWrong Store View or order belongs to another scopeCheck the order's Store View and saved Literra settings.
Shipment, invoice or credit memo preview unavailableCorresponding document does not existSelect an order with an existing shipment, invoice or credit memo.
“No HTML MIME part found” / Symfony MIME errorMail transport or renderer does not return the expected HTML partCheck Magento/PHP mail compatibility, third-party email plugins and the HTML template; inspect the stack trace in var/log/ for more information.
Store View selector disabled or admin returns 404ACL or admin session after a module updateCheck role permissions, sign out/in, recompile and clear caches.
“Website ID not found”Invalid Store/Website contextCheck that the Store View exists and is linked to the correct website and order.
No suitable store colors detectedSSL, password protection, CSS on other hosts or colors generated by JavaScriptCheck public storefront access or enter the colors manually.
Logo missing only in delivered emailLogo URL or header path is not publicly accessibleCheck Magento Transactional Emails settings and whether the logo URL can be retrieved publicly.
Test email does not arriveMagento transport, SMTP or spam filteringCheck the outgoing email configuration and server logs. Successful sending does not guarantee delivery.
Duplicate PayPal label or misaligned payment blockOlder Literra installation or different payment HTMLCheck the installed Literra module, compilation and actual payment HTML. If necessary, provide an anonymized sample email for analysis.

General diagnostic commands

Shell · Magento root
php bin/magento module:status Vermonta_Literra
php bin/magento deploy:mode:show
php bin/magento cache:status
php bin/magento cache:flush

For PHP errors, inspect the Magento logs under var/log/ and your host's PHP logs. Investigate admin browser errors using the developer console and network tab.

Chapter 17

Literra Updates

Even a code-only update should be handled as a controlled Magento release. Avoid accidentally overwriting customized files. After updating, check payment information, long bank names and display in real email clients.

Update procedure

Back up the previous release

Keep a copy of the installed module, store configuration and a suitable database backup in case you need to restore the previous state.

Control activation while testing

Test in a staging Store View first, or disable Literra for the affected production Store View while validating the update.

Replace the module files completely

Transfer the tested files to app/code/Vermonta/Literra. Do not leave outdated files from earlier releases behind.

Run the Magento commands

Run setup and compilation, deploy admin assets and clear caches.

Retest real email content

Check order emails, PayPal/bank transfer, logo, shipments and test sending before enabling Literra again.

Shell · After transferring the update
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f de_DE de_CH en_US
php bin/magento cache:flush

If a critical issue occurs after updating, restore the last working module release along with the appropriate configuration and, if required, database backup. Run the Magento deployment commands required for that release. Simply copying old code back after database schema changes may not be sufficient.

No one-click downgrade guarantee: Magento setup changes can depend on the version. Discuss restoration procedures for major updates with your technical support provider.
Chapter 18

Operation, privacy and support

Processing email content

Literra processes email HTML within Magento and accesses existing orders for previews using real data. Test emails are sent to an administrator-selected address through Magento's existing mail transport. Treat test orders and preview information as personal store data.

Color detection

The optional color detector retrieves the public storefront. It does not continuously synchronize data or require an external AI cloud service. Network restrictions are designed to prevent unintended access to internal destinations.

Compatibility and limitations

Individual Magento installations may use different templates, third-party modules or custom renderers. These are not automatically covered by standard functionality. Check payment, shipping and SMTP extensions in particular if they modify email HTML independently.

Support and customization

To investigate formatting differences, provide the Magento version, Store View, affected email type, selected Literra design, an error description and, where possible, an anonymized .eml sample email in .eml format. The following services are separate offerings.

ServiceTermsScope
Technical product support6 months includedHelp with reproducible defects and security issues in the unmodified Literra extension, starting on the purchase date.
Support, updates and compatibility€249 excluding VAT / additional 6 monthsOptional renewal providing technical product support, available bug fixes, security updates and compatibility adjustments for the supported Magento environment.
Personal assistancePrice on requestIndividual installation, setup, assessment of custom email templates, modifications and integration into your Magento environment.
Optional renewal: The purchased Literra version remains usable without renewing support. All prices exclude VAT; applicable VAT is added. General Magento issues, third-party modules and customizations are not covered by standard product support.

Enquire about personal assistance and installation

Beautiful emails. No extra work.

Return to the product page to see all 12 designs, the custom option, the feature list and contact information.

Literra product page