/**
* SetupDynamicContentFields
* Loads the Dynamic Content to be replaced and its content
*
* @param Array $recipients The recipient data to load Dynamic content field data for.
* @param Int/Array $lists The list where the data will be retrieved.
*
* @return Mix Returns an array of custom fields, only if the param $returnCustomFields are true
*/
function SetupDynamicContentFields($recipients=array(), $lists = 0, $returnCustomFields = false) {
$lists = (is_array($lists)) ? $lists : array($lists);
$customFields = $this->Lists_API->GetCustomFields($lists);
$allCustomFields = array();
$allSubscribersInfo = array();
foreach ($customFields as $customFieldEntry) {
$allCustomFields[] = $customFieldEntry['name'];
}
$listCustomFields = $this->Subscriber_API->GetAllSubscriberCustomFields($lists,$allCustomFields, $recipients);
$counter = 0;
foreach ($listCustomFields as $subscriberId => $customFieldEntry) {
$infoholder = $this->Subscriber_API->LoadSubscriberBasicInformation($subscriberId, $lists);
if (!empty($infoholder)) {
$allSubscribersInfo[$counter] = $infoholder;
$allSubscribersInfo[$counter]['CustomFields'] = $customFieldEntry;
$counter++;
}
}
$dctEvent =new EventData_IEM_ADDON_DYNAMICCONTENTTAGS_REPLACETAGCONTENT();
$dctEvent->lists = $lists;
$dctEvent->info = $allSubscribersInfo;
$dctEvent->trigger();
$this->dynamic_content_replacement = $dctEvent->contentTobeReplaced;
if ($returnCustomFields) {
return $allCustomFields;
}
}
/**
* _send
*
* Send email campaign that is triggered by the "trigger email".
*
* @param Array $triggerrecord Trigger record
* @param Array $queuerecord Queue record
* @param Array $newsletter Newsletter record
* @return Array Returns a status result that contains the sending result, and the email address that get sent
*/
private function _send($triggerrecord, $queuerecord, $newsletter)
{
static $prevUserID = 0;
static $prevQueueID = 0;
static $userPause = 0;
static $subscriberAPI = null;
$triggerid = $triggerrecord['triggeremailsid'];
$newsletterid = $newsletter['newsletterid'];
$recipientid = $queuerecord['recipient'];
$user = null;
$email = null;
$customfields = array();
$return = array(
'email' => '',
'message' => '',
'listid' => 0,
'result' => false
);
if (is_null($subscriberAPI)) {
$subscriberAPI = new Subscribers_API();
}
/**
* Get owner of trigger email
*/
$user = $this->_cacheUser($triggerrecord['ownerid']);
if (empty($user)) {
trigger_error('Cannot get trigger owner record', E_USER_NOTICE);
return $return;
}
/**
* -----
*/
/**
* Get email object, and setup
* This will setup emails and setup everything that it needs to have according to the newsletter record.
*/
$email = new SS_Email_API();
$email->Set('CharSet', SENDSTUDIO_CHARSET);
if (!SENDSTUDIO_SAFE_MODE) {
$email->Set('imagedir', TEMP_DIRECTORY . '/triggeremails.' . $triggerrecord['queueid']);
} else {
$email->Set('imagedir', TEMP_DIRECTORY . '/send');
}
if (SENDSTUDIO_FORCE_UNSUBLINK) {
$email->ForceLinkChecks(true);
}
$email->Set('Subject', $newsletter['subject']);
/**
* Setup attachments
*/
$email->ClearAttachments();
$tempAttachments = SendStudio_Functions::GetAttachments('newsletters', $newsletterid, true);
if ($tempAttachments) {
$path = $tempAttachments['path'];
$files = $tempAttachments['filelist'];
foreach ($files as $p => $file) {
$email->AddAttachment($path . DIRECTORY_SEPARATOR . $file);
}
}
/**
* -----
*/
/**
* Set up the contents of the newsletter and the formatting (ie. multipart/html only/text only)
*/
$format = $newsletter['format'];
$email->Set('Multipart', false);
if ($format == 'b' || $format == 't') {
if ($newsletter['textbody']) {
$email->AddBody('text', $newsletter['textbody']);
$email->AppendBody('text', $user->Get('textfooter'));
$email->AppendBody('text', stripslashes(SENDSTUDIO_TEXTFOOTER));
}
}
if ($format == 'b' || $format == 'h') {
if ($newsletter['htmlbody']) {
$email->AddBody('html', $newsletter['htmlbody']);
$email->AppendBody('html', $user->Get('htmlfooter'));
$email->AppendBody('html', stripslashes(SENDSTUDIO_HTMLFOOTER));
}
}
if ($format == 'b') {
if ($newsletter['textbody'] && $newsletter['htmlbody']) {
$email->Set('Multipart', true);
} else {
$email->Set('Multipart', false);
}
}
/**
* -----
*/
// Setup custom fields
$customfields = $email->GetCustomFields();
if (!is_a($email, 'SS_Email_API')) {
trigger_error('Cannot instantiate email object to be used to send emails', E_USER_NOTICE);
return $return;
}
$email->Debug = $this->_debugMode;
/**
* -----
*/
/**
* Set up email object for any headers and SMTP server details.
* These setup will take account of each trigger records (ie. owner and user as well as stats and other sending related headers)
*/
/**
* Calculate pause time to make sure it complies with the throttling
*/
$pause = $pausetime = 0;
if ($user->perhour > 0) {
$pause = $user->perhour;
}
// in case the system rate is less than the user rate, lower it.
if (SENDSTUDIO_MAXHOURLYRATE > 0) {
if ($pause == 0) {
$pause = SENDSTUDIO_MAXHOURLYRATE;
} else {
$pause = min($pause, SENDSTUDIO_MAXHOURLYRATE);
}
}
if ($pause > 0) {
$pausetime = 3600 / $pause;
}
$userPause = $pausetime;
$this->_log('UserPause is set to ' . $pausetime);
/**
* -----
*/
$email->SetSmtp(SENDSTUDIO_SMTP_SERVER, SENDSTUDIO_SMTP_USERNAME, @base64_decode(SENDSTUDIO_SMTP_PASSWORD), SENDSTUDIO_SMTP_PORT);
if ($user->smtpserver) {
$email->SetSmtp($user->smtpserver, $user->smtpusername, $user->smtppassword, $user->smtpport);
}
// If queue has changed since previous send, update email class for queue related information
$email->TrackOpens((array_key_exists('trackopens', $triggerrecord['triggeractions']['send']) && $triggerrecord['triggeractions']['send']['trackopens'] == '1'));
$email->TrackLinks((array_key_exists('tracklinks', $triggerrecord['triggeractions']['send']) && $triggerrecord['triggeractions']['send']['tracklinks'] == '1'));
$email->Set('statid', $triggerrecord['statid']);
$email->Set('FromName', $triggerrecord['triggeractions']['send']['sendfromname']);
$email->Set('FromAddress', $triggerrecord['triggeractions']['send']['sendfromemail']);
$email->Set('ReplyTo', $triggerrecord['triggeractions']['send']['replyemail']);
$email->Set('BounceAddress', $triggerrecord['triggeractions']['send']['bounceemail']);
$email->Set('EmbedImages', ((array_key_exists('embedimages', $triggerrecord['triggeractions']['send'])) && $triggerrecord['triggeractions']['send']['embedimages'] == '1'));
$email->Set('Multipart', ((array_key_exists('multipart', $triggerrecord['triggeractions']['send'])) && $triggerrecord['triggeractions']['send']['multipart'] == '1'));
/**
* -----
*/
/**
* Set up recipient
*/
$subscriberinfo = $subscriberAPI->LoadSubscriberList($recipientid, 0, true);
if (empty($subscriberinfo)) {
trigger_error('Cannot fetch recipient details', E_USER_NOTICE);
return $return;
}
$listinfo = $this->_cacheListGet($subscriberinfo['listid']);
if (empty($listinfo)) {
trigger_error('Unable to load recipient list details', E_USER_NOTICE);
return $return;
}
// List ID for the particualar subscriber
$email->Set('listids', $subscriberinfo['listid']);
$subscriberinfo['ipaddress'] = $subscriberinfo['confirmip'];
if (!$subscriberinfo['ipaddress']) {
$subscriberinfo['ipaddress'] = $subscriberinfo['requestip'];
}
if (!$subscriberinfo['ipaddress']) {
$subscriberinfo['ipaddress'] = '';
}
$subscriberinfo['subscriberid'] = $recipientid;
$subscriberinfo['newsletter'] = $triggerrecord['triggeractions']['send']['newsletterid'];
$subscriberinfo['listid'] = $subscriberinfo['listid'];
$subscriberinfo['statid'] = $triggerrecord['statid'];
$subscriberinfo['listname'] = $listinfo['name'];
$subscriberinfo['companyname'] = $listinfo['companyname'];
$subscriberinfo['companyaddress'] = $listinfo['companyaddress'];
$subscriberinfo['companyphone'] = $listinfo['companyphone'];
if (!isset($subscriberinfo['CustomFields']) && empty($subscriberinfo['CustomFields'])) {
$subscriberinfo['CustomFields'] = array();
/**
* If the subscriber has no custom fields coming from the database, then set up blank placeholders.
* If they have no custom fields in the database, they have no records in the 'all_customfields' array - so we need to fill it up with blank entries.
*/
foreach ($customfields as $fieldid => $fieldname) {
$subscriberinfo['CustomFields'][] = array(
'fieldid' => $fieldid,
'fieldname' => $fieldname,
'fieldtype' => 'text',
'defaultvalue' => '',
'fieldsettings' => '',
'subscriberid' => $recipientid,
'data' => ''
);
}
} else {
require_once(SENDSTUDIO_API_DIRECTORY.'/customfields_date.php');
foreach($subscriberinfo['CustomFields'] as $ar_key => $ar_value){
if($ar_value['fieldtype'] == 'date'){
$cfdateapi = new CustomFields_Date_API($ar_value['fieldid']);
$real_order = $cfdateapi->GetRealValue($ar_value['data']);
$subscriberinfo['CustomFields'][$ar_key]['data'] = $real_order;
}
}
}
// TODO refactor
$name = '';
$firstname_field = $triggerrecord['triggeractions']['send']['firstnamefield'];
if ($firstname_field) {
foreach ($subscriberinfo['CustomFields'] as $p => $details) {
if ($details['fieldid'] == $firstname_field && $details['data'] != '') {
$name = $details['data'];
break;
}
}
}
$lastname_field = $triggerrecord['triggeractions']['send']['lastnamefield'];
if ($lastname_field) {
foreach ($subscriberinfo['CustomFields'] as $p => $details) {
if ($details['fieldid'] == $lastname_field && $details['data'] != '') {
$name .= ' ' . $details['data'];
break;
}
}
}
if (trim($name) == '') {
$name = false;
}
// --
// SetupDynamicContentFields
$dctEventListId = (is_array($subscriberinfo['listid']))?$subscriberinfo['listid']:array($subscriberinfo['listid']);
$dctEvent =new EventData_IEM_ADDON_DYNAMICCONTENTTAGS_REPLACETAGCONTENT();
$dctEvent->lists = $dctEventListId;
$dctEvent->info = array($subscriberinfo);
$dctEvent->trigger();
// --
$email->ClearRecipients();
$email->AddRecipient($subscriberinfo['emailaddress'], $name, $subscriberinfo['format'], $subscriberinfo['subscriberid']);
$email->AddDynamicContentInfo($dctEvent->contentTobeReplaced);
$email->AddCustomFieldInfo($subscriberinfo['emailaddress'], $subscriberinfo);
$status = $email->Send(true, true);
if (!$status['success']) {
list($return['email'], $return['message']) = $status['fail'][0];
trigger_error("Failed sending trigger email to {$return['email']}: {$return['message']}");
return $return;
}
$return['listid'] = $subscriberinfo['listid'];
$return['email'] = $subscriberinfo['emailaddress'];
/**
* -----
*/
// Set previous user
$prevUserID = $user->userid;
// Set previous queue
$prevQueueID = $triggerrecord['queueid'];
$return['result'] = true;
return $return;
}
/**
* Since we're displaying a specific newsletter we can check for the list before anything else.
* If it's not valid, we can abort.
*/
if (!$listid || (!$newsletterid && !$autoresponderid)) {
echo 'Invalid archive link.';
exit();
}
$list_loaded = $listapi->Load($listid);
if (!$list_loaded) {
echo 'Invalid archive link.';
exit();
}
$dctEvent =new EventData_IEM_ADDON_DYNAMICCONTENTTAGS_REPLACETAGCONTENT();
$dctEvent->lists = array($listid);
if ($newsletterid) {
$id = $newsletterid;
$api = $newsletterapi;
} else {
$id = $autoresponderid;
$api = $autoapi;
}
$loaded = $api->Load($id);
/**
* Make sure the newsletter is ok to be displayed.
* If it's not in "archive" mode or "active" mode, don't show anything.
*/
/**
* SetupDynamicContentFields
* Loads the Dynamic Content to be replaced and its content
*
* @param Array $recipients The recipient data to load Dynamic content field data for.
*
* @return Void Returns nothing. It does all of it's work against the dynamic_content_replacement class variable directly.
*/
function SetupDynamicContentFields($recipients=array()) {
$customFields = $this->Lists_API->GetCustomFields($this->jobdetails['Lists']);
$allCustomFields = array();
$allSubscribersInfo = array();
foreach ($customFields as $customFieldEntry) {
$allCustomFields[] = $customFieldEntry['name'];
}
$this->custom_fields_to_replace = array_unique(array_merge($allCustomFields, $this->custom_fields_to_replace));
$allCustomFields = $this->Subscriber_API->GetAllSubscriberCustomFields($this->jobdetails['Lists'],$allCustomFields, $recipients);
$counter = 0;
foreach ($allCustomFields as $subscriberId => $customFieldEntry) {
$infoholder = $this->Subscriber_API->LoadSubscriberBasicInformation($subscriberId, $this->jobdetails['Lists']);
if(!empty($infoholder)){
$allSubscribersInfo[$counter] = $infoholder;
$allSubscribersInfo[$counter]['CustomFields'] = $customFieldEntry;
$counter++;
}
}
$dctEvent =new EventData_IEM_ADDON_DYNAMICCONTENTTAGS_REPLACETAGCONTENT();
$dctEvent->lists = $this->jobdetails['Lists'];
$dctEvent->info = $allSubscribersInfo;
$dctEvent->trigger();
$this->dynamic_content_replacement = $dctEvent->contentTobeReplaced;
}
