Problem/Motivation

Varbase Starter applies the Easy Email Express recipe. Easy Email Theme then takes the email logo from the default theme, Varbase Theme - Bootstrap 5, whose logo is logo.svg. About 24% of email clients tested by caniemail cannot show SVG, including Outlook for Windows 2007 to 2016 and Gmail webmail, so many readers get an email with no logo (the Gmail case is also #3554103).

Easy Email Theme is a hidden theme, so there is no settings form to change the email logo, and easy_email_theme.settings does not exist on a fresh install.

Steps to reproduce

  1. Install Varbase 11.0.x-dev with Varbase Starter 1.0.x-dev (Drupal 11.4.12, Easy Email 3.0.9, Easy Email Theme 1.1.0).
  2. Send an HTML email, for example a password reset.
  3. The logo is an SVG image. It does not show in Outlook for Windows or Gmail webmail. Mailpit's HTML Check flags it.
  4. ddev drush config:get easy_email_theme.settings reports that the config does not exist.

Proposed resolution

Ship config/easy_email_theme.settings.yml in the recipe with logo.use_default: false and logo.path: themes/contrib/vartheme_bs5/logo-email.png, the PNG added in #3637288.

It is a config file, not a config action: Easy Email Theme ships no default settings, and simpleConfigUpdate cannot create missing config. Recipes only create config that does not exist yet, so sites that already set a logo keep it.

Depends on #3637288 being released first. Until then the path points at a missing file and emails show no logo.

Remaining tasks

  • ✅ File an issue
  • ❌ Addition/Change/Update/Fix
  • ❌ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ➖ Developer Documentation support
  • ➖ User Guide Documentation support
  • ➖ UX/UI designer responsibilities
  • ❌ Accessibility and Readability
  • ❌ Reviewed by a human
  • ❌ Code review by maintainers
  • ❌ Full testing and approval
  • ❌ Credit contributors
  • ❌ Review with the product owner
  • ✅ Update Release Notes
  • ✅ Release

User interface changes

  • The logo shows in HTML emails in clients that cannot render SVG.

API changes

  • N/A

Data model changes

  • Adds easy_email_theme.settings config to the recipe.

Release notes snippet

  • HTML emails now use a PNG logo that shows in Outlook and Gmail.

AI-Generated: Yes

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

rajab natshah created an issue. See original summary.

rajab natshah’s picture

Status: Active » Needs review

MR !90 is ready for review. It needs the PNG from #3637288 released first.

rajab natshah’s picture

Before and after evidence for !90, tested on Varbase 11.0.x with Varbase Starter (Drupal 11.4.12, local DDEV + Mailpit).

Before: the password reset email on Varbase 11.0.x with Varbase Starter 1.0.x-dev. The header logo is the theme's logo.svg.

Password reset email with the Varbase wordmark at the top, a greeting, a blue Log in and reset your password button and closing text.

Before: Mailpit's HTML Check lists 20 warnings, including SVG image format. A linked SVG image is not supported in about 24% of tested email clients (Apple Mail, Outlook for Windows, several Gmail versions) and partly supported in about 12% more.

Mailpit HTML Check with 20 warnings. The SVG image format row is expanded, showing 64% supported, 12% partial and 24% not supported, followed by the list of affected email clients.

After: the same email with the new logo-email.png (150 x 30 PNG). It renders the same, and more email clients can show it.

Password reset email with the Varbase wordmark at the top, now a PNG image, above the greeting and the reset button.

After: HTML Check lists 19 warnings. The SVG image format warning is gone; the remaining rows are the same as before.

Mailpit HTML Check with 19 warnings, from margin to max-height property, with no SVG image format row.

The logo img src in the sent HTML: themes/contrib/vartheme_bs5/logo.svg before, themes/contrib/vartheme_bs5/logo-email.png after (set by Varbase Starter's easy_email_theme.settings.yml). Cropped from Mailpit's HTML Source tab.

Two lines of email HTML source, labelled Before and After. Before, the logo image points to logo.svg; after, it points to logo-email.png.

Short walkthrough, about 40 s, voice only: email-mr-01-png-logo.mp4

Release order: vartheme_bs5 !257 in #3637288 first, since this MR points at the logo-email.png it adds.

AI-Generated: Yes

rajab natshah’s picture

rajab natshah’s picture

  • rajab natshah committed 3af21053 on 1.0.x
    fix: #3637289 Use a PNG logo in HTML emails instead of the SVG site logo
    
rajab natshah’s picture

Issue summary: View changes
Status: Needs review » Fixed
Issue tags: +varbase_starter-1.0.10

✅ Released in varbase_starter 1.0.10

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.