HTML Mail

HTML Mail lets you theme your email messages the same way you theme the rest of your website.

HTML Mail for D10

emartoni and RenatoG have ported HTML Mail to D9/D10, and TR has done a great job to fix bugs, improve the structure and help everywhere -- thanks a lot to all of you!

We also need feedback on / help with the D10 documentation written by emartoni.

Please note that the active branch is 4.0.x which is compatible with Drupal 9.x through 10.1.x and likely 10.2.x also!

HTML Mail for D10

Installation (D10)

htmlmail works for current releases of D10 it is recommended for those for those who are not already using htmlmail to consider Symfony Mailer or Symfony Mailer Lite instead.

HTML Mail for D7

NOTE:

For the most up-to-date documentation, always refer to the README files in the HTML Mail module directory:

README for 7.x-2.x

Requirements

Mail System

Installation (D7)

The following additional modules, while not required, are highly recommended:

Echo

Wraps your messages in a drupal theme. Now you can "brand" your messages with the same logo, header, fonts, and styles as your website.
Emogrifier

Converts stylesheets to inline style rules, for consistent display on mobile devices and webmail.
Mail MIME

Provides a text/plain alternative to text/html emails, and automatically converts image references to inline image attachments.
Pathologic

Converts urls from relative to absolute, so clickable links in your email messages work as intended.
Transliteration

Converts non-ASCII characters to their US-ASCII equivalents, such as from Microsoft "smart-quotes" to regular quotes.

Updating from previous versions

Check the module dependencies, as they have changed. The latest version of HTML Mail depends on:
- Mail System
Run update.php immediately after uploading new code.
The user-interface for adding email header and footer text has been removed. Headers and footers may be added by template files and/or by enabling the Echo module.
Any customized filters should be carefully tested, as some of the template variables have changed. Full documentation is provided both on the module configuration page (Click on the Instructions link) and as comments within the htmlmail.tpl.php file itself.
Any combination of over 200 filter modules may be used to create an email-specific text format for post-template filtering.
Full MIME handling, including automatic generation of a plaintext alternative part and conversion of image references to inline image attachments, is available simply by enabling the Mail MIME module.

Configuration

Visit the Mail System settings page at /admin/config/mailsystem (D10) / /admin/settings/mailsystem (D7) to select which parts of Drupal will use HTML Mail instead of the default mail system.

Visit the HTML Mail settings page at /admin/settings/htmlmail to select a theme and post-filter for your messages.

Theming

The email message text goes through three transformations before sending:

Template File

A template file is applied to your message header, subject, and body text. The default template is the included htmlmail.tpl.php file. You may copy this file to your email theme directory (selected below), and use it to customize the contents and formatting of your messages. The comments within that file contain complete documentation on its usage.
Theming

You may choose a theme that will hold your templates from Step 1 above. If the Echo module is installed, this theme will also be used to wrap your templated text in a webpage. You use any one of over 800 themes to style your messages, or create your own for even more power and flexibility.
Post-filtering

You may choose a text format to be used for filtering email messages after theming. This allows you to use any combination of over 200 filter modules to make final changes to your message before sending.

Here is a recommended configuration:
- Emogrifier Converts stylesheets to inline style rules for consistent display on mobile devices and webmail.
- Transliteration Converts non-ASCII text to US-ASCII equivalents. This helps prevent Microsoft "smart-quotes" from appearing as question-marks in Mozilla Thunderbird.
- Pathologic Converts relative URLS to absolute URLS so that clickable links in your message will work as intended.

Troubleshooting

Check the online documentation, especially the screenshots.
There is a special documentation page for Using HTML Mail together with SMTP Authentication Support.
Simplenews users attempting advanced theming should read this page.
Double-check the Mail System module settings and and make sure you selected HTMLMailSystem for your Site-wide default mail system.
Try selecting the [ ] (Optional) Debug checkbox at the HTML Mail module settings page and re-sending your message.
Clear your cache after changing any .tpl.php files.
If you use a post-filter, make sure your filter settings page looks like this.
Visit the issue queue for support and feature requests.

Echo: https://drupal.org/project/echo
Emogrifier: https://drupal.org/project/emogrifier
HTML Purifier: https://drupal.org/project/htmlpurifier
htmLawed: https://drupal.org/project/htmlawed
Mail MIME: https://drupal.org/project/mailmime
Mail System: https://drupal.org/project/mailsystem
Pathologic: https://drupal.org/project/pathologic
Transliteration: https://drupal.org/project/transliteration

Documentation

**HTML Mail

filter.module: api.drupal.org/api/drupal/modules--filter--filter.module
Installing contributed modules: drupal.org/documentation/install/modules-themes/modules-5-6
Theming guide: drupal.org/documentation/theme

Original Author

Chris Herberte

Prior Maintainers

Current Maintainers

Project information

Seeking co-maintainer(s)
Maintainers are looking for help reviewing issues.
Maintenance fixes only
Considered feature-complete by its maintainers.
Module categories: E-commerce, Integrations
20,117 sites report using this module
Created by Christopher Herberte on 5 June 2007, updated 13 February 2024
Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.