$mailsendHTML()

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.251