$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.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits