2019-03-29 19:13:32 -05:00
< ? php
/*
* e107 website system
*
* Copyright ( C ) 2008 - 2013 e107 Inc ( e107 . org )
* Released under the terms and conditions of the
* GNU General Public License ( http :// www . gnu . org / licenses / gpl . txt )
*
* Mail handler
*/
/**
*
* @ package e107
* @ subpackage e107_handlers
*
* Mailout handler - concerned with processing and sending a single email
* Extends the PHPMailer class
*/
/*
TODO :
1. Mustn ' t include header in text section of emails
2. Option to wrap HTML in a standard header ( up to < body > ) and footer ( from </ body > )
Maybe each template is an array with several parts - optional header and footer , use defaults if not defined
header looks for the { STYLESHEET } variable
If we do that , can have a single override file , plus a core file
3. mail ( PHP method ) - note that it has parameters for additional headers and other parameters
4. Check that language support works - PHPMailer defaults to English if other files not available
- PHPMailer expects a 2 - letter code - $this -> SetLanguage ( CORE_LC ) - e . g . 'en' , 'br'
5. Logging :
- Use rolling log for errors - error string ( s ) available - sort out entry
- Look at support of some other logging options
2020-03-01 12:59:19 -08:00
9. Make sure SMTPDebug can be set ( true / false )
2019-03-29 19:13:32 -05:00
12. Check support for port number - ATM we just override for SSL . Looks as if phpmailer can take it from end of server link .
18. Note object iteration - may be useful for dump of object state
19. Consider overriding error handler
20. Look at using new prefs structure
21. Should we always send an ID ?
22. Force singleton so all mail sending flow controlled a bit ( but not where parameters overridden in constructor )
Tested so far ( with PHP4 version )
------------
SMTP send ( standard )
Return receipts
text or mixed
replyto
priority field
TLS to googlemail ( use TLS )
Notes if problems
-----------------
1. Attachment adding call had dirname () added round path .
2. There are legacy and new methods for generating a multi - part body ( HTML + plain text ) . Only the new method handles inline images .
- Currently uses the new method ( which is part of phpmailer )
General notes
-------------
1. Can specify a comma - separated list of smtp servers - presumably all require the same login credentials
2. qmail can be used ( if available ) by selecting sendmail , and setting the sendmail path to that for qmail instead
3. phpmailer does trim () on passed parameters where needed - so we don ' t need to .
4. phpmailer has its own list of MIME types .
5. Attachments - note method available for passing string attachments
- AddStringAttachment ( $string , $filename , $encoding , $type )
6. Several email address - related methods can accept two comma - separated strings , one for addresses and one for related names
2020-03-01 12:59:19 -08:00
7. Its possible to send a text - only email by passing an array of parameters including 'send_html' = false
2019-03-29 19:13:32 -05:00
8. For bulk emailing , must call the 'allSent()' method when complete to ensure SMTP mailer is properly closed .
9. For sending through googlemail ( and presumably gmail ), use TLS
10. Note that the 'add_html_header' option adds only the DOCTYPE bits - not the < head >....</ head > section
Possible Enhancements
---------------------
1. Support other fields :
ContentType
Encoding - ? ? ? . Defaults to 8 - bit
Preferences used :
$pref [ 'mailer' ] - connection type - SMTP , sendmail etc
$pref [ 'mail_options' ] - NEW - general mailing options
textonly - if true , defaults to plain text emails
hostname = text - used in Message ID and received headers , and default Helo string . ( Otherwise server - related default used )
$pref [ 'mail_log_options' ] - NEW . Logging options ( also used in mailout_process ) . Comma - separated list of values
1 - logenable - numeric value 0. . 3 controlling logging to a text file
2 - add_email - if '1' , the detail of the email is logged as well
$pref [ 'smtp_server' ] |
$pref [ 'smtp_username' ] | Server details . USed for POP3 server if POP before SMTP authorisation
$pref [ 'smtp_password' ] |
$pref [ 'smtp_keepalive' ] - deprecated in favour of option - flag
$pref [ 'smtp_pop3auth' ] - deprecated in favour of option - POP before SMTP authorisation flag
$pref [ 'smtp_options' ] - NEW - comma separated list :
keepalive - If active , bulk email send keeps the SMTP connection open , closing it every $pref [ 'mail_pause' ] emails
useVERP - formats return path to facilitate bounce processing
secure = [ TLS | SSL ] - enable secure authorisation by TLS or SSL
pop3auth - enable POP before SMTP authorisation
helo = text - Alternative Helo string
$pref [ 'sendmail' ] - path to sendmail
$pref [ 'mail_pause' ] - number of emails to send before pause
$pref [ 'mail_pausetime' ] - time to pause
$pref [ 'mail_bounce_email' ] - 'reply to' address
$pref [ 'mail_bounce_pop3' ]
$pref [ 'mail_bounce_user' ]
$pref [ 'mail_bounce_pass' ]
Usage
=====
1. Create new object of the correct class
2. Set up everything - to / from / email etc
3. Call create_connection ()
4. Call send_mail ()
+----------------------------------------------------------------------------+
*/
if ( ! defined ( 'e107_INIT' )) { exit ; }
2020-03-01 12:59:19 -08:00
//define('MAIL_DEBUG',true);
//define('LOG_CALLER', true);
2019-03-29 19:13:32 -05:00
//require_once(e_HANDLER.'phpmailer/class.phpmailer.php');
//require_once(e_HANDLER.'phpmailer/class.smtp.php');
2020-02-29 11:56:05 -08:00
//require_once(e_HANDLER.'phpmailer/PHPMailerAutoload.php');
use PHPMailer\PHPMailer\PHPMailer ;
2020-03-01 12:59:19 -08:00
// use PHPMailer\PHPMailer\SMTP;
2020-02-29 11:56:05 -08:00
use PHPMailer\PHPMailer\POP3 ;
use PHPMailer\PHPMailer\Exception ;
require_once ( e_HANDLER . 'vendor/autoload.php' );
2019-03-29 19:13:32 -05:00
// Directory for log (if enabled)
define ( 'MAIL_LOG_PATH' , e_LOG );
2022-04-04 10:54:24 -07:00
/**
*
*/
2019-03-29 19:13:32 -05:00
class e107Email extends PHPMailer
{
private $general_opts = array ();
private $logEnable = 2 ; // 0 = log disabled, 1 = 'dry run' (debug and log, no send). 2 = 'log all' (send, and log result)
2020-03-01 12:59:19 -08:00
/** @var resource */
private $logHandle = false ; // Save handle of log file if opened
private $localUseVerp = false ; // Use our own variable - PHPMailer one doesn't work with all mailers
2019-03-29 19:13:32 -05:00
private $save_bouncepath = '' ; // Used with VERP
private $add_email = 0 ; // 1 includes email detail in log (if logging enabled, of course)
2020-03-01 12:59:19 -08:00
private $allow_html = 1 ; // Flag for HTML conversion - '1' = default, false = disable, true = force.
private $add_HTML_header = false ; // If true, inserts a standard HTML header at the front of the HTML part of the email (set false for BC)
2019-03-29 19:13:32 -05:00
private $SendCount = 0 ; // Keep track of how many emails sent since last SMTP open/connect (used for SMTP KeepAlive)
private $TotalSent = 0 ; // Info might be of interest
private $TotalErrors = 0 ; // Count errors in sending emails
private $pause_amount = 10 ; // Number of emails to send before pausing/resetting (or closing if SMTPkeepAlive set)
private $pause_time = 1 ; // Time to pause after sending a block of emails
2020-03-01 12:59:19 -08:00
public $legacyBody = false ; // true enables legacy conversion of plain text body to HTML in HTML emails
2019-03-29 19:13:32 -05:00
private $debug = false ; // echos various debug info when set to true.
private $pref = array (); // Store code prefs.
private $previewMode = false ;
private $previewAttachments = array ();
private $overrides = array (
// Legacy // New
'SMTPDebug' => 'SMTPDebug' ,
'subject' => 'subject' ,
'email_sender_email' => 'sender_email' ,
'email_sender_name' => 'sender_name' ,
'email_replyto' => 'replyto' ,
'send_html' => 'html' ,
'email_attach' => 'attachment' ,
'email_copy_to' => 'cc' ,
'email_bcopy_to' => 'bcc' ,
'bouncepath' => 'bouncepath' ,
'returnreceipt' => 'returnreceipt' ,
'email_priority' => 'priority' ,
'extra_header' => 'extra_header' ,
'wordwrap' => 'wordwrap' ,
'split' => 'split' ,
'smtp_server' => 'smtp_server' ,
'smtp_username' => 'smtp_username' ,
'smtp_password' => 'smtp_password' ,
'smtp_port' => 'smtp_port' ,
);
/**
* Constructor sets up all the global options , and sensible defaults - it should be the only place the prefs are accessed
*
2020-03-01 12:59:19 -08:00
* @ var array | boolean $overrides - array of values which override mail - related prefs . Key is the same as the corresponding pref .
2019-03-29 19:13:32 -05:00
* - second batch of keys can preset values configurable through the arraySet () method
2020-02-29 11:56:05 -08:00
* @ return null
2019-03-29 19:13:32 -05:00
*/
2020-03-01 12:59:19 -08:00
public function __construct ( $overrides = false )
2019-03-29 19:13:32 -05:00
{
2020-03-01 12:59:19 -08:00
parent :: __construct ( false ); // Parent constructor - no exceptions for now
2019-03-29 19:13:32 -05:00
$pref = e107 :: pref ( 'core' );
$tp = e107 :: getParser ();
if ( defined ( 'MAIL_DEBUG' ))
{
$this -> debug = true ;
}
else
{
$this -> Debugoutput = 'handlePHPMailerDebug' ;
}
$this -> pref = $pref ;
$this -> CharSet = 'utf-8' ;
$this -> setLanguage ( CORE_LC );
2020-03-01 12:59:19 -08:00
if (( $overrides === false ) || ! is_array ( $overrides ))
2019-03-29 19:13:32 -05:00
{
$overrides = array ();
}
foreach ( array ( 'mailer' , 'smtp_server' , 'smtp_username' , 'smtp_password' , 'smtp_port' , 'sendmail' , 'siteadminemail' , 'siteadmin' ) as $k )
{
2020-03-11 17:04:51 -07:00
if ( ! isset ( $overrides [ $k ]))
{
$overrides [ $k ] = varset ( $pref [ $k ]);
}
2019-03-29 19:13:32 -05:00
}
if ( strpos ( $overrides [ 'smtp_server' ], ':' ) !== false )
{
list ( $smtpServer , $smtpPort ) = explode ( " : " , $overrides [ 'smtp_server' ]);
$overrides [ 'smtp_server' ] = $smtpServer ;
}
else
{
$smtpPort = varset ( $overrides [ 'smtp_port' ], 25 );
}
$this -> pause_amount = varset ( $pref [ 'mail_pause' ], 10 );
$this -> pause_time = varset ( $pref [ 'mail_pausetime' ], 1 );
$this -> allow_html = varset ( $pref [ 'mail_sendstyle' ], 'textonly' ) == 'texthtml' ? true : 1 ;
if ( vartrue ( $pref [ 'mail_options' ])) $this -> general_opts = explode ( ',' , $pref [ 'mail_options' ], '' );
if ( $this -> debug )
{
echo 'Mail_options: ' . $pref [ 'mail_options' ] . ' Count: ' . count ( $this -> general_opts ) . '<br />' ;
}
foreach ( $this -> general_opts as $k => $v )
{
$v = trim ( $v );
$this -> general_opts [ $k ] = $v ;
if ( strpos ( $v , 'hostname' ) === 0 )
{
2020-03-01 12:59:19 -08:00
list (, $this -> Hostname ) = explode ( '=' , $v );
if ( $this -> debug ) echo " Host name set to: { $this -> Hostname } <br /> " ;
2019-03-29 19:13:32 -05:00
}
}
list ( $this -> logEnable , $this -> add_email ) = explode ( ',' , varset ( $pref [ 'mail_log_options' ], '0,0' ));
switch ( $overrides [ 'mailer' ])
{
case 'smtp' :
$smtp_options = array ();
$temp_opts = explode ( ',' , varset ( $pref [ 'smtp_options' ], '' ));
if ( vartrue ( $overrides [ 'smtp_pop3auth' ])) $temp_opts [] = 'pop3auth' ; // Legacy option - remove later
if ( vartrue ( $pref [ 'smtp_keepalive' ])) $temp_opts [] = 'keepalive' ; // Legacy option - remove later
foreach ( $temp_opts as $k => $v )
{
2020-03-01 12:59:19 -08:00
if ( strpos ( $v , '=' ) !== false )
2019-03-29 19:13:32 -05:00
{
list ( $v , $k ) = explode ( '=' , $v , 2 );
$smtp_options [ trim ( $v )] = trim ( $k );
}
else
{
2020-03-01 12:59:19 -08:00
$smtp_options [ trim ( $v )] = true ; // Simple on/off option
2019-03-29 19:13:32 -05:00
}
}
unset ( $temp_opts );
$this -> isSMTP (); // Enable SMTP functions
if ( vartrue ( $smtp_options [ 'helo' ])) $this -> Helo = $smtp_options [ 'helo' ];
if ( isset ( $smtp_options [ 'pop3auth' ])) // We've made sure this is set
{ // Need POP-before-SMTP authorisation
2020-02-29 11:56:05 -08:00
// require_once(e_HANDLER.'phpmailer/class.pop3.php');
2019-03-29 19:13:32 -05:00
$pop = new POP3 ();
$pop -> authorise ( $overrides [ 'smtp_server' ], 110 , 30 , $overrides [ 'smtp_username' ], $overrides [ 'smtp_password' ], 1 );
}
$this -> Mailer = 'smtp' ;
$this -> localUseVerp = isset ( $smtp_options [ 'useVERP' ]);
if ( isset ( $smtp_options [ 'secure' ]))
{
switch ( $smtp_options [ 'secure' ])
{
case 'TLS' :
$this -> SMTPSecure = 'tls' ;
$this -> Port = ( $smtpPort != 465 ) ? $smtpPort : 25 ; // Can also use port 587, and maybe even 25
break ;
case 'SSL' :
$this -> SMTPSecure = 'ssl' ;
$this -> Port = ( $smtpPort != 587 ) ? $smtpPort : 465 ;
break ;
default :
if ( $this -> debug ) echo " Invalid option: { $smtp_options [ 'secure' ] } <br /> " ;
}
}
2020-03-01 12:59:19 -08:00
$this -> SMTPKeepAlive = varset ( $smtp_options [ 'keepalive' ], false ); // ***** Control this
2019-03-29 19:13:32 -05:00
$this -> Host = $overrides [ 'smtp_server' ];
if ( $overrides [ 'smtp_username' ] && $overrides [ 'smtp_password' ])
{
$this -> SMTPAuth = ( ! isset ( $smtp_options [ 'pop3auth' ]));
$this -> Username = $overrides [ 'smtp_username' ];
$this -> Password = $overrides [ 'smtp_password' ];
}
break ;
case 'sendmail' :
$this -> Mailer = 'sendmail' ;
$this -> Sendmail = ( $overrides [ 'sendmail' ]) ? $overrides [ 'sendmail' ] : '/usr/sbin/sendmail -t -i -r ' . vartrue ( $pref [ 'replyto_email' ], $overrides [ 'siteadminemail' ]);
break ;
case 'php' :
$this -> Mailer = 'mail' ;
break ;
}
$this -> FromName = $tp -> toHTML ( vartrue ( $pref [ 'replyto_name' ], $overrides [ 'siteadmin' ]), '' , 'RAWTEXT' );
$this -> From = $tp -> toHTML ( vartrue ( $pref [ 'replyto_email' ], $overrides [ 'siteadminemail' ]), '' , 'RAWTEXT' );
$this -> WordWrap = 76 ; // Set a sensible default
$this -> Sender = ( ! empty ( $pref [ 'mail_bounce_email' ])) ? $pref [ 'mail_bounce_email' ] : $this -> From ;
$pref [ 'mail_dkim' ] = 1 ;
$privatekeyfile = e_SYSTEM . 'dkim_private.key' ;
if ( $pref [ 'mail_dkim' ] && is_readable ( $privatekeyfile ))
{
$this -> DKIM_domain = e_DOMAIN ; // 'example.com';
$this -> DKIM_private = $privatekeyfile ;
$this -> DKIM_selector = 'phpmailer' ;
$this -> DKIM_passphrase = '' ; //key is not encrypted
$this -> DKIM_identifier = $this -> From ;
}
// Now look for any overrides - slightly cumbersome way of doing it, but does give control over what can be set from here
// Options are those accepted by the arraySet() method.
if ( ! empty ( $overrides ))
{
foreach ( $this -> overrides as $key => $opt )
{
if ( isset ( $overrides [ $key ]))
{
$this -> arraySet ( array ( $opt => $overrides [ $key ]));
}
elseif ( ! empty ( $overrides [ $opt ]))
{
$this -> arraySet ( array ( $opt => $overrides [ $opt ]));
}
}
}
2020-03-01 12:59:19 -08:00
return null ;
2019-03-29 19:13:32 -05:00
}
/**
* Set log level
* @ param int $level 0 | 1 | 2
* @ param int $emailDetails 0 | 1
2020-03-01 12:59:19 -08:00
* @ return object e107Email
2019-03-29 19:13:32 -05:00
*/
public function logEnable ( $level , $emailDetails = null )
{
$this -> logEnable = ( int ) $level ;
if ( null !== $this -> add_email )
{
$this -> add_email = ( int ) $emailDetails ;
}
return $this ;
}
/**
* Disable log completely
2020-03-01 12:59:19 -08:00
* @ return object e107Email
2019-03-29 19:13:32 -05:00
*/
public function logDisable ()
{
$this -> logEnable = 0 ;
$this -> add_email = 0 ;
return $this ;
}
/**
* Format 'to' address and name
*
* @ param string $email - email address of recipient
* @ param string $to - name of recipient
* @ return string in form : Fred Bloggs < fred . bloggs @ somewhere . com >
*/
public function makePrintableAddress ( $email , $to )
{
$to = trim ( $to );
$email = trim ( $email );
return $to . ' <' . $email . '>' ;
}
/**
* Log functions - write to a log file
* Each entry logged to a separate line
2020-03-01 12:59:19 -08:00
*
* @ param bool $logInfo
* @ return null
2019-03-29 19:13:32 -05:00
*/
2020-03-01 12:59:19 -08:00
protected function openLog ( $logInfo = true )
2019-03-29 19:13:32 -05:00
{
2020-03-01 12:59:19 -08:00
if ( $this -> logEnable && ( $this -> logHandle === false ))
2019-03-29 19:13:32 -05:00
{
2020-03-04 18:13:05 -08:00
$logFileName = MAIL_LOG_PATH . 'mailoutlog.log' ;
2019-03-29 19:13:32 -05:00
$this -> logHandle = fopen ( $logFileName , 'a' ); // Always append to file
}
2020-03-01 12:59:19 -08:00
if ( $this -> logHandle !== false )
2019-03-29 19:13:32 -05:00
{
fwrite ( $this -> logHandle , " \n \n ===== " . date ( 'H:i:s y.m.d' ) . " ----------------------------------------------------------------===== \r \n " );
if ( $logInfo )
{
fwrite ( $this -> logHandle , ' Mailer opened by ' . USERNAME . " - ID: { $this -> MessageID } . Subject: { $this -> Subject } Log action: { $this -> logEnable } \r \n " );
if ( $this -> add_email )
{
fwrite ( $this -> logHandle , 'From: ' . $this -> From . ' (' . $this -> FromName . " ) \r \n " );
fwrite ( $this -> logHandle , 'Sender: ' . $this -> Sender . " \r \n " );
fwrite ( $this -> logHandle , 'Subject: ' . $this -> Subject . " \r \n " );
// Following are private variables ATM
// fwrite($this->logHandle, 'CC: '.$email_info['copy_to']."\r\n");
// fwrite($this->logHandle, 'BCC: '.$email_info['bcopy_to']."\r\n");
// fwrite($this->logHandle, 'Attach: '.$attach."\r\n");
fwrite ( $this -> logHandle , 'Body: ' . $this -> Body . " \r \n " );
fwrite ( $this -> logHandle , " ----------------------------------------------------------- \r \n " );
}
}
if ( defined ( 'LOG_CALLER' ))
{
$temp = debug_backtrace ();
foreach ( $temp as $t )
{
if ( ! isset ( $t [ 'class' ]) || ( $t [ 'class' ] != 'e107Email' ))
{
2020-03-01 12:59:19 -08:00
fwrite ( $this -> logHandle , print_a ( $t , true ) . " \r \n " ); // Found the caller
2019-03-29 19:13:32 -05:00
break ;
}
}
}
}
2020-03-01 12:59:19 -08:00
return null ;
2019-03-29 19:13:32 -05:00
}
/**
* Add a line to log file - time / date is prepended , and CRLF is appended
*
* @ param string $text - line to add
2020-03-01 12:59:19 -08:00
* @ return null
2019-03-29 19:13:32 -05:00
*/
protected function logLine ( $text )
{
if ( $this -> logEnable && ( $this -> logHandle > 0 ))
{
fwrite ( $this -> logHandle , date ( 'H:i:s y.m.d' ) . ' - ' . $text . " \r \n " );
}
2020-03-01 12:59:19 -08:00
return null ;
2019-03-29 19:13:32 -05:00
}
/**
* Close log
*/
protected function closeLog ()
{
if ( $this -> logEnable && ( $this -> logHandle > 0 ))
{
fclose ( $this -> logHandle );
}
}
/**
* Add a list of addresses to one of the address lists .
* @ param string $list - 'to' , 'replyto' , 'cc' , 'bcc'
* @ param string $addresses - comma separated
* @ param string $names - either a single name ( used for all addresses ) or a comma - separated list corresponding to the address list
* If the name field for an entry is blank , or there are not enough entries , the address is substituted
2020-12-18 19:55:12 -08:00
* @ return bool true if list accepted , false if invalid list name
2019-03-29 19:13:32 -05:00
*/
2020-03-01 12:59:19 -08:00
public function AddAddressList ( $list = 'to' , $addresses = '' , $names = '' )
2019-03-29 19:13:32 -05:00
{
$list = trim ( strtolower ( $list ));
$tmp = explode ( ',' , $addresses );
2020-03-01 12:59:19 -08:00
if ( strpos ( $names , ',' ) === false )
2019-03-29 19:13:32 -05:00
{
$names = array_fill ( 0 , count ( $tmp ), $names ); // Same value for all addresses
}
else
{
$names = explode ( ',' , $names );
}
foreach ( $tmp as $k => $adr )
{
$to_name = ( $names [ $k ]) ? $names [ $k ] : $adr ;
switch ( $list )
{
case 'to' :
2020-03-01 12:59:19 -08:00
try
{
$this -> addAddress ( $adr , $to_name );
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
break ;
case 'replyto' :
2020-03-01 12:59:19 -08:00
try
{
$this -> addReplyTo ( $adr , $to_name );
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
break ;
case 'cc' :
if ( $this -> Mailer == 'mail' )
{
$this -> addCustomHeader ( 'Cc: ' . $adr );
}
else
{
2020-03-01 12:59:19 -08:00
try
{
$this -> addCC ( $adr , $to_name );
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
}
break ;
case 'bcc' :
if ( $this -> Mailer == 'mail' )
{
$this -> addCustomHeader ( 'Bcc: ' . $adr );
}
else
{
2020-03-01 12:59:19 -08:00
try
{
$this -> addBCC ( $adr , $to_name );
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
}
break ;
default :
2020-03-01 12:59:19 -08:00
return false ;
2019-03-29 19:13:32 -05:00
}
}
2020-03-01 12:59:19 -08:00
return true ;
2019-03-29 19:13:32 -05:00
}
/**
2020-03-01 12:59:19 -08:00
* Create email body , primarily using the inbuilt functionality of phpmailer
2019-03-29 19:13:32 -05:00
*
2020-03-01 12:59:19 -08:00
* @ param string $message
* @ param boolean | int $want_HTML determines whether an HTML part of the email is created . 1 uses default setting for HTML part . Set true to enable , false to disable
* @ param boolean $add_HTML_header - if true , a standard HTML header is added to the front of the HTML part
2019-03-29 19:13:32 -05:00
*
2020-03-01 12:59:19 -08:00
* @ return null
2019-03-29 19:13:32 -05:00
*/
2020-03-01 12:59:19 -08:00
public function makeBody ( $message , $want_HTML = 1 , $add_HTML_header = false )
2019-03-29 19:13:32 -05:00
{
switch ( varset ( $this -> general_opts [ 'textonly' ], 'off' ))
{
case 'pref' : // Disable HTML as default
2020-03-01 12:59:19 -08:00
if ( $want_HTML == 1 ) $want_HTML = false ;
2019-03-29 19:13:32 -05:00
break ;
case 'force' : // Always disable HTML
2020-03-01 12:59:19 -08:00
$want_HTML = false ;
2019-03-29 19:13:32 -05:00
break ;
}
$message = str_replace ( " \t " , " " , $message ); // filter out tabs from templates;
2020-03-01 12:59:19 -08:00
if ( $want_HTML !== false )
2019-03-29 19:13:32 -05:00
{
// $message = e107::getParser()->toHTML("[html]".$message."[/html]",true); // using toHtml will break media attachment links. (need to retain {e_XXXX )
if ( $this -> debug ) echo " Generating multipart email<br /> " ;
if ( $add_HTML_header )
{
$message = " <!DOCTYPE html PUBLIC \" -//W3C//DTD XHTML 1.1//EN \" \" http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd \" > \n
2020-03-01 12:59:19 -08:00
< html xmlns = 'http://www.w3.org/1999/xhtml' lang = 'en' > \n " . $message ;
2019-03-29 19:13:32 -05:00
}
// !preg_match('/<(table|div|font|br|a|img|b)/i', $message)
if ( $this -> legacyBody && e107 :: getParser () -> isHtml ( $message ) != true ) // Assume html if it includes one of these tags
{ // Otherwise assume its a plain text message which needs some conversion to render in HTML
if ( $this -> debug == true )
{
echo 'Running legacyBody mode<br />' ;
}
$message = htmlspecialchars ( $message , ENT_QUOTES , $this -> CharSet );
$message = preg_replace ( '%(http|ftp|https)(://\S+)%' , '<a href="\1\2">\1\2</a>' , $message );
2020-03-01 12:59:19 -08:00
$message = preg_replace ( '/([[:space:]()[{}])(www.[-a-zA-Z0-9@:%_\+.~#?&\/=]+)/i' , '\\1<a href="http://\\2">\\2</a>' , $message );
2019-03-29 19:13:32 -05:00
$message = preg_replace ( '/([_\.0-9a-z-]+@([0-9a-z][0-9a-z-]+\.)+[a-z]{2,3})/i' , '<a href="mailto:\\1">\\1</a>' , $message );
$message = str_replace ( " \r \n " , " \n " , $message ); // Handle alternative newline characters
$message = str_replace ( " \n \r " , " \n " , $message ); // Handle alternative newline characters
$message = str_replace ( " \r " , " \n " , $message ); // Handle alternative newline characters
$message = str_replace ( " \n " , " <br /> \n " , $message );
}
$this -> MsgHTML ( $message ); // Theoretically this should do everything, including handling of inline images.
}
else
{ // generate the plain text as the sole part of the email
if ( $this -> debug ) echo " Generating plain text email<br /> " ;
2020-03-01 12:59:19 -08:00
if ( strpos ( $message , '</style>' ) !== false )
2019-03-29 19:13:32 -05:00
{
$text = strstr ( $message , '</style>' );
}
else
{
$text = $message ;
}
$text = str_replace ( '<br />' , " \n " , $text );
$text = strip_tags ( str_replace ( '<br>' , " \n " , $text ));
// TODO: strip bbcodes here
$this -> Body = $text ;
$this -> AltBody = '' ; // Single part email
}
2020-03-01 12:59:19 -08:00
return null ;
2019-03-29 19:13:32 -05:00
}
/**
* Add attachments to the current email - either a single one as a string , or an array
* Always sent in base64 encoding
*
* @ param string | array $attachments - single attachment name as a string , or any number as an array
*
2020-02-29 11:56:05 -08:00
* @ return null
2019-03-29 19:13:32 -05:00
*/
public function attach ( $attachments )
{
if ( ! $attachments ) return ;
if ( ! is_array ( $attachments )) $attachments = array ( $attachments );
2020-03-01 12:59:19 -08:00
// $mes = e107::getMessage();
2019-03-29 19:13:32 -05:00
foreach ( $attachments as $attach )
{
$tempName = basename ( $attach );
if ( is_readable ( $attach ) && $tempName ) // First parameter is complete path + filename; second parameter is 'name' of file to send
{
if ( $this -> previewMode === true )
{
$this -> previewAttachments [] = array ( 'file' => $attach , 'status' => true );
}
else
{
$ext = pathinfo ( $attach , PATHINFO_EXTENSION );
2020-03-01 12:59:19 -08:00
try
{
$this -> addAttachment ( $attach , $tempName , 'base64' , $this -> _mime_types ( $ext ));
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
}
}
elseif ( $this -> previewMode === true )
{
$this -> previewAttachments [] = array ( 'file' => $attach , 'status' => false );
}
}
2020-03-01 12:59:19 -08:00
return null ;
2019-03-29 19:13:32 -05:00
}
/**
* Add inline images ( should usually be handled automatically by PHPMailer )
*
* @ param string $inline - comma separated list of file names
*/
function addInlineImages ( $inline )
{
if ( ! $inline ) return ;
$tmp = explode ( ',' , $inline );
foreach ( $tmp as $inline_img )
{
if ( is_readable ( $inline_img ) && ! is_dir ( $inline_img ))
{
$ext = pathinfo ( $inline_img , PATHINFO_EXTENSION );
2020-03-01 12:59:19 -08:00
try
{
$this -> addEmbeddedImage ( $inline_img , md5 ( $inline_img ), basename ( $inline_img ), 'base64' , $this -> _mime_types ( $ext ));
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2019-03-29 19:13:32 -05:00
}
}
}
/**
* Preview the BODY of an email
* @ param $eml - array .
* @ return string
*/
public function preview ( $eml )
{
$this -> previewMode = true ;
2020-03-01 12:59:19 -08:00
// $mes = e107::getMessage();
2019-03-29 19:13:32 -05:00
if ( count ( $eml ))
{
if ( $error = $this -> arraySet ( $eml )) // Set parameters from list
{
return $error ;
}
}
$text = $this -> Body ;
if ( $eml [ 'template' ] == 'textonly' )
{
$text = strip_tags ( $text );
}
if ( ! empty ( $this -> previewAttachments ))
{
$text .= " <hr />Attachments: " ;
foreach ( $this -> previewAttachments as $val )
{
$text .= " <div> " . $val [ 'file' ] . " - " ;
$text .= ( $val [ 'status' ] !== true ) ? " Not Found " : " OK " ;
$text .= " </div> " ;
}
}
if ( $eml [ 'template' ] == 'texthtml' || $eml [ 'template' ] == 'textonly' )
{
2020-03-01 12:59:19 -08:00
$text = " <body style='background-color:#FFFFFF;'> " . $text . " </body> " ;
2019-03-29 19:13:32 -05:00
}
return $text ;
}
2022-04-04 10:54:24 -07:00
/**
* @ param $eml
* @ return mixed
*/
2019-03-29 19:13:32 -05:00
function processShortcodes ( $eml )
{
$tp = e107 :: getParser ();
$mediaParms = array ();
if ( strpos ( $eml [ 'templateHTML' ][ 'body' ], '{MEDIA' ) !== false )
{
// check for media sizing.
if ( preg_match_all ( '/\{MEDIA([\d]): w=([\d]*)\}/' , $eml [ 'templateHTML' ][ 'body' ], $match ))
{
foreach ( $match [ 1 ] as $k => $num )
{
//$key = $match[1][$k];
$mediaParms [ $num ][ 'w' ] = $match [ 2 ][ $k ];
}
}
}
2021-12-03 14:58:33 -08:00
/*
2019-03-29 19:13:32 -05:00
if ( ! empty ( $eml [ 'html' ]) || strip_tags ( $eml [ 'template' ]) != $eml [ 'template' ]) // HTML Email.
{
$eml [ 'shortcodes' ][ 'BODY' ] = ! empty ( $eml [ 'body' ]) ? $eml [ 'body' ] : '' ; // using toEmail() on html templates adds unnecessary <br /> to code.
}
else // Plain Text Email.
{
$eml [ 'shortcodes' ][ 'BODY' ] = ! empty ( $eml [ 'body' ]) ? $tp -> toEmail ( $eml [ 'body' ]) : '' ;
}
2021-12-03 14:58:33 -08:00
*/
2019-03-29 19:13:32 -05:00
$eml [ 'shortcodes' ][ 'BODY' ] = ! empty ( $eml [ 'body' ]) ? $eml [ 'body' ] : '' ; // $tp->toEmail($eml['body']) : '';
$eml [ 'shortcodes' ][ 'SUBJECT' ] = ! empty ( $eml [ 'subject' ]) ? $eml [ 'subject' ] : '' ;
$eml [ 'shortcodes' ][ 'THEME' ] = ( $this -> previewMode == true ) ? e_THEME_ABS . $this -> pref [ 'sitetheme' ] . '/' : e_THEME . $this -> pref [ 'sitetheme' ] . '/' ; // Always use front-end theme path.
if ( ! empty ( $eml [ 'media' ]) && is_array ( $eml [ 'media' ]))
{
foreach ( $eml [ 'media' ] as $k => $val )
{
if ( vartrue ( $val [ 'path' ]))
{
$nk = ( $k + 1 );
$id = 'MEDIA' . $nk ;
if ( $tp -> isVideo ( $val [ 'path' ]))
{
$eml [ 'shortcodes' ][ $id ] = " <div class='media media-video'> " . $tp -> toVideo ( $val [ 'path' ], array ( 'thumb' => 'email' )) . " </div> " ;
}
else
{
$size = isset ( $mediaParms [ $nk ]) ? " ?w= " . $mediaParms [ $nk ][ 'w' ] : '' ;
//echo $nk.": ".$val['path'].$size."<br />";
$eml [ 'shortcodes' ][ $id ] = " <div class='media media-image'><img class='img-responsive img-fluid " . strtolower ( $id ) . " ' src=' " . $val [ 'path' ] . $size . " ' alt='' /></div> " ;
}
}
}
}
return $eml [ 'shortcodes' ];
}
/**
* Sets one or more parameters from an array . See @ see { sendEmail ()} for list of parameters
* Where parameter not present , doesn ' t change it - so can repeatedly call this function for bulk mailing , or to build up the list
* ( Note that there is no requirement to use this method for everything ; parameters can be set by mixing this method with individual setting )
*
* @ param array $eml - list of parameters to set / change . Key is parameter name . @ see { sendEmail ()} for list of parameters
*
* @ return int zero if no errors detected
*/
public function arraySet ( $eml )
{
$tp = e107 :: getParser ();
$tmpl = null ;
// Cleanup legacy key names. ie. remove 'email_' prefix.
foreach ( $eml as $k => $v )
{
if ( substr ( $k , 0 , 6 ) == 'email_' )
{
$nkey = substr ( $k , 6 );
$eml [ $nkey ] = $v ;
unset ( $eml [ $k ]);
}
}
2020-06-01 17:37:49 -07:00
if ( ! empty ( $eml [ 'template' ])) // @see e107_core/templates/email_template.php
2020-08-11 09:36:21 -07:00
{
require_once ( e_LANGUAGEDIR . e_LANGUAGE . " /admin/lan_users.php " ); // do not use e107::lan etc.
2019-03-29 19:13:32 -05:00
if ( $tmpl = e107 :: getCoreTemplate ( 'email' , $eml [ 'template' ], 'front' , true )) //FIXME - Core template is failing with template 'notify'. Works with theme template. Issue with core template registry?
{
$eml [ 'templateHTML' ] = $tmpl ;
$eml [ 'shortcodes' ] = $this -> processShortcodes ( $eml );
2020-06-01 17:37:49 -07:00
$eml [ 'shortcodes' ][ '_WRAPPER_' ] = 'email/' . $eml [ 'template' ];
2019-03-29 19:13:32 -05:00
$emailBody = $tmpl [ 'header' ] . str_replace ( '{BODY}' , $eml [ 'body' ], $tmpl [ 'body' ]) . $tmpl [ 'footer' ];
$eml [ 'body' ] = $tp -> parseTemplate ( $emailBody , true , $eml [ 'shortcodes' ]);
// $eml['body'] = ($tp->toEmail($tmpl['header']). str_replace('{BODY}', $eml['body'], $tmpl['body']). $tp->toEmail($tmpl['footer']));
if ( $this -> debug )
{
// echo "<h4>e107Email::arraySet() - line ".__LINE__."</h4>";
var_dump ( $eml [ 'shortcodes' ]);
var_dump ( $this -> Subject );
// print_a($tmpl);
}
unset ( $eml [ 'add_html_header' ]); // disable other headers when template is used.
$this -> Subject = $tp -> parseTemplate ( $tmpl [ 'subject' ], true , varset ( $eml [ 'shortcodes' ], null ));
if ( $this -> debug )
{
var_dump ( $this -> Subject );
}
}
else
{
if ( $this -> debug )
{
echo " <h4>Couldn't find email template: " . $eml [ 'template' ] . " </h4> " ;
}
// $emailBody = $eml['body'];
if ( vartrue ( $eml [ 'subject' ])) $this -> Subject = $tp -> parseTemplate ( $eml [ 'subject' ], true , varset ( $eml [ 'shortcodes' ], null ));
e107 :: getMessage () -> addDebug ( " Couldn't find email template: " . $eml [ 'template' ]);
}
}
else
{
if ( vartrue ( $eml [ 'subject' ])) $this -> Subject = $tp -> parseTemplate ( $eml [ 'subject' ], true , varset ( $eml [ 'shortcodes' ], null ));
// $eml['body'] = ($tp->toEmail($tmpl['header']). str_replace('{BODY}', $eml['body'], $tmpl['body']). $tp->toEmail($tmpl['footer']));
}
$this -> Subject = str_replace ( " ' " , " ' " , $this -> Subject );
// Perform Override from template.
foreach ( $this -> overrides as $k => $v )
{
if ( ! empty ( $tmpl [ $v ]))
{
$eml [ $v ] = $tmpl [ $v ];
}
}
$identifier = deftrue ( 'MAIL_IDENTIFIER' , 'X-e107-id' );
2020-03-01 12:59:19 -08:00
if ( isset ( $eml [ 'SMTPDebug' ])) { $this -> SMTPDebug = $eml [ 'SMTPDebug' ]; } // 'false' is a valid value!
2019-03-29 19:13:32 -05:00
if ( ! empty ( $eml [ 'sender_email' ])) { $this -> From = $eml [ 'sender_email' ]; }
if ( ! empty ( $eml [ 'sender_name' ])) { $this -> FromName = $eml [ 'sender_name' ]; }
if ( ! empty ( $eml [ 'replyto' ])) { $this -> AddAddressList ( 'replyto' , $eml [ 'replyto' ], vartrue ( $eml [ 'replytonames' ], '' )); }
2020-03-01 12:59:19 -08:00
if ( isset ( $eml [ 'html' ])) { $this -> allow_html = $eml [ 'html' ]; } // 'false' is a valid value!
if ( isset ( $eml [ 'html_header' ])) { $this -> add_HTML_header = $eml [ 'html_header' ]; } // 'false' is a valid value!
2019-03-29 19:13:32 -05:00
if ( ! empty ( $eml [ 'body' ])) { $this -> makeBody ( $eml [ 'body' ], $this -> allow_html , $this -> add_HTML_header ); }
if ( ! empty ( $eml [ 'attachment' ])) { $this -> attach ( $eml [ 'attachment' ]); }
if ( ! empty ( $eml [ 'cc' ])) { $this -> AddAddressList ( 'cc' , $eml [ 'cc' ], vartrue ( $eml [ 'cc_names' ], '' )); }
if ( ! empty ( $eml [ 'bcc' ])) { $this -> AddAddressList ( 'bcc' , $eml [ 'bcc' ], vartrue ( $eml [ 'bcc_names' ], '' )); }
if ( ! empty ( $eml [ 'returnreceipt' ])) { $this -> ConfirmReadingTo = $eml [ 'returnreceipt' ]; }
if ( ! empty ( $eml [ 'inline_images' ])) { $this -> addInlineImages ( $eml [ 'inline_images' ]); }
if ( ! empty ( $eml [ 'priority' ])) { $this -> Priority = $eml [ 'priority' ]; }
if ( ! empty ( $eml [ 'e107_header' ])) { $this -> addCustomHeader ( $identifier . " : { $eml [ 'e107_header' ] } " ); }
if ( ! empty ( $eml [ 'wordwrap' ])) { $this -> WordWrap = $eml [ 'wordwrap' ]; }
2020-03-01 12:59:19 -08:00
if ( ! empty ( $eml [ 'split' ])) { $this -> SingleTo = ( $eml [ 'split' ] != false ); }
2019-03-29 19:13:32 -05:00
if ( ! empty ( $eml [ 'smtp_username' ])) { $this -> Username = $eml [ 'smtp_username' ]; }
if ( ! empty ( $eml [ 'smtp_password' ])) { $this -> Password = $eml [ 'smtp_password' ]; }
if ( ! empty ( $eml [ 'bouncepath' ]))
{
$this -> Sender = $eml [ 'bouncepath' ]; // Bounce path
$this -> save_bouncepath = $eml [ 'bouncepath' ]; // Bounce path
}
if ( ! empty ( $eml [ 'extra_header' ]))
{
if ( is_array ( $eml [ 'extra_header' ]))
{
foreach ( $eml [ 'extra_header' ] as $eh )
{
$this -> addCustomHeader ( $eh );
}
}
else
{
$this -> addCustomHeader ( $eml [ 'extra_header' ]);
}
}
// print_a($eml);
if ( $this -> debug )
{
// echo "<h4>e107Email::arraySet() - line ".__LINE__."</h4>";
return 0 ;
// print_a($eml);
//$this->PreSend();
//$debugEml = $this->GetSentMIMEMessage().
//print_a($debugEml);
}
$this -> logLine ( " ArraySet Data: " . print_r ( $eml , true ));
return 0 ; // No error
}
/**
2020-03-01 12:59:19 -08:00
* Send an email where the bulk of the data is passed in an array . Returns 0 on success .
* ( Even if the array is null , because everything previously set up , this is the preferred entry point )
* Where parameter not present in the array , doesn ' t get changed - useful for bulk mailing
* If doing bulk mailing with repetitive calls , set $bulkmail parameter true , and must call allSent () when completed
* Some of these parameters have been made compatible with the array calculated by render_email () in signup . php
2019-03-29 19:13:32 -05:00
*
2020-03-01 12:59:19 -08:00
* Possible array parameters :
*
* @ param string $send_to - recipient email address
2019-03-29 19:13:32 -05:00
* @ param string $to_name - recipient name
2020-03-01 12:59:19 -08:00
* @ param array $eml {
* Optional array of additional parameters ( see BELOW )
* @ type string $eml [ 'subject' ] - Email Subject
* @ type string $eml [ 'sender_email' ] - 'From' email address
* @ type string $eml [ 'sender_name' ] - 'From' name
* @ type string $eml [ 'replyto' ] - Optional 'reply to' field
* @ type string $eml [ 'replytonames' ] - Name ( s ) corresponding to 'reply to' field - only used if 'replyto' used
* @ type bool $eml [ 'send_html' ] - if true , includes HTML part in messages ( only those added after this flag )
* @ type bool $eml [ 'add_html_header' ] - if true , adds the 2 - line DOCTYPE declaration to the front of the HTML part ( but doesn ' t add < head >...</ head > )
* @ type string $eml [ 'body' ] - message body . May be HTML or text . Added according to the current state of the HTML enable flag
* @ type string | array $eml [ 'attach' ] - string if one file , array of filenames if one or more .
* @ type string $eml [ 'cc' ] - comma - separated list of cc addresses .
* @ type string $eml [ 'cc_names' ] - comma - separated list of cc names . Optional , used only if $eml [ 'cc' ] specified
* @ type string $eml [ 'bcc' ] - comma - separated list
* @ type string $eml [ 'bcc_names' ] - comma - separated list of bcc names . Optional , used only if $eml [ 'bcc' ] specified
* @ type string $eml [ 'bouncepath' ] - Sender field ( used for bounces )
* @ type string $eml [ 'returnreceipt' ] - email address for notification of receipt ( reading )
* @ type array $eml [ 'inline_images' ] - array of files for inline images
* @ type int $eml [ 'priority' ] - Email priority ( 1 = High , 3 = Normal , 5 = low )
* @ type string $eml [ 'e107_header' ] - Adds specific 'X-e107-id:' header
* @ type string $eml [ 'extra_header' ] - additional headers ( format is name : value
* @ type string $eml [ 'wordwrap' ] - Set wordwrap value
* @ type bool $eml [ 'split' ] - If true , sends an individual email to each recipient
* @ type string $eml [ 'template' ] - template to use . 'default'
* @ type array $eml [ 'shortcodes' ] - array of shortcode values . eg . array ( 'MY_SHORTCODE' => '12345' );
* }
2019-03-29 19:13:32 -05:00
*
2020-03-01 12:59:19 -08:00
* @ param boolean $bulkmail - set true if this email is one of a bulk send ; false if an isolated email
* @ return boolean | string - true if success , error message if failure
2019-03-29 19:13:32 -05:00
*/
public function sendEmail ( $send_to , $to_name , $eml = array (), $bulkmail = false )
{
if ( count ( $eml ))
{
if ( $error = $this -> arraySet ( $eml )) // Set parameters from list
{
return $error ;
}
}
if (( $bulkmail == true ) && $this -> localUseVerp && $this -> save_bouncepath && ( strpos ( $this -> save_bouncepath , '@' ) !== false ))
{
// Format where sender is owner@origin, target is user@domain is: owner+user=domain@origin
list ( $our_sender , $our_domain ) = explode ( '@' , $this -> save_bouncepath , 2 );
if ( $our_sender && $our_domain )
{
$this -> Sender = $our_sender . '+' . str_replace ( $send_to , '@' , '=' ) . '@' . $our_domain ;
}
}
$this -> AddAddressList ( 'to' , $send_to , $to_name );
$this -> openLog (); // Delay log open until now, so all parameters set up
$this -> SendCount ++ ;
2020-03-04 18:13:05 -08:00
if ( $this -> isError ())
{
$this -> logLine ( 'Error info: ' . $this -> ErrorInfo );
e107 :: getMessage () -> addInfo ( $this -> ErrorInfo );
}
2020-03-01 12:59:19 -08:00
$result = false ;
2019-03-29 19:13:32 -05:00
if ( $this -> debug == false && (( $this -> logEnable == 0 ) || ( $this -> logEnable == 2 )) )
{
2020-03-04 18:13:05 -08:00
// prevent user/script details being exposed in X-PHP-Script header
if ( ! empty ( $_SERVER [ 'REMOTE_ADDR' ]))
{
$oldphpself = $_SERVER [ 'PHP_SELF' ];
$oldremoteaddr = $_SERVER [ 'REMOTE_ADDR' ];
$_SERVER [ 'PHP_SELF' ] = " / " ;
$_SERVER [ 'REMOTE_ADDR' ] = $_SERVER [ 'SERVER_ADDR' ];
$_SERVER [ " HTTP_X_FORWARDED_FOR " ] = $_SERVER [ 'SERVER_ADDR' ];
$_SERVER [ " HTTP_CF_CONNECTING_IP " ] = $_SERVER [ 'SERVER_ADDR' ];
}
2019-03-29 19:13:32 -05:00
2020-03-01 12:59:19 -08:00
try
{
$result = $this -> send (); // Actually send email
}
catch ( Exception $e )
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2020-03-01 12:59:19 -08:00
}
2020-03-04 18:13:05 -08:00
if ( ! empty ( $oldremoteaddr ))
{
$_SERVER [ 'PHP_SELF' ] = $oldphpself ;
$_SERVER [ 'REMOTE_ADDR' ] = $oldremoteaddr ;
$_SERVER [ " HTTP_X_FORWARDED_FOR " ] = $oldremoteaddr ;
$_SERVER [ " HTTP_CF_CONNECTING_IP " ] = $oldremoteaddr ;
}
2019-03-29 19:13:32 -05:00
if ( ! $bulkmail && ! $this -> SMTPKeepAlive && ( $this -> Mailer == 'smtp' )) $this -> smtpClose ();
}
else
{ // Debug
$result = true ;
echo " <h2>Subject: " . $this -> Subject . " </h2> " ;
// echo "<h2>SendEmail()->Body</h2>";
// print_a($this->Body);
// echo "<h2>SendEmail()->AltBody</h2>";
// print_a($this->AltBody);
2020-03-01 12:59:19 -08:00
if (( $this -> logEnable == 3 ) && (( $this -> SendCount % 7 ) == 4 )) $result = false ; // Fail one email in 7 for testing
2019-03-29 19:13:32 -05:00
}
$this -> TotalSent ++ ;
if (( $bulkmail == true ) && ( $this -> pause_amount > 0 ) && ( $this -> SendCount >= $this -> pause_amount ))
{
if ( $this -> SMTPKeepAlive && ( $this -> Mailer == 'smtp' )) $this -> smtpClose ();
sleep ( $this -> pause_time );
$this -> SendCount = 0 ;
}
$this -> logLine ( " Send to { $to_name } at { $send_to } Mail-ID= { $this -> MessageID } - " . ( $result ? 'Success' : 'Fail' ));
if ( ! $result )
{
$this -> logLine ( print_r ( $eml , true ));
if ( ! empty ( $eml [ 'SMTPDebug' ]))
{
e107 :: getMessage () -> addError ( $this -> ErrorInfo );
$tmp = $this ;
$tmp -> pref = array ();
e107 :: getMessage () -> addDebug ( print_a ( $tmp , true ));
}
}
$this -> clearAddresses (); // In case we send another email
$this -> clearCustomHeaders ();
if ( $result )
{
$this -> closeLog ();
2020-03-01 12:59:19 -08:00
return true ;
2019-03-29 19:13:32 -05:00
}
$this -> logLine ( 'Error info: ' . $this -> ErrorInfo );
// Error sending email
2020-03-01 13:16:36 -08:00
e107 :: getLog () -> addEvent ( 3 , debug_backtrace (), " MAIL " , " Send Failed " , $this -> ErrorInfo , false , LOG_TO_ROLLING );
2019-03-29 19:13:32 -05:00
$this -> TotalErrors ++ ;
$this -> closeLog ();
return $this -> ErrorInfo ;
}
2022-04-04 10:54:24 -07:00
/**
* @ param $val
* @ return void
*/
2019-03-29 19:13:32 -05:00
function setDebug ( $val )
{
$this -> debug = $val ;
}
/**
* Called after a bulk mailing completed , to tidy up nicely
*
2020-03-01 12:59:19 -08:00
* @ return null
2019-03-29 19:13:32 -05:00
*/
public function allSent ()
{
if ( $this -> SMTPKeepAlive && ( $this -> Mailer == 'smtp' ) && ( $this -> SendCount > 0 ))
{
$this -> smtpClose ();
$this -> SendCount = 0 ;
}
2020-03-01 12:59:19 -08:00
return null ;
}
2019-03-29 19:13:32 -05:00
/**
2020-03-01 12:59:19 -08:00
* Evaluates the message and returns modifications for inline images and backgrounds
* Also creates an alternative plain text part ( unless $this -> AltBody already non - empty )
* Modification of standard PHPMailer function ( which it overrides )
2019-03-29 19:13:32 -05:00
*
2020-03-01 12:59:19 -08:00
* @ access public
*
* @ param string $message - the mail body to send
* @ param string $basedir - optional 'root part' of paths specified in email - prepended as necessary
* @ param bool $advanced
* @ return null ( message saved ready to send )
2019-03-29 19:13:32 -05:00
*/
2020-03-04 18:13:05 -08:00
public function MsgHTML ( $message , $basedir = '' , $advanced = false )
2019-03-29 19:13:32 -05:00
{
$tp = e107 :: getParser ();
$message = $tp -> toEmail ( $message , false , 'rawtext' );
2020-03-04 18:13:05 -08:00
2019-03-29 19:13:32 -05:00
preg_match_all ( " /(src|background)=([ \" \ '])(.*) \\ 2/Ui " , $message , $images ); // Modified to accept single quotes as well
if ( isset ( $images [ 3 ]) && ( $this -> previewMode === false ))
{
if ( $this -> debug )
{
echo " <h4>Detected Image Paths</h4> " ;
print_a ( $images [ 3 ]);
}
foreach ( $images [ 3 ] as $i => $url )
{
2020-03-04 18:13:05 -08:00
if ( strpos ( $url , 'data:' ) === 0 ) // already embedded, so skip processing
{
continue ;
}
2019-03-29 19:13:32 -05:00
// do not change urls for absolute images (thanks to corvuscorax)
if ( ! preg_match ( '#^[A-z]+://#' , $url ))
{
$url = $tp -> replaceConstants ( $url );
$size = 'w=800' ;
if ( strpos ( $url , '?w=' ) !== false )
{
list ( $url , $size ) = explode ( '?' , $url );
}
// resize on the fly.
if ( $this -> debug )
{
echo " <br />Attempting Resize... " . $url ;
}
// e107::getMessage()->addInfo("Resizing: ".$url." to ".$size);
if ( $resized = e107 :: getMedia () -> resizeImage ( $url , e_TEMP . basename ( $url ), $size ))
{
$url = $resized ;
}
elseif ( $this -> debug )
{
echo " <br />Couldn't resize " . $url ;
}
$delim = $images [ 2 ][ $i ]; // Will be single or double quote
$filename = basename ( $url );
$directory = dirname ( $url );
if ( $directory == '.' ) $directory = '' ;
if ( strpos ( $directory , e_HTTP ) === 0 )
{
$directory = substr ( SERVERBASE , 0 , - 1 ) . $directory ; // Convert to absolute server reference
$basedir = '' ;
}
if ( $this -> debug )
{
echo " <br />CID file { $filename } in { $directory } . Base = " . SERVERBASE . " <br />BaseDir = { $basedir } <br /> " ;
}
$cid = 'cid:' . md5 ( $filename );
$ext = pathinfo ( $filename , PATHINFO_EXTENSION );
$mimeType = self :: _mime_types ( $ext );
if ( ( strlen ( $basedir ) > 1 ) && ( substr ( $basedir , - 1 ) != '/' ) && ( substr ( $basedir , - 1 ) != '\\' )) { $basedir .= '/' ; }
if ( strlen ( $directory ) > 1 && substr ( $directory , - 1 ) != '/' && substr ( $directory , - 1 ) != '\\' ) { $directory .= '/' ; }
//echo "Add image: {$basedir}|{$directory}|{$filename}<br />";
2020-03-01 12:59:19 -08:00
try
2019-03-29 19:13:32 -05:00
{
2020-03-01 12:59:19 -08:00
$this -> addEmbeddedImage ( $basedir . $directory . $filename , md5 ( $filename ), $filename , 'base64' , $mimeType );
2019-03-29 19:13:32 -05:00
$message = preg_replace ( " / " . $images [ 1 ][ $i ] . " = " . $delim . preg_quote ( $images [ 3 ][ $i ], '/' ) . $delim . " /Ui " , $images [ 1 ][ $i ] . " = " . $delim . $cid . $delim , $message );
}
2020-03-01 12:59:19 -08:00
catch ( Exception $e )
2019-03-29 19:13:32 -05:00
{
2020-03-04 18:13:05 -08:00
$this -> logLine ( $e -> getMessage ());
2019-03-29 19:13:32 -05:00
if ( $this -> debug )
{
echo " Add embedded image { $url } failed<br /> " ;
echo " <br />basedir= " . $basedir ;
echo " <br />dir= " . $directory ;
echo " <br />file= " . $filename ;
echo " <br /> " ;
}
}
}
elseif ( $this -> debug )
{
echo " <br />Absolute Image: " . $url ;
}
}
}
if ( $this -> previewMode === true )
{
$message = $tp -> replaceConstants ( $message , 'abs' );
}
$this -> isHTML ( true );
$this -> Body = $message ;
//print_a($message);
$textMsg = str_replace ( " \n " , " " , $message );
2021-10-25 09:34:13 -07:00
$textMsg = str_replace ( '</td>' , " \t " , $textMsg );
$textMsg = str_replace ( " </tr> " , " \n " , $textMsg );
2019-03-29 19:13:32 -05:00
$textMsg = str_replace ( array ( '<br />' , '<br>' ), " \n " , $textMsg ); // Modified to make sure newlines carried through
$textMsg = preg_replace ( '#^.*?<body.*?>#' , '' , $textMsg ); // Knock off everything up to and including the body statement (if present)
$textMsg = preg_replace ( '#</body.*?>.*$#' , '' , $textMsg ); // Knock off everything after and including the </body> (if present)
$textMsg = trim ( strip_tags ( preg_replace ( '/<(head|title|style|script)[^>]*>.*?<\/\\1>/s' , '' , $textMsg )));
if ( $this -> debug )
{
echo " <h2> " . __METHOD__ . ' $textMsg<small> Line: ' . __LINE__ . '</small></h2>' ;
print_a ( $textMsg );
}
if ( ! empty ( $textMsg )) // Always set it, even if AltBody is empty.
{
$this -> AltBody = html_entity_decode ( $textMsg );
}
if ( empty ( $this -> AltBody ))
{
$this -> AltBody = 'To view this email message, enable HTML!' . " \n \n " ;
}
2021-10-25 09:34:13 -07:00
return $this -> Body ;
2019-03-29 19:13:32 -05:00
}
} // End of e107Mailer class
//-----------------------------
// Exception handler
//-----------------------------
// Overrides the phpmailer handler
// For now just work the same as the phpmailer handler - maybe add features to log to rolling log or something later
// Could throw an e107Exception
2020-02-29 11:56:05 -08:00
/* class e107MailerException extends phpmailerException
2019-03-29 19:13:32 -05:00
{
public function errorMessage ()
{
return parent :: errorMsg ();
}
2020-02-29 11:56:05 -08:00
} */
2019-03-29 19:13:32 -05:00
2020-03-01 12:59:19 -08:00
// Called by PHPMailer when SMTP debug is active.
/**
* @ param $str
*/
function handlePHPMailerDebug ( $str )
2019-03-29 19:13:32 -05:00
{
$text = print_a ( $str , true );
e107 :: getMessage () -> addInfo ( $text );
}
2020-03-01 12:59:19 -08:00
2019-03-29 19:13:32 -05:00
//--------------------------------------
// Generic e107 Exception handler
//--------------------------------------
// Overrides the default handler - start of a more general handler
2022-04-04 10:54:24 -07:00
/**
*
*/
class e107Exception extends Exception
2019-03-29 19:13:32 -05:00
{
2022-04-04 10:54:24 -07:00
/**
* @ param $message
* @ param $code
*/
public function __construct ( $message = '' , $code = 0 )
2019-03-29 19:13:32 -05:00
{
parent :: __construct ( $message , $code );
2020-03-04 18:13:05 -08:00
e107 :: getLog () -> addEvent ( 10 ,
2019-03-29 19:13:32 -05:00
$this -> getFile () . '|@' . $this -> getLine (),
'EXCEPT' ,
$this -> getCode () . ':' . $this -> getMessage (),
$this -> getTraceAsString (),
2020-03-01 12:59:19 -08:00
false ,
2019-03-29 19:13:32 -05:00
LOG_TO_ROLLING );
}
}
//-----------------------------------------------------
// Function call to send an email
//-----------------------------------------------------
/**
* Function call to send an email
*
* Deprecated function
*
* Preferred method is to instantiate an e107MailManager object , and use the sendEmails () method , which also allows templates .
*
* see also sendTemplated () where non - default formating is required
*
* Note that plain text emails are converted to HTML , and also sent with a text part
*
* @ param string $send_to - email address of recipient
* @ param string $subject
* @ param string $message
* @ param string $to_name
* @ param string $send_from - sender email address . ( Defaults to the sitewide 'replyto' name and email if set , otherwise site admins details )
* @ param string $from_name - sender name . If $send_from is empty , defaults to the sitewide 'replyto' name and email if set , otherwise site admins details
* @ param string $attachments - comma - separated list of attachments
* @ param string $Cc - comma - separated list of 'copy to' email addresses
* @ param string $Bcc - comma - separated list of 'blind copy to' email addresses
* @ param string $returnpath - Sets 'reply to' email address
2020-03-01 12:59:19 -08:00
* @ param boolean $returnreceipt - true to request receipt
2019-03-29 19:13:32 -05:00
* @ param string $inline - comma separated list of images to send inline
*
2020-03-01 12:59:19 -08:00
* @ return boolean true if send successfully ( NOT an indication of receipt ! ), false if error
2019-03-29 19:13:32 -05:00
*/
2020-03-01 12:59:19 -08:00
function sendemail ( $send_to , $subject , $message , $to_name = '' , $send_from = '' , $from_name = '' , $attachments = '' , $Cc = '' , $Bcc = '' , $returnpath = '' , $returnreceipt = false , $inline = '' )
2019-03-29 19:13:32 -05:00
{
global $mailheader_e107id ;
$overrides = array ();
// TODO: Find a way of doing this which doesn't use a global (or just ditch sendemail() )
// Use defaults from email template?
// ----- Mail pref. template override for parked domains, site mirrors or dynamic values
global $EMAIL_OVERRIDES ;
if ( isset ( $EMAIL_OVERRIDES ) && is_array ( $EMAIL_OVERRIDES ))
{
$overrides = & $EMAIL_OVERRIDES ; // These can override many of the email-related prefs
if ( isset ( $EMAIL_OVERRIDES [ 'bouncepath' ])) $returnpath = $EMAIL_OVERRIDES [ 'bouncepath' ];
if ( isset ( $EMAIL_OVERRIDES [ 'returnreceipt' ])) $returnreceipt = $EMAIL_OVERRIDES [ 'returnreceipt' ];
}
// Create a mailer object of the correct type (which auto-fills in sending method, server details)
$mail = new e107Email ( $overrides );
$identifier = deftrue ( 'MAIL_IDENTIFIER' , 'X-e107-id' );
if ( vartrue ( $mailheader_e107id )) $mail -> addCustomHeader ( $identifier . " : { $mailheader_e107id } " );
2020-03-01 12:59:19 -08:00
$mail -> legacyBody = true ; // Need to handle plain text email conversion to HTML
2019-03-29 19:13:32 -05:00
$mail -> makeBody ( $message ); // Add body, with conversion if required
if ( $Cc ) $mail -> AddAddressList ( 'cc' , $Cc );
if ( $Bcc ) $mail -> AddAddressList ( 'bcc' , $Bcc );
if ( trim ( $send_from ))
{
2020-03-01 12:59:19 -08:00
try
{
$mail -> setFrom ( $send_from , $from_name ); // These have already been defaulted to sitewide options, so no need to set again if blank
}
catch ( Exception $e )
{
// do something
}
2019-03-29 19:13:32 -05:00
}
$mail -> Subject = $subject ;
$mail -> attach ( $attachments );
// Add embedded images (should be auto-handled now)
if ( $inline ) $mail -> addInlineImages ( $inline );
// Passed parameter overrides any system default for bounce - but should this be 'ReplyTo' address instead?
// if (vartrue($returnpath)) $mail->Sender = $AddReplyToAddresses($returnpath,'');
if ( vartrue ( $returnpath )) $mail -> Sender = $returnpath ;
2020-02-29 11:56:05 -08:00
if ( vartrue ( $returnreceipt )) $mail -> ConfirmReadingTo = $returnreceipt ;
2019-03-29 19:13:32 -05:00
2020-03-01 12:59:19 -08:00
if ( $mail -> sendEmail ( $send_to , $to_name ) === true )
2019-03-29 19:13:32 -05:00
{ // Success
2020-03-01 12:59:19 -08:00
return true ;
2019-03-29 19:13:32 -05:00
}
// Error info already logged
2020-03-01 12:59:19 -08:00
return false ;
2019-03-29 19:13:32 -05:00
}
2020-03-01 12:59:19 -08:00
