2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
40 class EmailMan extends SugarBean{
58 var $table_name = "emailman";
59 var $object_name = "EmailMan";
60 var $module_dir = "EmailMan";
65 var $notes_array = array();
66 var $verified_email_marketing_ids = array();
68 return "EmailMan:\nid = $this->id ,user_id= $this->user_id module = $this->module , related_id = $this->related_id , related_type = $this->related_type ,list_id = $this->list_id, send_date_time= $this->send_date_time\n";
71 // This is used to retrieve related fields from form posts.
72 var $additional_column_fields = array();
79 var $new_schema = true;
81 function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false) {
82 $query = array('select' => '', 'from' => '', 'where' => '', 'order_by' => '');
86 $query['select'] = "SELECT $this->table_name.* ,
87 campaigns.name as campaign_name,
88 email_marketing.name as message_name,
90 WHEN 'Contacts' THEN ".$this->db->concat('contacts', array('first_name', 'last_name'), ' ')."
91 WHEN 'Leads' THEN ".$this->db->concat('leads', array('first_name', 'last_name'), ' ')."
92 WHEN 'Accounts' THEN accounts.name
93 WHEN 'Users' THEN ".$this->db->concat('users', array('first_name', 'last_name'), ' ')."
94 WHEN 'Prospects' THEN ".$this->db->concat('prospects', array('first_name', 'last_name'), ' ')."
96 $query['from'] = " FROM $this->table_name
97 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
98 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
99 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
100 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
101 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
102 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
103 LEFT JOIN email_addr_bean_rel ON email_addr_bean_rel.bean_id = $this->table_name.related_id and $this->table_name.related_type = email_addr_bean_rel.bean_module and email_addr_bean_rel.primary_address = 1 and email_addr_bean_rel.deleted=0
104 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
105 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
107 $where_auto = " $this->table_name.deleted=0";
110 $query['where'] = "WHERE $where AND ".$where_auto;
112 $query['where'] = "WHERE ".$where_auto;
114 if(isset($params['group_by'])) {
115 $query['order_by'] .= " GROUP BY {$params['group_by']}";
120 $query['order_by'] = ' ORDER BY ' . $this->process_order_by($order_by, null);
127 return $query['select'] . $query['from'] . $query['where']. $query['order_by'];
131 function create_queue_items_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false) {
134 return parent::create_new_list_query($order_by, $where,$filter,$params, $show_deleted,$join_type, $return_array,$parentbean, $singleSelect);
137 $query = "SELECT $this->table_name.* ,
138 campaigns.name as campaign_name,
139 email_marketing.name as message_name,
141 WHEN 'Contacts' THEN ".$this->db->concat('contacts', array('first_name', 'last_name'), ' ')."
142 WHEN 'Leads' THEN ".$this->db->concat('leads', array('first_name', 'last_name'), ' ')."
143 WHEN 'Accounts' THEN accounts.name
144 WHEN 'Users' THEN ".$this->db->concat('users', array('first_name', 'last_name'), ' ')."
145 WHEN 'Prospects' THEN ".$this->db->concat('prospects', array('first_name', 'last_name'), ' ')."
146 END) recipient_name";
148 $query .= " FROM $this->table_name
149 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
150 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
151 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
152 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
153 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
154 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
155 LEFT JOIN email_addr_bean_rel ON email_addr_bean_rel.bean_id = $this->table_name.related_id and $this->table_name.related_type = email_addr_bean_rel.bean_module and email_addr_bean_rel.primary_address = 1 and email_addr_bean_rel.deleted=0
156 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
157 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
160 if( isset($params['group_by']) )
162 $group_by = str_replace("emailman", "em", $params['group_by']);
163 $query .= "INNER JOIN (select min(id) as id from emailman em GROUP BY $group_by ) secondary
164 on {$this->table_name}.id = secondary.id ";
167 $where_auto = " $this->table_name.deleted=0";
170 $query .= "WHERE $where AND ".$where_auto;
172 $query .= "WHERE ".$where_auto;
177 $query .= ' ORDER BY ' . $this->process_order_by($order_by, null);
184 function create_list_query($order_by, $where, $show_deleted = 0){
186 $query = "SELECT $this->table_name.* ,
187 campaigns.name as campaign_name,
188 email_marketing.name as message_name,
190 WHEN 'Contacts' THEN ".$this->db->concat('contacts', array('first_name', 'last_name'), ' ')."
191 WHEN 'Leads' THEN ".$this->db->concat('leads', array('first_name', 'last_name'), ' ')."
192 WHEN 'Accounts' THEN accounts.name
193 WHEN 'Users' THEN ".$this->db->concat('users', array('first_name', 'last_name'), ' ')."
194 WHEN 'Prospects' THEN ".$this->db->concat('prospects', array('first_name', 'last_name'), ' ')."
195 END) recipient_name";
196 $query .= " FROM $this->table_name
197 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
198 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
199 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
200 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
201 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
202 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
203 LEFT JOIN email_addr_bean_rel ON email_addr_bean_rel.bean_id = $this->table_name.related_id and $this->table_name.related_type = email_addr_bean_rel.bean_module and email_addr_bean_rel.primary_address = 1 and email_addr_bean_rel.deleted=0
204 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
205 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
207 $where_auto = " $this->table_name.deleted=0";
210 $query .= "where $where AND ".$where_auto;
212 $query .= "where ".$where_auto;
216 $query .= ' ORDER BY ' . $this->process_order_by($order_by, null);
221 function get_list_view_data()
223 global $locale, $current_user;
224 $temp_array = parent::get_list_view_array();
226 $related_type = $temp_array['RELATED_TYPE'];
227 $related_id = $temp_array['RELATED_ID'];
228 $is_person = SugarModule::get($related_type)->moduleImplements('Person');
232 $query = "SELECT first_name, last_name FROM ". strtolower($related_type) ." WHERE id ='". $related_id ."'";
234 $query = "SELECT name FROM ". strtolower($related_type) ." WHERE id ='". $related_id ."'";
237 $result=$this->db->query($query);
238 $row=$this->db->fetchByAssoc($result);
242 $temp_array['RECIPIENT_NAME'] = $is_person ? $locale->getLocaleFormattedName($row['first_name'], $row['last_name'], '') : $row['name'];
245 //also store the recipient_email address
246 $query = "SELECT addr.email_address FROM email_addresses addr,email_addr_bean_rel eb WHERE eb.deleted=0 AND addr.id=eb.email_address_id AND bean_id ='". $related_id ."' AND primary_address = '1'";
248 $result=$this->db->query($query);
249 $row=$this->db->fetchByAssoc($result);
252 $temp_array['RECIPIENT_EMAIL']=$row['email_address'];
255 $this->email1 = $temp_array['RECIPIENT_EMAIL'];
256 $temp_array['EMAIL1_LINK'] = $current_user->getEmailLink('email1', $this, '', '', 'ListView');
262 function set_as_sent($email_address, $delete= true,$email_id=null, $email_type=null,$activity_type=null){
266 $this->send_attempts++;
267 if($delete || $this->send_attempts > 5){
269 //create new campaign log record.
271 $campaign_log = new CampaignLog();
272 $campaign_log->campaign_id=$this->campaign_id;
273 $campaign_log->target_tracker_key=$this->target_tracker_key;
274 $campaign_log->target_id= $this->related_id;
275 $campaign_log->target_type=$this->related_type;
276 $campaign_log->marketing_id=$this->marketing_id;
277 //if test suppress duplicate email address checking.
279 $campaign_log->more_information=$email_address;
281 $campaign_log->activity_type=$activity_type;
282 $campaign_log->activity_date=$timedate->now();
283 $campaign_log->list_id=$this->list_id;
284 $campaign_log->related_id= $email_id;
285 $campaign_log->related_type=$email_type;
286 $campaign_log->save();
288 $query = "DELETE FROM emailman WHERE id = $this->id";
289 $this->db->query($query);
291 //try to send the email again a day later.
292 $query = 'UPDATE ' . $this->table_name . " SET in_queue='1', send_attempts='$this->send_attempts', in_queue_date=". $this->db->now() ." WHERE id = '$this->id'";
293 $this->db->query($query);
298 * Function finds the reference email for the campaign. Since a campaign can have multiple email templates
299 * the reference email has same id as the marketing id.
300 * this function will create an email if one does not exist. also the function will load these relationships leads, accounts, contacts
303 * @param varchar marketing_id message id
304 * @param string $subject email subject
305 * @param string $body_text Email Body Text
306 * @param string $body_html Email Body HTML
307 * @param string $campaign_name Campaign Name
308 * @param string from_address Email address of the sender, usually email address of the configured inbox.
309 * @param string sender_id If of the user sending the campaign.
310 * @param array macro_nv array of name value pair, one row for each replacable macro in email template text.
313 function create_ref_email($marketing_id,$subject,$body_text,$body_html,$campagin_name,$from_address,$sender_id,$notes,$macro_nv,$newmessage) {
315 global $mod_Strings, $timedate;
316 $upd_ref_email=false;
317 if ($newmessage or empty($this->ref_email->id)) {
318 $this->ref_email = new Email();
319 $this->ref_email->retrieve($marketing_id, true, false);
321 //the reference email should be updated when user swithces from test mode to regular mode,and, for every run in test mode, and is user
322 //switches back to test mode.
323 //this is to account for changes to email template.
324 $upd_ref_email=(!empty($this->ref_email->id) and $this->ref_email->parent_type=='test' and $this->ref_email->parent_id=='test');
325 //following condition is for switching back to test mode.
326 if (!$upd_ref_email) $upd_ref_email=($this->test and !empty($this->ref_email->id) and empty($this->ref_email->parent_type) and empty($this->ref_email->parent_id));
327 if (empty($this->ref_email->id) or $upd_ref_email) {
328 //create email record.
329 $this->ref_email->id=$marketing_id;
330 $this->ref_email->date_sent = '';
332 if ($upd_ref_email==false) {
333 $this->ref_email->new_with_id=true;
336 $this->ref_email->to_addrs= '';
337 $this->ref_email->to_addrs_ids = '';
338 $this->ref_email->to_addrs_names = '';
339 $this->ref_email->to_addrs_emails ='';
340 $this->ref_email->type= 'campaign';
341 $this->ref_email->deleted = '0';
342 $this->ref_email->name = $campagin_name.': '.$subject ;
343 $this->ref_email->description_html = $body_html;
344 $this->ref_email->description = $body_text;
345 $this->ref_email->from_addr = $from_address;
346 $this->ref_email->assigned_user_id = $sender_id;
348 $this->ref_email->parent_type = 'test';
349 $this->ref_email->parent_id = 'test';
351 $this->ref_email->parent_type = '';
352 $this->ref_email->parent_id = '';
354 $this->ref_email->date_start = $timedate->nowDate();
355 $this->ref_email->time_start = $timedate->asUserTime($timedate->getNow(true));
357 $this->ref_email->status='sent';
358 $retId = $this->ref_email->save();
360 foreach($notes as $note) {
361 if($note->object_name == 'Note') {
362 if (! empty($note->file->temp_file_location) && is_file($note->file->temp_file_location)) {
363 $file_location = $note->file->temp_file_location;
364 $filename = $note->file->original_file_name;
365 $mime_type = $note->file->mime_type;
367 $file_location = "upload://{$note->id}";
368 $filename = $note->id.$note->filename;
369 $mime_type = $note->file_mime_type;
371 } elseif($note->object_name == 'DocumentRevision') { // from Documents
372 $filename = $note->id.$note->filename;
373 $file_location = "upload://$filename";
374 $mime_type = $note->file_mime_type;
377 $noteAudit = new Note();
378 $noteAudit->parent_id = $retId;
379 $noteAudit->parent_type = $this->ref_email->module_dir;
380 $noteAudit->description = "[".$note->filename."] ".$mod_strings['LBL_ATTACHMENT_AUDIT'];
381 $noteAudit->filename=$filename;
382 $noteAudit->file_mime_type=$mime_type;
383 $noteAudit_id=$noteAudit->save();
385 UploadFile::duplicate_file($note->id, $noteAudit_id, $filename);
389 //load relationships.
390 $this->ref_email->load_relationship('users');
391 $this->ref_email->load_relationship('prospects');
392 $this->ref_email->load_relationship('contacts');
393 $this->ref_email->load_relationship('leads');
394 $this->ref_email->load_relationship('accounts');
397 if (!empty($this->related_id ) && !empty($this->related_type)) {
399 //save relationships.
400 switch ($this->related_type) {
406 $rel_name="prospects";
410 $rel_name="contacts";
418 $rel_name="accounts";
422 //required for one email per campaign per marketing message.
423 $this->ref_email->$rel_name->add($this->related_id,array('campaign_data'=>serialize($macro_nv)));
425 return $this->ref_email->id;
429 * The function creates a copy of email send to each target.
431 function create_indiv_email($module,$mail) {
433 global $locale, $timedate;
434 $email = new Email();
435 $email->to_addrs= $module->name . '<'.$module->email1.'>';
436 $email->to_addrs_ids = $module->id .';';
437 $email->to_addrs_names = $module->name . ';';
438 $email->to_addrs_emails = $module->email1 . ';';
439 $email->type= 'archived';
440 $email->deleted = '0';
441 $email->name = $this->current_campaign->name.': '.$mail->Subject ;
442 if ($mail->ContentType == "text/plain") {
443 $email->description = $mail->Body;
444 $email->description_html =null;
446 $email->description_html = $mail->Body;
447 $email->description = $mail->AltBody;
449 $email->from_addr = $mail->From;
450 $email->assigned_user_id = $this->user_id;
451 $email->parent_type = $this->related_type;
452 $email->parent_id = $this->related_id ;
454 $email->date_start = $timedate->nowDbDate();
455 $email->time_start = $timedate->asDbTime($timedate->getNow());
456 $email->status='sent';
457 $retId = $email->save();
459 foreach($this->notes_array as $note) {
460 if(!class_exists('Note')) {
463 // create "audit" email without duping off the file to save on disk space
464 $noteAudit = new Note();
465 $noteAudit->parent_id = $retId;
466 $noteAudit->parent_type = $email->module_dir;
467 $noteAudit->description = "[".$note->filename."] ".$mod_strings['LBL_ATTACHMENT_AUDIT'];
471 if (!empty($this->related_id ) && !empty($this->related_type)) {
473 //save relationships.
474 switch ($this->related_type) {
480 $rel_name="prospects";
484 $rel_name="contacts";
492 $rel_name="accounts";
496 if (!empty($rel_name)) {
497 $email->load_relationship($rel_name);
498 $email->$rel_name->add($this->related_id);
504 * Call this function to verify the email_marketing message and email_template configured
505 * for the campaign. If issues are found a fatal error will be logged but processing will not stop.
506 * @return Boolean Returns true if all campaign parameters are set correctly
508 function verify_campaign($marketing_id) {
510 if (!isset($this->verified_email_marketing_ids[$marketing_id])) {
511 if (!class_exists('EmailMarketing')) {
514 $email_marketing = new EmailMarketing();
515 $ret=$email_marketing->retrieve($marketing_id);
517 $GLOBALS['log']->fatal('Error retrieving marketing message for the email campaign. marketing_id = ' .$marketing_id);
521 //verify the email template.
522 if (empty($email_marketing->template_id)) {
523 $GLOBALS['log']->fatal('Error retrieving template for the email campaign. marketing_id = ' .$marketing_id);
527 if (!class_exists('EmailTemplate')) {
530 $emailtemplate= new EmailTemplate();
532 $ret=$emailtemplate->retrieve($email_marketing->template_id);
534 $GLOBALS['log']->fatal('Error retrieving template for the email campaign. template_id = ' .$email_marketing->template_id);
538 if (empty($emailtemplate->subject) and empty($emailtemplate->body) and empty($emailtemplate->body_html)) {
539 $GLOBALS['log']->fatal('Email template is empty. email_template_id=' .$email_marketing->template_id);
544 $this->verified_email_marketing_ids[$marketing_id]=1;
548 function sendEmail($mail,$save_emails=1,$testmode=false){
549 $this->test=$testmode;
551 global $beanList, $beanFiles, $sugar_config;
554 $OBCharset = $locale->getPrecedentPreference('default_email_charset');
555 $mod_strings = return_module_language( $sugar_config['default_language'], 'EmailMan');
557 //get tracking entities locations.
558 if (!isset($this->tracking_url)) {
559 if (!class_exists('Administration')) {
562 $admin=new Administration();
563 $admin->retrieveSettings('massemailer'); //retrieve all admin settings.
564 if (isset($admin->settings['massemailer_tracking_entities_location_type']) and $admin->settings['massemailer_tracking_entities_location_type']=='2' and isset($admin->settings['massemailer_tracking_entities_location']) ) {
565 $this->tracking_url=$admin->settings['massemailer_tracking_entities_location'];
567 $this->tracking_url=$sugar_config['site_url'];
571 //make sure tracking url ends with '/' character
572 $strLen = strlen($this->tracking_url);
573 if($this->tracking_url{$strLen-1} !='/'){
574 $this->tracking_url .='/';
577 if(!isset($beanList[$this->related_type])){
580 $class = $beanList[$this->related_type];
581 if (!class_exists($class)) {
582 require_once($beanFiles[$class]);
585 if (!class_exists('Email')) {
589 $module = new $class();
590 $module->retrieve($this->related_id);
591 $module->emailAddress->handleLegacyRetrieve($module);
593 //check to see if bean has a primary email address
594 if (!$this->is_primary_email_address($module)) {
595 //no primary email address designated, do not send out email, create campaign log
596 //of type send error to denote that this user was not emailed
597 $this->set_as_sent($module->email1, true,null,null,'send error');
598 //create fatal logging for easy review of cause.
599 $GLOBALS['log']->fatal('Email Address provided is not Primary Address for email with id ' . $module->email1 . "' Emailman id=$this->id");
603 if (!$this->valid_email_address($module->email1)) {
604 $this->set_as_sent($module->email1, true,null,null,'invalid email');
605 $GLOBALS['log']->fatal('Encountered invalid email address' . $module->email1 . " Emailman id=$this->id");
609 if ((!isset($module->email_opt_out)
610 || ($module->email_opt_out !== 'on'
611 && $module->email_opt_out !== 1
612 && $module->email_opt_out !== '1'))
613 && (!isset($module->invalid_email)
614 || ($module->invalid_email !== 'on'
615 && $module->invalid_email !== 1
616 && $module->invalid_email !== '1'))){
617 $lower_email_address=strtolower($module->email1);
618 //test against indivdual address.
619 if (isset($this->restricted_addresses) and isset($this->restricted_addresses[$lower_email_address])) {
620 $this->set_as_sent($lower_email_address, true,null,null,'blocked');
623 //test against restricted domains
624 $at_pos=strrpos($lower_email_address,'@');
625 if ($at_pos !== false) {
626 foreach ($this->restricted_domains as $domain=>$value) {
627 $pos=strrpos($lower_email_address,$domain);
628 if ($pos !== false && $pos > $at_pos) {
630 $this->set_as_sent($lower_email_address, true,null,null,'blocked');
636 //test for duplicate email address by marketing id.
637 $dup_query="select id from campaign_log where more_information='".$module->email1."' and marketing_id='".$this->marketing_id."'";
638 $dup=$this->db->query($dup_query);
639 $dup_row=$this->db->fetchByAssoc($dup);
640 if (!empty($dup_row)) {
641 //we have seen this email address before
642 $this->set_as_sent($module->email1,true,null,null,'blocked');
646 $this->target_tracker_key=create_guid();
648 //fetch email marketing.
649 if (empty($this->current_emailmarketing) or !isset($this->current_emailmarketing)) {
650 if (!class_exists('EmailMarketing')) {
654 $this->current_emailmarketing=new EmailMarketing();
657 if (empty($this->current_emailmarketing->id) or $this->current_emailmarketing->id !== $this->marketing_id) {
658 $this->current_emailmarketing->retrieve($this->marketing_id);
660 $this->newmessage = true;
662 //fetch email template associate with the marketing message.
663 if (empty($this->current_emailtemplate) or $this->current_emailtemplate->id !== $this->current_emailmarketing->template_id) {
664 if (!class_exists('EmailTemplate')) {
667 $this->current_emailtemplate= new EmailTemplate();
669 $this->current_emailtemplate->retrieve($this->current_emailmarketing->template_id);
671 //escape email template contents.
672 $this->current_emailtemplate->subject=from_html($this->current_emailtemplate->subject);
673 $this->current_emailtemplate->body_html=from_html($this->current_emailtemplate->body_html);
674 $this->current_emailtemplate->body=from_html($this->current_emailtemplate->body);
676 $q = "SELECT * FROM notes WHERE parent_id = '".$this->current_emailtemplate->id."' AND deleted = 0";
677 $r = $this->db->query($q);
679 // cn: bug 4684 - initialize the notes array, else old data is still around for the next round
680 $this->notes_array = array();
681 if (!class_exists('Note')){
682 require_once('modules/Notes/Note.php');
684 while($a = $this->db->fetchByAssoc($r)) {
685 $noteTemplate = new Note();
686 $noteTemplate->retrieve($a['id']);
687 $this->notes_array[] = $noteTemplate;
691 // fetch mailbox details..
692 if(empty($this->current_mailbox)) {
693 if (!class_exists('InboundEmail')) {
696 $this->current_mailbox= new InboundEmail();
698 if (empty($this->current_mailbox->id) or $this->current_mailbox->id !== $this->current_emailmarketing->inbound_email_id) {
699 $this->current_mailbox->retrieve($this->current_emailmarketing->inbound_email_id);
700 //extract the email address.
701 $this->mailbox_from_addr=$this->current_mailbox->get_stored_options('from_addr','nobody@example.com',null);
704 // fetch campaign details..
705 if (empty($this->current_campaign)) {
706 if (!class_exists('Campaign')) {
709 $this->current_campaign= new Campaign();
711 if (empty($this->current_campaign->id) or $this->current_campaign->id !== $this->current_emailmarketing->campaign_id) {
712 $this->current_campaign->retrieve($this->current_emailmarketing->campaign_id);
714 //load defined tracked_urls
715 $this->current_campaign->load_relationship('tracked_urls');
716 $query_array=$this->current_campaign->tracked_urls->getQuery(true);
717 $query_array['select']="SELECT tracker_name, tracker_key, id, is_optout ";
718 $result=$this->current_campaign->db->query(implode(' ',$query_array));
720 $this->has_optout_links=false;
721 $this->tracker_urls=array();
722 while (($row=$this->current_campaign->db->fetchByAssoc($result)) != null) {
723 $this->tracker_urls['{'.$row['tracker_name'].'}']=$row;
724 //has the user defined opt-out links for the campaign.
725 if ($row['is_optout']==1) {
726 $this->has_optout_links=true;
731 $mail->ClearAllRecipients();
732 $mail->ClearReplyTos();
733 $mail->Sender = $this->mailbox_from_addr;
734 $mail->From = $this->mailbox_from_addr;
735 $mail->FromName = $this->current_emailmarketing->from_name;
736 $mail->ClearCustomHeaders();
737 $mail->AddCustomHeader('X-CampTrackID:'.$this->target_tracker_key);
738 //CL - Bug 25256 Check if we have a reply_to_name/reply_to_addr value from the email marketing table. If so use email marketing entry; otherwise current mailbox (inbound email) entry
739 $replyToName = empty($this->current_emailmarketing->reply_to_name) ? $this->current_mailbox->get_stored_options('reply_to_name',$mail->FromName,null) : $this->current_emailmarketing->reply_to_name;
740 $replyToAddr = empty($this->current_emailmarketing->reply_to_addr) ? $this->current_mailbox->get_stored_options('reply_to_addr',$mail->From,null) : $this->current_emailmarketing->reply_to_addr;
742 $mail->AddReplyTo($replyToAddr,$locale->translateCharsetMIME(trim($replyToName), 'UTF-8', $OBCharset));
744 //parse and replace bean variables.
746 $focus_name = 'Contacts';
747 if($module->module_dir == 'Accounts')
749 $focus_name = 'Accounts';
753 $template_data= $this->current_emailtemplate->parse_email_template(array('subject'=>$this->current_emailtemplate->subject,
754 'body_html'=>$this->current_emailtemplate->body_html,
755 'body'=>$this->current_emailtemplate->body,
757 ,$focus_name, $module
760 //add email address to this list.
761 $macro_nv['sugar_to_email_address']=$module->email1;
762 $macro_nv['email_template_id']=$this->current_emailmarketing->template_id;
764 //parse and replace urls.
765 //this is new style of adding tracked urls to a campaign.
766 $tracker_url_template= $this->tracking_url . 'index.php?entryPoint=campaign_trackerv2&track=%s'.'&identifier='.$this->target_tracker_key;
767 $removeme_url_template=$this->tracking_url . 'index.php?entryPoint=removeme&identifier='.$this->target_tracker_key;
768 $template_data= $this->current_emailtemplate->parse_tracker_urls($template_data,$tracker_url_template,$this->tracker_urls,$removeme_url_template);
769 $mail->AddAddress($module->email1,$locale->translateCharsetMIME(trim($module->name), 'UTF-8', $OBCharset) );
771 //refetch strings in case they have been changed by creation of email templates or other beans.
772 $mod_strings = return_module_language( $sugar_config['default_language'], 'EmailMan');
775 $mail->Subject = $mod_strings['LBL_PREPEND_TEST'] . $template_data['subject'];
777 $mail->Subject = $template_data['subject'];
780 //check if this template is meant to be used as "text only"
782 if(isset($this->current_emailtemplate->text_only) && $this->current_emailtemplate->text_only){$text_only =true;}
783 //if this template is textonly, then just send text body. Do not add tracker, opt out,
784 //or perform other processing as it will not show up in text only email
786 $this->description_html = '';
787 $mail->IsHTML(false);
788 $mail->Body = $template_data['body'];
791 $mail->Body = wordwrap($template_data['body_html'], 900);
792 //BEGIN:this code will trigger for only campaigns pending before upgrade to 4.2.0.
793 //will be removed for the next release.
794 if(!isset($btracker)) $btracker=false;
796 $mail->Body .= "<br /><br /><a href='". $tracker_url ."'>" . $tracker_text . "</a><br /><br />";
798 if (!empty($tracker_url)) {
799 $mail->Body = str_replace('TRACKER_URL_START', "<a href='" . $tracker_url ."'>", $mail->Body);
800 $mail->Body = str_replace('TRACKER_URL_END', "</a>", $mail->Body);
801 $mail->AltBody = str_replace('TRACKER_URL_START', "<a href='" . $tracker_url ."'>", $mail->AltBody);
802 $mail->AltBody = str_replace('TRACKER_URL_END', "</a>", $mail->AltBody);
807 //do not add the default remove me link if the campaign has a trackerurl of the opotout link
808 if ($this->has_optout_links==false) {
809 $mail->Body .= "<br /><span style='font-size:0.8em'>{$mod_strings['TXT_REMOVE_ME']} <a href='". $this->tracking_url . "index.php?entryPoint=removeme&identifier={$this->target_tracker_key}'>{$mod_strings['TXT_REMOVE_ME_CLICK']}</a></span>";
811 // cn: bug 11979 - adding single quote to comform with HTML email RFC
812 $mail->Body .= "<br /><img alt='' height='1' width='1' src='{$this->tracking_url}index.php?entryPoint=image&identifier={$this->target_tracker_key}' />";
814 $mail->AltBody = $template_data['body'];
816 $mail->AltBody .="\n". $tracker_url;
818 if ($this->has_optout_links==false) {
819 $mail->AltBody .="\n\n\n{$mod_strings['TXT_REMOVE_ME_ALT']} ". $this->tracking_url . "index.php?entryPoint=removeme&identifier=$this->target_tracker_key";
824 // cn: bug 4684, handle attachments in email templates.
825 $mail->handleAttachments($this->notes_array);
826 $tmp_Subject = $mail->Subject;
827 $mail->prepForOutbound();
829 $success = $mail->Send();
830 //Do not save the encoded subject.
831 $mail->Subject = $tmp_Subject;
834 if ($save_emails==1) {
835 $email_id=$this->create_indiv_email($module,$mail);
837 //find/create reference email record. all campaign targets reveiving this message will be linked with this message.
838 $email_id=$this->create_ref_email($this->marketing_id,
839 $this->current_emailtemplate->subject,
840 $this->current_emailtemplate->body,
841 $this->current_emailtemplate->body_html,
842 $this->current_campaign->name,
843 $this->mailbox_from_addr,
849 $this->newmessage = false;
854 $this->set_as_sent($module->email1, true, $email_id, 'Emails', 'targeted');
857 if(!empty($layout_def['parent_id'])) {
858 if (isset($layout_def['fields'][strtoupper($layout_def['parent_id'])])) {
859 $parent.="&parent_id=".$layout_def['fields'][strtoupper($layout_def['parent_id'])];
862 if(!empty($layout_def['parent_module'])) {
863 if (isset($layout_def['fields'][strtoupper($layout_def['parent_module'])])) {
864 $parent.="&parent_module=".$layout_def['fields'][strtoupper($layout_def['parent_module'])];
867 //log send error. save for next attempt after 24hrs. no campaign log entry will be created.
868 $this->set_as_sent($module->email1,false,null,null,'send error');
872 $this->target_tracker_key=create_guid();
874 if (isset($module->email_opt_out) && ($module->email_opt_out === 'on' || $module->email_opt_out == '1' || $module->email_opt_out == 1)) {
875 $this->set_as_sent($module->email1,true,null,null,'removed');
877 if (isset($module->invalid_email) && ($module->invalid_email == 1 || $module->invalid_email == '1')) {
878 $this->set_as_sent($module->email1,true,null,null,'invalid email');
880 $this->set_as_sent($module->email1,true, null,null,'send error');
889 * Validates the passed email address.
890 * Limitations of this algorithm: does not validate email addressess that end with .meuseum
893 function valid_email_address($email_address) {
895 $email_address=trim($email_address);
896 if (empty($email_address)) {
900 $pattern='/[A-Z0-9\._%-]+@[A-Z0-9\.-]+\.[A-Za-z]{2,}$/i';
901 $ret=preg_match($pattern, $email_address);
903 if ($ret===false or $ret==0) {
910 * This function takes in the given bean and searches for a related email address
911 * that has been designated as primary. If one is found, true is returned
912 * If no primary email address is found, then false is returned
915 function is_primary_email_address($bean){
916 $email_address=trim($bean->email1);
918 if (empty($email_address)) {
921 //query for this email address rel and see if this is primary address
922 $primary_qry = "select email_address_id from email_addr_bean_rel where bean_id = '".$bean->id."' and email_addr_bean_rel.primary_address=1 and deleted=0";
923 $res = $bean->db->query($primary_qry);
924 $prim_row=$this->db->fetchByAssoc($res);
925 //return true if this is primary
926 if (!empty($prim_row)) {
933 function create_export_query(&$order_by, &$where) {
934 $custom_join = $this->custom_fields->getJOIN(true, true,$where);
935 $query = "SELECT emailman.*";
937 $query .= $custom_join['select'];
940 $query .= " FROM emailman ";
943 $query .= $custom_join['join'];
946 $where_auto = "( emailman.deleted IS NULL OR emailman.deleted=0 )";
949 $query .= "where ($where) AND ".$where_auto;
951 $query .= "where ".$where_auto;
953 if(!empty($order_by))
955 $query .= ' ORDER BY '. $this->process_order_by($order_by, null);