$mail->sendHTML() method

Send an email with given message text assumed to be HTML

This is just like the $mail->send() method with the exception that the body argument is assumed to be HTML rather than text. Note that the text version of the email is auto generated from the HTML, unless a body is provided in the $options array.

Usage

// basic usage
$int = $mail->sendHTML();

// usage with all arguments
$int = $mail->sendHTML($to = '', string $from = '', string $subject = '', string $bodyHTML = '', $options = []);

Arguments

NameType(s)Description
to (optional)string, array

Email address TO. For multiple, specify CSV string or array.

from (optional)string

Email address FROM. This may be an email address, or a combined name and email address. Example of combined name and email: `Karen Cramer <karen

subject (optional)string

Email subject

bodyHTML (optional)string

Email body in HTML

options (optional)array, string

Array of options OR the $bodyHTML string. Array $options are:

  • body (string): Email body (text)
  • replyTo (string): Reply-to email address
  • headers (array): Associative array of header name => header value
  • Any additional options will be sent along to the WireMail module or class, in tact.

Return value

int WireMail

Returns number of messages sent or WireMail object if no arguments specified.


$mail methods and properties

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer