/**
* Gets template, stats, weights, etc for an email in preparation to be sent
*
* @param Email $email
* @param bool $includeVariants
*
* @return array
*/
public function getEmailSettings(Email $email, $includeVariants = true)
{
static $emailSettings = array();
if (empty($emailSettings[$email->getId()])) {
//used to house slots so they don't have to be fetched over and over for same template
$slots = array();
$template = $email->getTemplate();
$slots[$template] = $this->factory->getTheme($template)->getSlots('email');
//store the settings of all the variants in order to properly disperse the emails
//set the parent's settings
$emailSettings = array($email->getId() => array('template' => $email->getTemplate(), 'slots' => $slots, 'sentCount' => $email->getSentCount(), 'variantCount' => $email->getVariantSentCount(), 'entity' => $email));
if ($includeVariants) {
//get a list of variants for A/B testing
$childrenVariant = $email->getVariantChildren();
if (count($childrenVariant)) {
$variantWeight = 0;
$totalSent = $email->getVariantSentCount();
foreach ($childrenVariant as $id => $child) {
if ($child->isPublished()) {
$template = $child->getTemplate();
if (isset($slots[$template])) {
$useSlots = $slots[$template];
} else {
$slots[$template] = $this->factory->getTheme($template)->getSlots('email');
$useSlots = $slots[$template];
}
$variantSettings = $child->getVariantSettings();
$emailSettings[$child->getId()] = array('template' => $child->getTemplate(), 'slots' => $useSlots, 'sentCount' => $child->getSentCount(), 'variantCount' => $child->getVariantSentCount(), 'weight' => $variantSettings['weight'] / 100, 'entity' => $child);
$variantWeight += $variantSettings['weight'];
$totalSent += $emailSettings[$child->getId()]['sentCount'];
}
}
//set parent weight
$emailSettings[$email->getId()]['weight'] = (100 - $variantWeight) / 100;
//now find what percentage of current leads should receive the variants
foreach ($emailSettings as $eid => &$details) {
$details['weight'] = $totalSent ? $details['weight'] - $details['variantCount'] / $totalSent + $details['weight'] : $details['weight'];
}
} else {
$emailSettings[$email->getId()]['weight'] = 1;
}
}
}
return $emailSettings;
}
/**
* @param Email $email
* @param bool $allowBcc Honor BCC if set in email
* @param array $slots Slots configured in theme
* @param array $assetAttachments Assets to send
* @param bool $ignoreTrackingPixel Do not append tracking pixel HTML
*/
public function setEmail(Email $email, $allowBcc = true, $slots = array(), $assetAttachments = array(), $ignoreTrackingPixel = false)
{
$this->email = $email;
$subject = $email->getSubject();
// Convert short codes to emoji
$subject = EmojiHelper::toEmoji($subject, 'short');
// Set message settings from the email
$this->setSubject($subject);
$fromEmail = $email->getFromAddress();
$fromName = $email->getFromName();
if (!empty($fromEmail) && !empty($fromEmail)) {
$this->setFrom($fromEmail, $fromName);
} else {
if (!empty($fromEmail)) {
$this->setFrom($fromEmail, $this->from);
} else {
if (!empty($fromName)) {
$this->setFrom(key($this->from), $fromName);
}
}
}
$replyTo = $email->getReplyToAddress();
if (!empty($replyTo)) {
$this->setReplyTo($replyTo);
}
if ($allowBcc) {
$bccAddress = $email->getBccAddress();
if (!empty($bccAddress)) {
$this->addBcc($bccAddress);
}
}
if ($plainText = $email->getPlainText()) {
$this->setPlainText($plainText);
}
$template = $email->getTemplate();
if (!empty($template)) {
if (empty($slots)) {
$template = $email->getTemplate();
$slots = $this->factory->getTheme($template)->getSlots('email');
}
if (isset($slots[$template])) {
$slots = $slots[$template];
}
$customHtml = $this->setTemplate('MauticEmailBundle::public.html.php', array('slots' => $slots, 'content' => $email->getContent(), 'email' => $email, 'template' => $template), true);
} else {
// Tak on the tracking pixel token
$customHtml = $email->getCustomHtml();
}
// Convert short codes to emoji
$customHtml = EmojiHelper::toEmoji($customHtml, 'short');
$this->setBody($customHtml, 'text/html', null, $ignoreTrackingPixel);
// Reset attachments
$this->assets = $this->attachedAssets = array();
if (empty($assetAttachments)) {
if ($assets = $email->getAssetAttachments()) {
foreach ($assets as $asset) {
$this->attachAsset($asset);
}
}
} else {
foreach ($assetAttachments as $asset) {
$this->attachAsset($asset);
}
}
}
/**
* {@inheritDoc}
*/
public function getTemplate()
{
$this->__initializer__ && $this->__initializer__->__invoke($this, 'getTemplate', array());
return parent::getTemplate();
}
/**
* Gets template, stats, weights, etc for an email in preparation to be sent
*
* @param Email $email
* @param bool $includeVariants
*
* @return array
*/
public function &getEmailSettings(Email $email, $includeVariants = true)
{
if (empty($this->emailSettings[$email->getId()])) {
//used to house slots so they don't have to be fetched over and over for same template
// BC for Mautic v1 templates
$slots = [];
if ($template = $email->getTemplate()) {
$slots[$template] = $this->themeHelper->getTheme($template)->getSlots('email');
}
//store the settings of all the variants in order to properly disperse the emails
//set the parent's settings
$emailSettings = [$email->getId() => ['template' => $email->getTemplate(), 'slots' => $slots, 'sentCount' => $email->getSentCount(), 'variantCount' => $email->getVariantSentCount(), 'isVariant' => null !== $email->getVariantStartDate(), 'entity' => $email, 'translations' => $email->getTranslations(true), 'languages' => ['default' => $email->getId()]]];
if ($emailSettings[$email->getId()]['translations']) {
// Add in the sent counts for translations of this email
/** @var Email $translation */
foreach ($emailSettings[$email->getId()]['translations'] as $translation) {
if ($translation->isPublished()) {
$emailSettings[$email->getId()]['sentCount'] += $translation->getSentCount();
$emailSettings[$email->getId()]['variantCount'] += $translation->getVariantSentCount();
// Prevent empty key due to misconfiguration - pretty much ignored
if (!($language = $translation->getLanguage())) {
$language = 'unknown';
}
$core = $this->getTranslationLocaleCore($language);
if (!isset($emailSettings[$email->getId()]['languages'][$core])) {
$emailSettings[$email->getId()]['languages'][$core] = [];
}
$emailSettings[$email->getId()]['languages'][$core][$language] = $translation->getId();
}
}
}
if ($includeVariants && $email->isVariant()) {
//get a list of variants for A/B testing
$childrenVariant = $email->getVariantChildren();
if (count($childrenVariant)) {
$variantWeight = 0;
$totalSent = $emailSettings[$email->getId()]['variantCount'];
foreach ($childrenVariant as $id => $child) {
if ($child->isPublished()) {
$useSlots = [];
if ($template = $child->getTemplate()) {
if (isset($slots[$template])) {
$useSlots = $slots[$template];
} else {
$slots[$template] = $this->themeHelper->getTheme($template)->getSlots('email');
$useSlots = $slots[$template];
}
}
$variantSettings = $child->getVariantSettings();
$emailSettings[$child->getId()] = ['template' => $child->getTemplate(), 'slots' => $useSlots, 'sentCount' => $child->getSentCount(), 'variantCount' => $child->getVariantSentCount(), 'isVariant' => null !== $email->getVariantStartDate(), 'weight' => $variantSettings['weight'] / 100, 'entity' => $child, 'translations' => $child->getTranslations(true), 'languages' => ['default' => $child->getId()]];
$variantWeight += $variantSettings['weight'];
if ($emailSettings[$child->getId()]['translations']) {
// Add in the sent counts for translations of this email
/** @var Email $translation */
foreach ($emailSettings[$child->getId()]['translations'] as $translation) {
if ($translation->isPublished()) {
$emailSettings[$child->getId()]['sentCount'] += $translation->getSentCount();
$emailSettings[$child->getId()]['variantCount'] += $translation->getVariantSentCount();
// Prevent empty key due to misconfiguration - pretty much ignored
if (!($language = $translation->getLanguage())) {
$language = 'unknown';
}
$core = $this->getTranslationLocaleCore($language);
if (!isset($emailSettings[$child->getId()]['languages'][$core])) {
$emailSettings[$child->getId()]['languages'][$core] = [];
}
$emailSettings[$child->getId()]['languages'][$core][$language] = $translation->getId();
}
}
}
$totalSent += $emailSettings[$child->getId()]['variantCount'];
}
}
//set parent weight
$emailSettings[$email->getId()]['weight'] = (100 - $variantWeight) / 100;
} else {
$emailSettings[$email->getId()]['weight'] = 1;
}
}
$this->emailSettings[$email->getId()] = $emailSettings;
}
if ($includeVariants && $email->isVariant()) {
//now find what percentage of current leads should receive the variants
if (!isset($totalSent)) {
$totalSent = 0;
foreach ($this->emailSettings[$email->getId()] as $eid => $details) {
$totalSent += $details['variantCount'];
}
}
foreach ($this->emailSettings[$email->getId()] as $eid => &$details) {
// Determine the deficit for email ordering
if ($totalSent) {
$details['weight_deficit'] = $details['weight'] - $details['variantCount'] / $totalSent;
$details['send_weight'] = $details['weight'] - $details['variantCount'] / $totalSent + $details['weight'];
} else {
$details['weight_deficit'] = $details['weight'];
$details['send_weight'] = $details['weight'];
}
}
// Reorder according to send_weight so that campaigns which currently send one at a time alternate
uasort($this->emailSettings[$email->getId()], function ($a, $b) {
if ($a['weight_deficit'] === $b['weight_deficit']) {
if ($a['variantCount'] === $b['variantCount']) {
return 0;
}
// if weight is the same - sort by least number sent
return $a['variantCount'] < $b['variantCount'] ? -1 : 1;
}
// sort by the one with the greatest deficit first
return $a['weight_deficit'] > $b['weight_deficit'] ? -1 : 1;
});
}
return $this->emailSettings[$email->getId()];
}
/**
* @param Email $email
* @param bool $allowBcc Honor BCC if set in email
* @param array $slots Slots configured in theme
* @param array $assetAttachments Assets to send
* @param bool $ignoreTrackingPixel Do not append tracking pixel HTML
*/
public function setEmail(Email $email, $allowBcc = true, $slots = [], $assetAttachments = [], $ignoreTrackingPixel = false)
{
$this->email = $email;
$subject = $email->getSubject();
// Convert short codes to emoji
$subject = EmojiHelper::toEmoji($subject, 'short');
// Set message settings from the email
$this->setSubject($subject);
$fromEmail = $email->getFromAddress();
$fromName = $email->getFromName();
if (!empty($fromEmail) && !empty($fromEmail)) {
$this->setFrom($fromEmail, $fromName);
} elseif (!empty($fromEmail)) {
$this->setFrom($fromEmail, $this->from);
} elseif (!empty($fromName)) {
$this->setFrom(key($this->from), $fromName);
}
$replyTo = $email->getReplyToAddress();
if (!empty($replyTo)) {
$this->setReplyTo($replyTo);
}
if ($allowBcc) {
$bccAddress = $email->getBccAddress();
if (!empty($bccAddress)) {
$this->addBcc($bccAddress);
}
}
if ($plainText = $email->getPlainText()) {
$this->setPlainText($plainText);
}
$BCcontent = $email->getContent();
$customHtml = $email->getCustomHtml();
// Process emails created by Mautic v1
if (empty($customHtml) && !empty($BCcontent)) {
$template = $email->getTemplate();
if (empty($slots)) {
$template = $email->getTemplate();
$slots = $this->factory->getTheme($template)->getSlots('email');
}
if (isset($slots[$template])) {
$slots = $slots[$template];
}
$this->processSlots($slots, $email);
$logicalName = $this->factory->getHelper('theme')->checkForTwigTemplate(':' . $template . ':email.html.php');
$customHtml = $this->setTemplate($logicalName, ['slots' => $slots, 'content' => $email->getContent(), 'email' => $email, 'template' => $template], true);
}
// Convert short codes to emoji
$customHtml = EmojiHelper::toEmoji($customHtml, 'short');
$this->setBody($customHtml, 'text/html', null, $ignoreTrackingPixel);
// Reset attachments
$this->assets = $this->attachedAssets = [];
if (empty($assetAttachments)) {
if ($assets = $email->getAssetAttachments()) {
foreach ($assets as $asset) {
$this->attachAsset($asset);
}
}
} else {
foreach ($assetAttachments as $asset) {
$this->attachAsset($asset);
}
}
}