mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-10 16:54:44 +02:00
Code Issues Releases Wiki Activity

Add $mail->sendHTML() and $mail->mailHTML() methods which are the same as their send() and mail() counterparts, but assume the given message body is HTML, and text-body is auto-generated.

Browse Source
This commit is contained in:
Ryan Cramer
2018-06-01 09:17:37 -04:00
parent c0437702ce
commit ecf812224f
1 changed files with 54 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
wire/core/WireMailTools.php
View File

@@ -3,7 +3,7 @@
/** /**
* ProcessWire Mail Tools ($mail API variable) * ProcessWire Mail Tools ($mail API variable)
* *
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer * ProcessWire 3.x, Copyright 2018 by Ryan Cramer
* https://processwire.com * https://processwire.com
* *
* #pw-summary Provides an API interface to email and WireMail. * #pw-summary Provides an API interface to email and WireMail.
@@ -180,6 +180,31 @@ class WireMailTools extends Wire {
return $numSent; return $numSent;
} }
/**
* 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.
*
* @param string|array $to Email address TO. For multiple, specify CSV string or array.
* @param string $from 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@processwire.com>`
* @param string $subject Email subject
* @param string $bodyHTML Email body in HTML
* @param array|string $options 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 int|WireMail Returns number of messages sent or WireMail object if no arguments specified.
*
*/
public function sendHTML($to = '', $from = '', $subject = '', $bodyHTML = '', $options = array()) {
$options['bodyHTML'] = $bodyHTML;
return $this->send($to, $from, $subject, $options);
}
/** /**
* Send an email, drop-in replacement for PHP mail() that uses the same arguments * Send an email, drop-in replacement for PHP mail() that uses the same arguments
* *
@@ -259,6 +284,34 @@ class WireMailTools extends Wire {
return $qty > 0; return $qty > 0;
} }
/**
* Send an email with message assumed to be in HTML
*
* This is the same as the `$mail->mail()` method except that the message argument is
* assumed to be HTML rather than text. The text version of the email will be auto-generated
* from the given HTML.
*
* @param string|array $to Email address TO. For multiple, specify CSV string or array.
* @param string $subject Email subject
* @param string|array Email message in HTML
* @param array $headers Optional additional headers as [name=value] array or "Name: Value" newline-separated string.
* Use this argument to duplicate PHP mail() style arguments. No need to use if you used $options array for the $message argument.
* @return bool True on success, false on fail.
*
*/
public function mailHTML($to, $subject, $messageHTML, $headers = array()) {
if(is_array($messageHTML)) {
$options = $messageHTML;
if(!empty($headers) && empty($options['headers'])) $options['headers'] = $headers;
} else {
$options = array(
'bodyHTML' => $messageHTML,
'headers' => $headers
);
}
return $this->mail($to, $subject, $options);
}
public function __get($key) { public function __get($key) {
if($key === 'new') return $this->new(); if($key === 'new') return $this->new();
return parent::__get($key); return parent::__get($key);