View source
<h2>HTML Mail</h2>
<p>HTML Mail lets you theme your outgoing messages the same way you theme the rest of your website.</p>
<p>For a full description of the module, visit the <a href="http://drupal.org/project/htmlmail">project page</a>.</p>
<p>To submit bug reports and feature suggestions, visit the <a href="http://drupal.org/project/issues/htmlmail">issue queue</a>.</p>
<h2>Requirements</h2>
<p>HTML Mail requires the <a href="http://drupal.org/project/mailsystem">Mail System</a> module.</p>
<h2>Installation</h2>
<p>Install as usual; see <a href="http://drupal.org/node/895232">Installing contributed modules (Drupal 7)</a> for further information.</p>
<p>The following additional modules, while not required, are highly recommended:</p>
<ul>
<li>
<p><a href="http://drupal.org/project/emogrifier">Emogrifier</a></p>
</li>
<li>
<p><a href="http://drupal.org/project/pathologic">Pathologic</a></p>
</li>
<li>
<p><a href="http://drupal.org/project/transliteration">Transliteration</a></p>
<p><em>Requires a <a href="http://drupal.org/node/1095278#comment-4219530">patch</a>.</em></p>
</li>
</ul>
<h2>Configuration</h2>
<p>Visit the Mail System settings page at admin/config/system/mailsystem to select which parts of Drupal will use HTML Mail instead of the <a href="http://api.drupal.org/api/drupal/modules--system--system.mail.inc/class/DefaultMailSystem/7">default</a> <a href="http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/7">mail system</a>.</p>
<p>Visit the HTML Mail settings page at admin/config/system/htmlmail to select a theme, pre-filter, and post-filter for your emails.</p>
<h2>Theming</h2>
<p>The email message text goes through four transformations before sending:</p>
<ol>
<li>
<p>The <em>Text format pre-filter</em> from the module settings page is applied. This should be the same text format that your website uses for contributed content such as comments or blog postings. For consistency and security, it should include the the <a href="http://api.drupal.org/api/drupal/modules--filter--filter.module/function/_filter_htmlcorrector/7">Correct faulty and chopped off HTML</a> from <a href="http://api.drupal.org/api/drupal/modules--filter--filter.module/7">filter.module</a>, or a better replacement such as <a href="http://drupal.org/project/htmlpurifier">HTML Purifier</a> or <a href="http://drupal.org/project/htmlawed">htmLawed</a>.</p>
</li>
<li>
<p>A theme template is applied. The default template is the included <em>htmlmail.tpl.php</em> file. You may copy this file to your theme directory and use it to customize the contents and formatting of your emails. The comments within the file contain complete documentation on its usage.</p>
</li>
<li>
<p>The message may be wrapped in a website theme selected on the module settings page. Creating an email-specific theme lets you use the full power of the <a href="http://drupal.org/documentation/theme">drupal theme system</a> to format your emails.</p>
</li>
<li>
<p>The <em>Text format post-filter</em> from the module settings page is applied. For best results, this should be an email-specific input format containing the following text format filters:</p>
<ul>
<li><a href="http://drupal.org/node/1095278#comment-4219530">Transliteration</a></li>
<li><a href="http://drupal.org/project/emogrifier">Emogrifier</a></li>
<li><a href="http://drupal.org/project/pathologic">Pathologic</a></li>
<li><a href="http://api.drupal.org/api/drupal/modules--filter--filter.module/function/_filter_htmlcorrector/7">Correct faulty and chopped off HTML</a></li>
</ul>
</li>
</ol>
<h2>Related Modules</h2>
<p>Emogrifier : http://drupal.org/project/emogrifier</p>
<p>HTML Mail : http://drupal.org/project/htmlmail</p>
<p>HTML Purifier : http://drupal.org/project/htmlpurifier</p>
<p>htmLawed : http://drupal.org/project/htmlawed</p>
<p>Mail System : http://drupal.org/project/mailsystem</p>
<p>Pathologic : http://drupal.org/project/pathologic</p>
<p>Transliteration : http://drupal.org/project/transliteration</p>
<h2>Documentation</h2>
<p>filter.module : http://api.drupal.org/api/drupal/modules--filter--filter.module/7</p>
<p>Installing contributed modules (Drupal 7) : http://drupal.org/node/895232</p>
<p>Theming guide : http://drupal.org/documentation/theme</p>
<p>Standard filters : http://api.drupal.org/api/drupal/modules--filter--filter.module/group/standard_filters/7</p>
<h2>Maintainers</h2>
<ul>
<li>
<p><a href="http://drupal.org/user/1171">Chris Herberte</a></p>
</li>
<li>
<p><a href="http://drupal.org/user/36148">Bob Vincent</a></p>
</li>
</ul>
