Robot
d1e1a56671
Move beta to main repo. Fix #1053 so that the right and left tabs display correctly in Joomla 4&5.
475 lines
14 KiB
PHP
475 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 4th September 2022
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
// No direct access to this JCB template file (EVER)
|
|
defined('_JCB_TEMPLATE') or die;
|
|
?>
|
|
###BOM###
|
|
namespace ###NAMESPACEPREFIX###\Component\###ComponentNameSpace###\Administrator\Helper;
|
|
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\Component\ComponentHelper;
|
|
use Joomla\CMS\Mail\Mail;
|
|
use Joomla\Registry\Registry;
|
|
|
|
// No direct access to this file
|
|
\defined('_JEXEC') or die;
|
|
|
|
/**
|
|
* ###Component### component email helper
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
abstract class ###Component###Email
|
|
{
|
|
/**
|
|
* The active recipient
|
|
*
|
|
* @var activeRecipient (array)
|
|
*/
|
|
public static $active = [];
|
|
|
|
/**
|
|
* Configuraiton object
|
|
*
|
|
* @var Registry
|
|
*/
|
|
public static ?Registry $config = null;
|
|
|
|
/**
|
|
* Mailer object
|
|
*
|
|
* @var Mail
|
|
*/
|
|
public static ?Mail $mailer = null;
|
|
|
|
/**
|
|
* Custom Headers
|
|
*
|
|
* @var array
|
|
*/
|
|
protected static array $header = [];
|
|
|
|
/**
|
|
* Get a configuration object
|
|
*
|
|
*/
|
|
public static function getConfig()
|
|
{
|
|
if (!self::$config)
|
|
{
|
|
self::$config = ComponentHelper::getParams('com_###component###');
|
|
}
|
|
|
|
return self::$config;
|
|
}
|
|
|
|
/**
|
|
* Returns the global mailer object, only creating it if it doesn't already exist.
|
|
*
|
|
*/
|
|
public static function getMailerInstance()
|
|
{
|
|
if (!self::$mailer)
|
|
{
|
|
self::$mailer = self::createMailer();
|
|
}
|
|
|
|
return self::$mailer;
|
|
}
|
|
|
|
/**
|
|
* Check that a string looks like an email address.
|
|
* @param string $address The email address to check
|
|
* @param string|callable $patternselect A selector for the validation pattern to use :
|
|
* * `auto` Pick best pattern automatically;
|
|
* * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;
|
|
* * `pcre` Use old PCRE implementation;
|
|
* * `php` Use PHP built-in FILTER_VALIDATE_EMAIL;
|
|
* * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements.
|
|
* * `noregex` Don't use a regex: super fast, really dumb.
|
|
* Alternatively you may pass in a callable to inject your own validator, for example:
|
|
* PHPMailer::validateAddress('user@example.com', function($address) {
|
|
* return (strpos($address, '@') !== false);
|
|
* });
|
|
* You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.
|
|
* @return boolean
|
|
* @static
|
|
* @access public
|
|
*/
|
|
public static function validateAddress($address, $patternselect = null): bool
|
|
{
|
|
return self::getMailerInstance()->validateAddress($address, $patternselect);
|
|
}
|
|
|
|
/**
|
|
* Get a mailer object.
|
|
*
|
|
* Returns the global {@link Mail} object, only creating it if it doesn't already exist.
|
|
*
|
|
* @return Mail object
|
|
*
|
|
* @see Mail
|
|
*/
|
|
public static function getMailer(): Mail
|
|
{
|
|
if (!self::$mailer)
|
|
{
|
|
self::$mailer = self::createMailer();
|
|
}
|
|
|
|
$copy = clone self::$mailer;
|
|
|
|
return $copy;
|
|
}
|
|
|
|
/**
|
|
* Create a mailer object
|
|
*
|
|
* @return Mail object
|
|
*
|
|
* @see Mail
|
|
*/
|
|
protected static function createMailer(): Mail
|
|
{
|
|
// set component params
|
|
$conf = self::getConfig();
|
|
|
|
// now load the mailer
|
|
$mailer = $conf->get('mailer', 'global');
|
|
|
|
// Create a Mail object
|
|
$mail = Mail::getInstance();
|
|
|
|
// check if set to global
|
|
if ('global' == $mailer)
|
|
{
|
|
// get the global details
|
|
$globalConf = Factory::getConfig();
|
|
|
|
$mailer = $globalConf->get('mailer');
|
|
$smtpauth = ($globalConf->get('smtpauth') == 0) ? null : 1;
|
|
$smtpuser = $globalConf->get('smtpuser');
|
|
$smtppass = $globalConf->get('smtppass');
|
|
$smtphost = $globalConf->get('smtphost');
|
|
$smtpsecure = $globalConf->get('smtpsecure');
|
|
$smtpport = $globalConf->get('smtpport');
|
|
$sendmail = $globalConf->get('sendmail');
|
|
$mailfrom = $globalConf->get('mailfrom');
|
|
$fromname = $globalConf->get('fromname');
|
|
$replyto = $globalConf->get('replyto');
|
|
$replytoname = $globalConf->get('replytoname');
|
|
}
|
|
else
|
|
{
|
|
$smtpauth = ($conf->get('smtpauth') == 0) ? null : 1;
|
|
$smtpuser = $conf->get('smtpuser');
|
|
$smtppass = $conf->get('smtppass');
|
|
$smtphost = $conf->get('smtphost');
|
|
$smtpsecure = $conf->get('smtpsecure');
|
|
$smtpport = $conf->get('smtpport');
|
|
$sendmail = $conf->get('sendmail');
|
|
$mailfrom = $conf->get('emailfrom');
|
|
$fromname = $conf->get('fromname');
|
|
$replyto = $conf->get('replyto');
|
|
$replytoname = $conf->get('replytoname');
|
|
}
|
|
|
|
// Set global sender
|
|
$mail->setSender(array($mailfrom, $fromname));
|
|
|
|
// set the global reply-to if found
|
|
if ($replyto && $replytoname)
|
|
{
|
|
$mail->ClearReplyTos();
|
|
$mail->addReplyTo($replyto, $replytoname);
|
|
}
|
|
|
|
// Default mailer is to use PHP's mail function
|
|
switch ($mailer)
|
|
{
|
|
case 'smtp':
|
|
// set the SMTP option
|
|
$mail->useSMTP($smtpauth, $smtphost, $smtpuser, $smtppass, $smtpsecure, $smtpport);
|
|
break;
|
|
|
|
case 'sendmail':
|
|
// set the sendmail option
|
|
$mail->useSendmail($sendmail);
|
|
$mail->IsSendmail();
|
|
break;
|
|
|
|
default:
|
|
$mail->IsMail();
|
|
break;
|
|
}
|
|
|
|
return $mail;
|
|
}
|
|
|
|
/**
|
|
* Set a Mail custom header.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function setHeader($target, $value)
|
|
{
|
|
// set the header
|
|
self::$header[$target] = $value;
|
|
}
|
|
|
|
/**
|
|
* Send an email
|
|
*
|
|
* @return bool on success
|
|
*
|
|
*/
|
|
public static function send($recipient, $subject, $body, $textonly, $mode = 0, $bounce_email = null, $idsession = null, $mailreply = null, $replyname = null , $mailfrom = null, $fromname = null, $cc = null, $bcc = null, $attachment = null, $embeded = null , $embeds = null)
|
|
{
|
|
// Get a Mail instance
|
|
$mail = self::getMailer();
|
|
|
|
// set component params
|
|
$conf = self::getConfig();
|
|
|
|
// set if we have override
|
|
if ($mailfrom && $fromname)
|
|
{
|
|
$mail->setSender(array($mailfrom, $fromname));
|
|
}
|
|
|
|
// load the bounce email as sender if set
|
|
if (!is_null($bounce_email))
|
|
{
|
|
$mail->Sender = $bounce_email;
|
|
}
|
|
|
|
// Add tag to email to identify it
|
|
if (!is_null($idsession))
|
|
{
|
|
$mail->addCustomHeader('X-VDMmethodID:'.$idsession);
|
|
}
|
|
|
|
// set headers if found
|
|
if (isset(self::$header) && is_array(self::$header) && count((array)self::$header) > 0)
|
|
{
|
|
foreach (self::$header as $_target => $_value)
|
|
{
|
|
$mail->addCustomHeader($_target.':'.$_value);
|
|
}
|
|
}
|
|
|
|
// set the subject & Body
|
|
$mail->setSubject($subject);
|
|
$mail->setBody($body);
|
|
|
|
// Are we sending the email as HTML?
|
|
if ($mode)
|
|
{
|
|
$mail->IsHTML(true);
|
|
$mail->AltBody = $textonly;
|
|
}
|
|
|
|
//embed images
|
|
if ($embeded)
|
|
{
|
|
if(Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check($embeds))
|
|
{
|
|
foreach($embeds as $embed)
|
|
{
|
|
$mail->AddEmbeddedImage($embed->Path,$embed->FileName);
|
|
}
|
|
}
|
|
}
|
|
|
|
$mail->addRecipient($recipient);
|
|
$mail->addCC($cc);
|
|
$mail->addBCC($bcc);
|
|
$mail->addAttachment($attachment);
|
|
|
|
// Take care of reply email addresses
|
|
if (is_array($mailreply))
|
|
{
|
|
$mail->ClearReplyTos();
|
|
$numReplyTo = count((array)$mailreply);
|
|
for ($i=0; $i < $numReplyTo; $i++)
|
|
{
|
|
$mail->addReplyTo($mailreply[$i], $replyname[$i]);
|
|
}
|
|
}
|
|
elseif (!empty($mailreply))
|
|
{
|
|
$mail->ClearReplyTos();
|
|
$mail->addReplyTo($mailreply, $replyname);
|
|
}
|
|
|
|
// check if we can add the DKIM to email
|
|
if ($conf->get('enable_dkim'))
|
|
{
|
|
if (!empty($conf->get('dkim_domain')) && !empty($conf->get('dkim_selector')) && !empty($conf->get('dkim_private')) && !empty($conf->get('dkim_public')))
|
|
{
|
|
$mail->DKIM_domain = $conf->get('dkim_domain');
|
|
$mail->DKIM_selector = $conf->get('dkim_selector');
|
|
$mail->DKIM_identity = $conf->get('dkim_identity');
|
|
$mail->DKIM_passphrase = $conf->get('dkim_passphrase');
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'VDM');
|
|
$h = fopen($tmp, 'w');
|
|
fwrite($h, $conf->get('dkim_private'));
|
|
fclose($h);
|
|
$mail->DKIM_private = $tmp;
|
|
}
|
|
}
|
|
|
|
$sendmail = $mail->Send();
|
|
|
|
if ($conf->get('enable_dkim') && !empty($conf->get('dkim_domain')) && !empty($conf->get('dkim_selector')) && !empty($conf->get('dkim_private')) && !empty($conf->get('dkim_public')))
|
|
{
|
|
@unlink($tmp);
|
|
}
|
|
|
|
if (method_exists('###Component###Helper','storeMessage'))
|
|
{
|
|
// if we have active recipient details
|
|
if (isset(self::$active[$recipient]))
|
|
{
|
|
// store the massage if the method is set
|
|
###Component###Helper::storeMessage($sendmail, self::$active[$recipient], $subject, $body, $textonly, $mode, 'email');
|
|
// clear memory
|
|
unset(self::$active[$recipient]);
|
|
}
|
|
else
|
|
{
|
|
// store the massage if the method is set
|
|
###Component###Helper::storeMessage($sendmail, $recipient, $subject, $body, $textonly, $mode, 'email');
|
|
}
|
|
}
|
|
|
|
return $sendmail;
|
|
}
|
|
|
|
/**
|
|
* Set html text (in a row) and subject (as title) to a email table.
|
|
* do not use <p> instead use <br />
|
|
* in your html that you pass to this method
|
|
* since it is a table row it does not
|
|
* work well with paragraphs
|
|
*
|
|
* @return string on success
|
|
*
|
|
*/
|
|
public static function setBasicBody($html, $subject)
|
|
{
|
|
$body = [];
|
|
$body[] = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">";
|
|
$body[] = "<html xmlns=\"http://www.w3.org/1999/xhtml\">";
|
|
$body[] = "<head>";
|
|
$body[] = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
|
|
$body[] = "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/>";
|
|
$body[] = "<title>" . $subject . "</title>";
|
|
$body[] = "<style type=\"text/css\">";
|
|
$body[] = "#outlook a {padding:0;}";
|
|
$body[] = ".ExternalClass {width:100%;}";
|
|
$body[] = ".ExternalClass, .ExternalClass p, .ExternalClass span, .ExternalClass font, .ExternalClass td, .ExternalClass div {line-height: 100%;} ";
|
|
$body[] = "p {margin: 0; padding: 0; font-size: 0px; line-height: 0px;} ";
|
|
$body[] = "table td {border-collapse: collapse;}";
|
|
$body[] = "table {border-collapse: collapse; mso-table-lspace:0pt; mso-table-rspace:0pt; }";
|
|
$body[] = "img {display: block; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic;}";
|
|
$body[] = "a img {border: none;}";
|
|
$body[] = "a {text-decoration: none; color: #000001;}";
|
|
$body[] = "a.phone {text-decoration: none; color: #000001 !important; pointer-events: auto; cursor: default;}";
|
|
$body[] = "span {font-size: 13px; line-height: 17px; font-family: monospace; color: #000001;}";
|
|
$body[] = "</style>";
|
|
$body[] = "<!--[if gte mso 9]>";
|
|
$body[] = "<style>";
|
|
$body[] = "/* Target Outlook 2007 and 2010 */";
|
|
$body[] = "</style>";
|
|
$body[] = "<![endif]-->";
|
|
$body[] = "</head>";
|
|
$body[] = "<body style=\"width:100%; margin:0; padding:0; -webkit-text-size-adjust:100%; -ms-text-size-adjust:100%;\">";
|
|
$body[] = $html;
|
|
$body[] = "</body>";
|
|
$body[] = "</html>";
|
|
|
|
return implode("\n", $body);
|
|
}
|
|
|
|
/**
|
|
* Set html text (in a row) and subject (as title) to a email table.
|
|
* do not use <p> instead use <br />
|
|
* in your html that you pass to this method
|
|
* since it is a table row it does not
|
|
* work well with paragraphs
|
|
*
|
|
* @return string on success
|
|
*
|
|
*/
|
|
public static function setTableBody($html, $subject)
|
|
{
|
|
$body = [];
|
|
$body[] = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">";
|
|
$body[] = "<html xmlns=\"http://www.w3.org/1999/xhtml\">";
|
|
$body[] = "<head>";
|
|
$body[] = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
|
|
$body[] = "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/>";
|
|
$body[] = "<title>" . $subject . "</title>";
|
|
$body[] = "<style type=\"text/css\">";
|
|
$body[] = "#outlook a {padding:0;}";
|
|
$body[] = ".ExternalClass {width:100%;}";
|
|
$body[] = ".ExternalClass, .ExternalClass p, .ExternalClass span, .ExternalClass font, .ExternalClass td, .ExternalClass div {line-height: 100%;} ";
|
|
$body[] = "p {margin: 0; padding: 0; font-size: 0px; line-height: 0px;} ";
|
|
$body[] = "table td {border-collapse: collapse;}";
|
|
$body[] = "table {border-collapse: collapse; mso-table-lspace:0pt; mso-table-rspace:0pt; }";
|
|
$body[] = "img {display: block; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic;}";
|
|
$body[] = "a img {border: none;}";
|
|
$body[] = "a {text-decoration: none; color: #000001;}";
|
|
$body[] = "a.phone {text-decoration: none; color: #000001 !important; pointer-events: auto; cursor: default;}";
|
|
$body[] = "span {font-size: 13px; line-height: 17px; font-family: monospace; color: #000001;}";
|
|
$body[] = "</style>";
|
|
$body[] = "<!--[if gte mso 9]>";
|
|
$body[] = "<style>";
|
|
$body[] = "/* Target Outlook 2007 and 2010 */";
|
|
$body[] = "</style>";
|
|
$body[] = "<![endif]-->";
|
|
$body[] = "</head>";
|
|
$body[] = "<body style=\"width:100%; margin:0; padding:0; -webkit-text-size-adjust:100%; -ms-text-size-adjust:100%;\">";
|
|
$body[] = "\n<!-- body wrapper -->";
|
|
$body[] = "<table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"margin:0; padding:0; width:100%; line-height: 100% !important;\">";
|
|
$body[] = "<tr>";
|
|
$body[] = "<td valign=\"top\">";
|
|
$body[] = "<!-- edge wrapper -->";
|
|
$body[] = "<table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"800\" >";
|
|
$body[] = "<tr>";
|
|
$body[] = "<td valign=\"top\">";
|
|
$body[] = "<!-- content wrapper -->";
|
|
$body[] = "<table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"780\">";
|
|
$body[] = "<tr>";
|
|
$body[] = "<td valign=\"top\" style=\"vertical-align: top;\">";
|
|
$body[] = $html;
|
|
$body[] = "</td>";
|
|
$body[] = "</tr>";
|
|
$body[] = "</table>";
|
|
$body[] = "<!-- / content wrapper -->";
|
|
$body[] = "</td>";
|
|
$body[] = "</tr>";
|
|
$body[] = "</table>";
|
|
$body[] = "<!-- / edge wrapper -->";
|
|
$body[] = "</td>";
|
|
$body[] = "</tr>";
|
|
$body[] = "</table>";
|
|
$body[] = "<!-- / page wrapper -->";
|
|
$body[] = "</body>";
|
|
$body[] = "</html>";
|
|
|
|
return implode("\n", $body);
|
|
}
|
|
}
|