sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 4.7.0

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:00:35 -08:00
1 parent 517a5e1f70
commit 8ba7d43898
1933 files changed
+65613 -11332
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Email/Email.php
+42 -22
View File
@@ -66,6 +66,21 @@ abstract class _Email
* @brief The number of emails that can be sent in one "go"
*/
const MAX_EMAILS_PER_GO = \IPS\BULK_MAILS_PER_CYCLE;
/**
* @brief Use the NoWrapper wrapper (basic HTML container)
*/
const WRAPPER_NONE = 0;
/**
* @brief Use the full email wrapper
*/
const WRAPPER_USE = 1;
/**
* @brief A wrapper has already been applied to the email content ( used in MergeAndSend() )
*/
const WRAPPER_APPLIED = 2;
/* !Factory Constructors */
@@ -89,10 +104,6 @@ abstract class _Email
{
return 'IPS\Email\Outgoing\Smtp';
}
elseif ( \IPS\CIC2 )
{
return 'IPS\Cicloud\Email';
}
elseif ( \IPS\CIC )
{
return 'IPS\Email\Outgoing\IpsCic';
@@ -143,16 +154,16 @@ abstract class _Email
/**
* Initiate a new custom email based on raw email content.
*
* @param string $subject Subject
* @param string $htmlContent HTML Version
* @param string|NULL $plaintextContent Plaintext version. If not provided, one will be built automatically based off $htmlContent.
* @param string $type See TYPE_* constants.
* @param bool $useWrapper If TRUE, the email will be wrapped in the default wrapper template
* @param string $emailKey Key used to identify the email, used for tracking purposes
* @param bool $trackingEnabled TRUE by default, pass FALSE to explicitly disable log/view tracking. Useful with mergeAndSend()'s default behavior of rebuilding an already built email
* @param string $subject Subject
* @param string $htmlContent HTML Version
* @param string|NULL $plaintextContent Plaintext version. If not provided, one will be built automatically based off $htmlContent.
* @param string $type See TYPE_* constants.
* @param int $useWrapper See WRAPPER_* constants.
* @param string $emailKey Key used to identify the email, used for tracking purposes
* @param bool $trackingEnabled TRUE by default, pass FALSE to explicitly disable log/view tracking. Useful with mergeAndSend()'s default behavior of rebuilding an already built email
* @return \IPS\Email
*/
public static function buildFromContent( $subject, $htmlContent='', $plaintextContent=NULL, $type = NULL, $useWrapper=TRUE, $emailKey=NULL, $trackingEnabled=TRUE )
public static function buildFromContent( $subject, $htmlContent='', $plaintextContent=NULL, $type = NULL, $useWrapper=\IPS\Email::WRAPPER_USE, $emailKey=NULL, $trackingEnabled=TRUE )
{
if( !$type )
{
@@ -167,6 +178,12 @@ abstract class _Email
}
}
if( \IPS\IN_DEV AND \is_bool( $useWrapper ) )
{
trigger_error( "The email wrapper must be passed a constant when calling buildFromContent()", E_USER_ERROR );
exit;
}
$email = static::factory( $type );
$email->type = $type;
$email->subject = $subject;
@@ -242,7 +259,7 @@ abstract class _Email
/**
* @brief Should the default wrapper template be used?
*/
protected $useWrapper = TRUE;
protected $useWrapper = self::WRAPPER_USE;
/**
* @brief Unsubscribe Template App
@@ -349,9 +366,12 @@ abstract class _Email
{
$return = static::template( $this->templateApp, $this->templateKey, $type, array_merge( $this->templateParams, array( $this ) ) );
}
/* Check whether we have a subject yet, if not generate it */
$subject = $this->subject ?? $this->compileSubject( $member ?: NULL, $language );
/* Wrap in the wrapper if necessary */
if ( $this->useWrapper )
if ( $this->useWrapper == static::WRAPPER_USE )
{
/* Compile the unsubscribe link */
$unsubscribe = '';
@@ -368,11 +388,11 @@ abstract class _Email
}
/* Wrap */
$return = static::template( 'core', 'emailWrapper', $type, array( $this->subject, $member ?: new \IPS\Member, $return, $unsubscribe, $member === FALSE, '', $this, $ourPicks ) );
$return = static::template( 'core', 'emailWrapper', $type, array( $subject, $member ?: new \IPS\Member, $return, $unsubscribe, $member === FALSE, '', $this, $ourPicks ) );
}
else
elseif( $this->useWrapper == static::WRAPPER_NONE )
{
$return = static::template( 'core', 'emailNoWrapper', $type, array( $this->subject, $member ?: new \IPS\Member, $return, '', $member === FALSE, '', $this, NULL ) );
$return = static::template( 'core', 'emailNoWrapper', $type, array( $subject, $member ?: new \IPS\Member, $return, '', $member === FALSE, '', $this, NULL ) );
}
/* Parse language */
@@ -484,7 +504,7 @@ abstract class _Email
/**
* Get subject
*
* @param \IPS\Member|NULL|FALSE $member If the email is going to a member, the member object. Ensures correct language is used and the email starts with "Hi {member}". NULL for no member, FALSE to use "Hi *|member_name|*" for mergeAndSend()
* @param \IPS\Member|NULL $member If the email is going to a member, the member object. Ensures correct language is used and the email starts with "Hi {member}". NULL for no member, FALSE to use "Hi *|member_name|*" for mergeAndSend()
* @param \IPS\Lang|NULL $language If provided, will override the $member language
* @return string
*/
@@ -712,7 +732,7 @@ abstract class _Email
/* Sent successfully, remove notification */
\IPS\core\AdminNotification::remove( 'core', 'ConfigurationError', 'failedMail' );
\IPS\Db::i()->update( 'core_mail_error_logs', array( 'mlog_notification_sent' => TRUE ) );
\IPS\Db::i()->update( 'core_mail_error_logs', [ 'mlog_notification_sent' => TRUE ], [ 'mlog_notification_sent=?', 0 ] );
/* Update the ad impression count if appropriate */
if( $updateAds === TRUE )
@@ -824,7 +844,7 @@ abstract class _Email
* @param mixed $fromEmail The email address to send from. If NULL, default setting is used. NOTE: This should always be a site-controlled domin. Some services like Sparkpost require the domain to be validated.
* @param mixed $fromName The name the email should appear from. If NULL, default setting is used
* @param array $additionalHeaders Additional headers to send. Merge tags can be used like in content.
* @param \IPS\Lang $language The language the email content should be in
* @param \IPS\Lang|NULL $language The language the email content should be in
* @return int Number of successful sends
*/
public function mergeAndSend( $recipients, $fromEmail = NULL, $fromName = NULL, $additionalHeaders = array(), \IPS\Lang $language = NULL )
@@ -863,7 +883,7 @@ abstract class _Email
}
}
if ( static::buildFromContent( $subject, $htmlContent, $plaintextContent, $this->type, FALSE, $this->templateKey, FALSE )->send( $address, array(), array(), $fromEmail, $fromName, $_additionalHeaders, TRUE, FALSE ) )
if ( static::buildFromContent( $subject, $htmlContent, $plaintextContent, $this->type, static::WRAPPER_APPLIED, $this->templateKey, FALSE )->send( $address, array(), array(), $fromEmail, $fromName, $_additionalHeaders, TRUE, FALSE ) )
{
$return++;
}