2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 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 if ( ( $this->db->dbType == 'mysql' ) or ( $this->db->dbType == 'oci8' ) )
89 $query['select'] = "SELECT $this->table_name.* ,
90 campaigns.name as campaign_name,
91 email_marketing.name as message_name,
93 WHEN 'Contacts' THEN CONCAT(CONCAT(contacts.first_name, ' ' ), contacts.last_name)
94 WHEN 'Leads' THEN CONCAT(CONCAT(leads.first_name, ' ' ), leads.last_name)
95 WHEN 'Accounts' THEN accounts.name
96 WHEN 'Users' THEN CONCAT(CONCAT(users.first_name, ' ' ), users.last_name)
97 WHEN 'Prospects' THEN CONCAT(CONCAT(prospects.first_name, ' ' ), prospects.last_name)
100 if($this->db->dbType == 'mssql')
102 $query['select'] = "SELECT $this->table_name.* ,
103 campaigns.name as campaign_name,
104 email_marketing.name as message_name,
106 WHEN 'Contacts' THEN contacts.first_name + ' ' + contacts.last_name
107 WHEN 'Leads' THEN leads.first_name + ' ' + leads.last_name
108 WHEN 'Accounts' THEN accounts.name
109 WHEN 'Users' THEN users.first_name + ' ' + users.last_name
110 WHEN 'Prospects' THEN prospects.first_name + ' ' + prospects.last_name
111 END) recipient_name";
114 $query['from'] = " FROM $this->table_name
115 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
116 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
117 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
118 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
119 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
120 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
121 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.deleted=0
122 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
123 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
125 $where_auto = " $this->table_name.deleted=0";
128 $query['where'] = "WHERE $where AND ".$where_auto;
130 $query['where'] = "WHERE ".$where_auto;
132 if(isset($params['group_by'])) {
133 $query['order_by'] .= " GROUP BY {$params['group_by']}";
138 $query['order_by'] = ' ORDER BY ' . $this->process_order_by($order_by, null);
145 return $query['select'] . $query['from'] . $query['where']. $query['order_by'];
149 function create_queue_items_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false) {
152 return parent::create_new_list_query($order_by, $where,$filter,$params, $show_deleted,$join_type, $return_array,$parentbean, $singleSelect);
155 if ( ( $this->db->dbType == 'mysql' ) or ( $this->db->dbType == 'oci8' ) )
158 $query = "SELECT $this->table_name.* ,
159 campaigns.name as campaign_name,
160 email_marketing.name as message_name,
162 WHEN 'Contacts' THEN CONCAT(CONCAT(contacts.first_name, ' ' ), contacts.last_name)
163 WHEN 'Leads' THEN CONCAT(CONCAT(leads.first_name, ' ' ), leads.last_name)
164 WHEN 'Accounts' THEN accounts.name
165 WHEN 'Users' THEN CONCAT(CONCAT(users.first_name, ' ' ), users.last_name)
166 WHEN 'Prospects' THEN CONCAT(CONCAT(prospects.first_name, ' ' ), prospects.last_name)
167 END) recipient_name";
169 if($this->db->dbType == 'mssql')
171 $query = "SELECT $this->table_name.* ,
172 campaigns.name as campaign_name,
173 email_marketing.name as message_name,
175 WHEN 'Contacts' THEN contacts.first_name + ' ' + contacts.last_name
176 WHEN 'Leads' THEN leads.first_name + ' ' + leads.last_name
177 WHEN 'Accounts' THEN accounts.name
178 WHEN 'Users' THEN users.first_name + ' ' + users.last_name
179 WHEN 'Prospects' THEN prospects.first_name + ' ' + prospects.last_name
180 END) recipient_name";
183 $query .= " FROM $this->table_name
184 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
185 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
186 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
187 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
188 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
189 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
190 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.deleted=0
191 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
192 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
195 if( isset($params['group_by']) )
197 $group_by = str_replace("emailman", "em", $params['group_by']);
198 $query .= "INNER JOIN (select min(id) as id from emailman em GROUP BY $group_by ) secondary
199 on {$this->table_name}.id = secondary.id ";
202 $where_auto = " $this->table_name.deleted=0";
205 $query .= "WHERE $where AND ".$where_auto;
207 $query .= "WHERE ".$where_auto;
212 $query .= ' ORDER BY ' . $this->process_order_by($order_by, null);
219 function create_list_query($order_by, $where, $show_deleted = 0){
221 if ( ( $this->db->dbType == 'mysql' ) or ( $this->db->dbType == 'oci8' ) )
224 $query = "SELECT $this->table_name.* ,
225 campaigns.name as campaign_name,
226 email_marketing.name as message_name,
228 WHEN 'Contacts' THEN CONCAT(CONCAT(contacts.first_name, ' ' ), contacts.last_name)
229 WHEN 'Leads' THEN CONCAT(CONCAT(leads.first_name, ' ' ), leads.last_name)
230 WHEN 'Accounts' THEN accounts.name
231 WHEN 'Users' THEN CONCAT(CONCAT(users.first_name, ' ' ), users.last_name)
232 WHEN 'Prospects' THEN CONCAT(CONCAT(prospects.first_name, ' ' ), prospects.last_name)
233 END) recipient_name";
235 if($this->db->dbType == 'mssql')
237 $query = "SELECT $this->table_name.* ,
238 campaigns.name as campaign_name,
239 email_marketing.name as message_name,
241 WHEN 'Contacts' THEN contacts.first_name + ' ' + contacts.last_name
242 WHEN 'Leads' THEN leads.first_name + ' ' + leads.last_name
243 WHEN 'Accounts' THEN accounts.name
244 WHEN 'Users' THEN users.first_name + ' ' + users.last_name
245 WHEN 'Prospects' THEN prospects.first_name + ' ' + prospects.last_name
246 END) recipient_name";
249 $query .= " FROM $this->table_name
250 LEFT JOIN users ON users.id = $this->table_name.related_id and $this->table_name.related_type ='Users'
251 LEFT JOIN contacts ON contacts.id = $this->table_name.related_id and $this->table_name.related_type ='Contacts'
252 LEFT JOIN leads ON leads.id = $this->table_name.related_id and $this->table_name.related_type ='Leads'
253 LEFT JOIN accounts ON accounts.id = $this->table_name.related_id and $this->table_name.related_type ='Accounts'
254 LEFT JOIN prospects ON prospects.id = $this->table_name.related_id and $this->table_name.related_type ='Prospects'
255 LEFT JOIN prospect_lists ON prospect_lists.id = $this->table_name.list_id
256 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.deleted=0
257 LEFT JOIN campaigns ON campaigns.id = $this->table_name.campaign_id
258 LEFT JOIN email_marketing ON email_marketing.id = $this->table_name.marketing_id ";
260 $where_auto = " $this->table_name.deleted=0";
263 $query .= "where $where AND ".$where_auto;
265 $query .= "where ".$where_auto;
269 $query .= ' ORDER BY ' . $this->process_order_by($order_by, null);
274 function get_list_view_data()
276 global $locale, $current_user;
277 $temp_array = parent::get_list_view_array();
279 $related_type = $temp_array['RELATED_TYPE'];
280 $related_id = $temp_array['RELATED_ID'];
281 $is_person = SugarModule::get($related_type)->moduleImplements('Person');
285 $query = "SELECT first_name, last_name FROM ". strtolower($related_type) ." WHERE id ='". $related_id ."'";
287 $query = "SELECT name FROM ". strtolower($related_type) ." WHERE id ='". $related_id ."'";
290 $result=$this->db->query($query);
291 $row=$this->db->fetchByAssoc($result);
295 $temp_array['RECIPIENT_NAME'] = $is_person ? $locale->getLocaleFormattedName($row['first_name'], $row['last_name'], '') : $row['name'];
298 //also store the recipient_email address
299 $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'";
301 $result=$this->db->query($query);
302 $row=$this->db->fetchByAssoc($result);
305 $temp_array['RECIPIENT_EMAIL']=$row['email_address'];
308 $this->email1 = $temp_array['RECIPIENT_EMAIL'];
309 $temp_array['EMAIL1_LINK'] = $current_user->getEmailLink('email1', $this, '', '', 'ListView');
315 function set_as_sent($email_address, $delete= true,$email_id=null, $email_type=null,$activity_type=null){
319 $this->send_attempts++;
320 if($delete || $this->send_attempts > 5){
322 //create new campaign log record.
324 $campaign_log = new CampaignLog();
325 $campaign_log->campaign_id=$this->campaign_id;
326 $campaign_log->target_tracker_key=$this->target_tracker_key;
327 $campaign_log->target_id= $this->related_id;
328 $campaign_log->target_type=$this->related_type;
329 $campaign_log->marketing_id=$this->marketing_id;
330 //if test suppress duplicate email address checking.
332 $campaign_log->more_information=$email_address;
334 $campaign_log->activity_type=$activity_type;
335 $campaign_log->activity_date=$timedate->now();
336 $campaign_log->list_id=$this->list_id;
337 $campaign_log->related_id= $email_id;
338 $campaign_log->related_type=$email_type;
339 $campaign_log->save();
341 $query = "DELETE FROM emailman WHERE id = $this->id";
342 $this->db->query($query);
344 //try to send the email again a day later.
345 $query = 'UPDATE ' . $this->table_name . " SET in_queue='1', send_attempts='$this->send_attempts', in_queue_date='". TimeDate::getInstance()->nowDb() ."' WHERE id = '$this->id'";
346 $this->db->query($query);
351 * Function finds the reference email for the campaign. Since a campaign can have multiple email templates
352 * the reference email has same id as the marketing id.
353 * this function will create an email if one does not exist. also the function will load these relationships leads, accounts, contacts
356 * @param varchar marketing_id message id
357 * @param string $subject email subject
358 * @param string $body_text Email Body Text
359 * @param string $body_html Email Body HTML
360 * @param string $campaign_name Campaign Name
361 * @param string from_address Email address of the sender, usually email address of the configured inbox.
362 * @param string sender_id If of the user sending the campaign.
363 * @param array macro_nv array of name value pair, one row for each replacable macro in email template text.
366 function create_ref_email($marketing_id,$subject,$body_text,$body_html,$campagin_name,$from_address,$sender_id,$notes,$macro_nv,$newmessage) {
368 global $mod_Strings, $timedate;
369 $upd_ref_email=false;
370 if ($newmessage or empty($this->ref_email->id)) {
371 $this->ref_email = new Email();
372 $this->ref_email->retrieve($marketing_id, true, false);
374 //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
375 //switches back to test mode.
376 //this is to account for changes to email template.
377 $upd_ref_email=(!empty($this->ref_email->id) and $this->ref_email->parent_type=='test' and $this->ref_email->parent_id=='test');
378 //following condition is for switching back to test mode.
379 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));
380 if (empty($this->ref_email->id) or $upd_ref_email) {
381 //create email record.
382 $this->ref_email->id=$marketing_id;
383 $this->ref_email->date_sent = '';
385 if ($upd_ref_email==false) {
386 $this->ref_email->new_with_id=true;
389 $this->ref_email->to_addrs= '';
390 $this->ref_email->to_addrs_ids = '';
391 $this->ref_email->to_addrs_names = '';
392 $this->ref_email->to_addrs_emails ='';
393 $this->ref_email->type= 'campaign';
394 $this->ref_email->deleted = '0';
395 $this->ref_email->name = $campagin_name.': '.$subject ;
396 $this->ref_email->description_html = $body_html;
397 $this->ref_email->description = $body_text;
398 $this->ref_email->from_addr = $from_address;
399 $this->ref_email->assigned_user_id = $sender_id;
401 $this->ref_email->parent_type = 'test';
402 $this->ref_email->parent_id = 'test';
404 $this->ref_email->parent_type = '';
405 $this->ref_email->parent_id = '';
407 $this->ref_email->date_start = $timedate->nowDate();
408 $this->ref_email->time_start = $timedate->asUserTime($timedate->getNow(true));
410 $this->ref_email->status='sent';
411 $retId = $this->ref_email->save();
413 if (count($notes) > 0 ) {
414 if (!class_exists('Note'))
415 if (!class_exists('UploadFile')) require_once('include/upload_file.php');
419 foreach($notes as $note) {
420 if($note->object_name == 'Note') {
421 if (! empty($note->file->temp_file_location) && is_file($note->file->temp_file_location)) {
422 $file_location = $note->file->temp_file_location;
423 $filename = $note->file->original_file_name;
424 $mime_type = $note->file->mime_type;
426 $file_location = rawurldecode(UploadFile::get_file_path($note->filename,$note->id));
427 $filename = $note->id.$note->filename;
428 $mime_type = $note->file_mime_type;
430 } elseif($note->object_name == 'DocumentRevision') { // from Documents
431 $filename = $note->id.$note->filename;
432 $file_location = getcwd().'/'.$GLOBALS['sugar_config']['upload_dir'].$filename;
433 $mime_type = $note->file_mime_type;
436 $noteAudit = new Note();
437 $noteAudit->parent_id = $retId;
438 $noteAudit->parent_type = $this->ref_email->module_dir;
439 $noteAudit->description = "[".$note->filename."] ".$mod_strings['LBL_ATTACHMENT_AUDIT'];
440 $noteAudit->filename=$filename;
441 $noteAudit->file_mime_type=$mime_type;
442 $noteAudit_id=$noteAudit->save();
444 UploadFile::duplicate_file($note->id, $noteAudit_id, $filename);
448 //load relationships.
449 $this->ref_email->load_relationship('users');
450 $this->ref_email->load_relationship('prospects');
451 $this->ref_email->load_relationship('contacts');
452 $this->ref_email->load_relationship('leads');
453 $this->ref_email->load_relationship('accounts');
456 if (!empty($this->related_id ) && !empty($this->related_type)) {
458 //save relationships.
459 switch ($this->related_type) {
465 $rel_name="prospects";
469 $rel_name="contacts";
477 $rel_name="accounts";
481 //required for one email per campaign per marketing message.
482 $this->ref_email->$rel_name->add($this->related_id,array('campaign_data'=>serialize($macro_nv)));
484 return $this->ref_email->id;
488 * The function creates a copy of email send to each target.
490 function create_indiv_email($module,$mail) {
492 global $locale, $timedate;
493 $email = new Email();
494 $email->to_addrs= $module->name . '<'.$module->email1.'>';
495 $email->to_addrs_ids = $module->id .';';
496 $email->to_addrs_names = $module->name . ';';
497 $email->to_addrs_emails = $module->email1 . ';';
498 $email->type= 'archived';
499 $email->deleted = '0';
500 $email->name = $this->current_campaign->name.': '.$mail->Subject ;
501 if ($mail->ContentType == "text/plain") {
502 $email->description = $mail->Body;
503 $email->description_html =null;
505 $email->description_html = $mail->Body;
506 $email->description = $mail->AltBody;
508 $email->from_addr = $mail->From;
509 $email->assigned_user_id = $this->user_id;
510 $email->parent_type = $this->related_type;
511 $email->parent_id = $this->related_id ;
513 $email->date_start = $timedate->nowDbDate();
514 $email->time_start = $timedate->asDbTime($timedate->getNow());
515 $email->status='sent';
516 $retId = $email->save();
518 foreach($this->notes_array as $note) {
519 if(!class_exists('Note')) {
522 // create "audit" email without duping off the file to save on disk space
523 $noteAudit = new Note();
524 $noteAudit->parent_id = $retId;
525 $noteAudit->parent_type = $email->module_dir;
526 $noteAudit->description = "[".$note->filename."] ".$mod_strings['LBL_ATTACHMENT_AUDIT'];
530 if (!empty($this->related_id ) && !empty($this->related_type)) {
532 //save relationships.
533 switch ($this->related_type) {
539 $rel_name="prospects";
543 $rel_name="contacts";
551 $rel_name="accounts";
555 if (!empty($rel_name)) {
556 $email->load_relationship($rel_name);
557 $email->$rel_name->add($this->related_id);
563 * Call this function to verify the email_marketing message and email_template configured
564 * for the campaign. If issues are found a fatal error will be logged but processing will not stop.
565 * @return Boolean Returns true if all campaign parameters are set correctly
567 function verify_campaign($marketing_id) {
569 if (!isset($this->verified_email_marketing_ids[$marketing_id])) {
570 if (!class_exists('EmailMarketing')) {
573 $email_marketing = new EmailMarketing();
574 $ret=$email_marketing->retrieve($marketing_id);
576 $GLOBALS['log']->fatal('Error retrieving marketing message for the email campaign. marketing_id = ' .$marketing_id);
580 //verify the email template.
581 if (empty($email_marketing->template_id)) {
582 $GLOBALS['log']->fatal('Error retrieving template for the email campaign. marketing_id = ' .$marketing_id);
586 if (!class_exists('EmailTemplate')) {
589 $emailtemplate= new EmailTemplate();
591 $ret=$emailtemplate->retrieve($email_marketing->template_id);
593 $GLOBALS['log']->fatal('Error retrieving template for the email campaign. template_id = ' .$email_marketing->template_id);
597 if (empty($emailtemplate->subject) and empty($emailtemplate->body) and empty($emailtemplate->body_html)) {
598 $GLOBALS['log']->fatal('Email template is empty. email_template_id=' .$email_marketing->template_id);
603 $this->verified_email_marketing_ids[$marketing_id]=1;
607 function sendEmail($mail,$save_emails=1,$testmode=false){
608 $this->test=$testmode;
610 global $beanList, $beanFiles, $sugar_config;
613 $OBCharset = $locale->getPrecedentPreference('default_email_charset');
614 $mod_strings = return_module_language( $sugar_config['default_language'], 'EmailMan');
616 //get tracking entities locations.
617 if (!isset($this->tracking_url)) {
618 if (!class_exists('Administration')) {
621 $admin=new Administration();
622 $admin->retrieveSettings('massemailer'); //retrieve all admin settings.
623 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']) ) {
624 $this->tracking_url=$admin->settings['massemailer_tracking_entities_location'];
626 $this->tracking_url=$sugar_config['site_url'];
630 //make sure tracking url ends with '/' character
631 $strLen = strlen($this->tracking_url);
632 if($this->tracking_url{$strLen-1} !='/'){
633 $this->tracking_url .='/';
636 if(!isset($beanList[$this->related_type])){
639 $class = $beanList[$this->related_type];
640 if (!class_exists($class)) {
641 require_once($beanFiles[$class]);
644 if (!class_exists('Email')) {
648 $module = new $class();
649 $module->retrieve($this->related_id);
650 $module->emailAddress->handleLegacyRetrieve($module);
652 //check to see if bean has a primary email address
653 if (!$this->is_primary_email_address($module)) {
654 //no primary email address designated, do not send out email, create campaign log
655 //of type send error to denote that this user was not emailed
656 $this->set_as_sent($module->email1, true,null,null,'send error');
657 //create fatal logging for easy review of cause.
658 $GLOBALS['log']->fatal('Email Address provided is not Primary Address for email with id ' . $module->email1 . "' Emailman id=$this->id");
662 if (!$this->valid_email_address($module->email1)) {
663 $this->set_as_sent($module->email1, true,null,null,'invalid email');
664 $GLOBALS['log']->fatal('Encountered invalid email address' . $module->email1 . " Emailman id=$this->id");
668 if ((!isset($module->email_opt_out)
669 || ($module->email_opt_out !== 'on'
670 && $module->email_opt_out !== 1
671 && $module->email_opt_out !== '1'))
672 && (!isset($module->invalid_email)
673 || ($module->invalid_email !== 'on'
674 && $module->invalid_email !== 1
675 && $module->invalid_email !== '1'))){
676 $lower_email_address=strtolower($module->email1);
677 //test against indivdual address.
678 if (isset($this->restricted_addresses) and isset($this->restricted_addresses[$lower_email_address])) {
679 $this->set_as_sent($lower_email_address, true,null,null,'blocked');
682 //test against restricted domains
683 $at_pos=strrpos($lower_email_address,'@');
684 if ($at_pos !== false) {
685 foreach ($this->restricted_domains as $domain=>$value) {
686 $pos=strrpos($lower_email_address,$domain);
687 if ($pos !== false && $pos > $at_pos) {
689 $this->set_as_sent($lower_email_address, true,null,null,'blocked');
695 //test for duplicate email address by marketing id.
696 $dup_query="select id from campaign_log where more_information='".$module->email1."' and marketing_id='".$this->marketing_id."'";
697 $dup=$this->db->query($dup_query);
698 $dup_row=$this->db->fetchByAssoc($dup);
699 if (!empty($dup_row)) {
700 //we have seen this email address before
701 $this->set_as_sent($module->email1,true,null,null,'blocked');
705 $this->target_tracker_key=create_guid();
707 //fetch email marketing.
708 if (empty($this->current_emailmarketing) or !isset($this->current_emailmarketing)) {
709 if (!class_exists('EmailMarketing')) {
713 $this->current_emailmarketing=new EmailMarketing();
716 if (empty($this->current_emailmarketing->id) or $this->current_emailmarketing->id !== $this->marketing_id) {
717 $this->current_emailmarketing->retrieve($this->marketing_id);
719 $this->newmessage = true;
721 //fetch email template associate with the marketing message.
722 if (empty($this->current_emailtemplate) or $this->current_emailtemplate->id !== $this->current_emailmarketing->template_id) {
723 if (!class_exists('EmailTemplate')) {
726 $this->current_emailtemplate= new EmailTemplate();
728 $this->current_emailtemplate->retrieve($this->current_emailmarketing->template_id);
730 //escape email template contents.
731 $this->current_emailtemplate->subject=from_html($this->current_emailtemplate->subject);
732 $this->current_emailtemplate->body_html=from_html($this->current_emailtemplate->body_html);
733 $this->current_emailtemplate->body=from_html($this->current_emailtemplate->body);
735 $q = "SELECT * FROM notes WHERE parent_id = '".$this->current_emailtemplate->id."' AND deleted = 0";
736 $r = $this->db->query($q);
738 // cn: bug 4684 - initialize the notes array, else old data is still around for the next round
739 $this->notes_array = array();
740 if (!class_exists('Note')){
741 require_once('modules/Notes/Note.php');
743 while($a = $this->db->fetchByAssoc($r)) {
744 $noteTemplate = new Note();
745 $noteTemplate->retrieve($a['id']);
746 $this->notes_array[] = $noteTemplate;
750 // fetch mailbox details..
751 if(empty($this->current_mailbox)) {
752 if (!class_exists('InboundEmail')) {
755 $this->current_mailbox= new InboundEmail();
757 if (empty($this->current_mailbox->id) or $this->current_mailbox->id !== $this->current_emailmarketing->inbound_email_id) {
758 $this->current_mailbox->retrieve($this->current_emailmarketing->inbound_email_id);
759 //extract the email address.
760 $this->mailbox_from_addr=$this->current_mailbox->get_stored_options('from_addr','nobody@example.com',null);
763 // fetch campaign details..
764 if (empty($this->current_campaign)) {
765 if (!class_exists('Campaign')) {
768 $this->current_campaign= new Campaign();
770 if (empty($this->current_campaign->id) or $this->current_campaign->id !== $this->current_emailmarketing->campaign_id) {
771 $this->current_campaign->retrieve($this->current_emailmarketing->campaign_id);
773 //load defined tracked_urls
774 $this->current_campaign->load_relationship('tracked_urls');
775 $query_array=$this->current_campaign->tracked_urls->getQuery(true);
776 $query_array['select']="SELECT tracker_name, tracker_key, id, is_optout ";
777 $result=$this->current_campaign->db->query(implode(' ',$query_array));
779 $this->has_optout_links=false;
780 $this->tracker_urls=array();
781 while (($row=$this->current_campaign->db->fetchByAssoc($result)) != null) {
782 $this->tracker_urls['{'.$row['tracker_name'].'}']=$row;
783 //has the user defined opt-out links for the campaign.
784 if ($row['is_optout']==1) {
785 $this->has_optout_links=true;
790 $mail->ClearAllRecipients();
791 $mail->ClearReplyTos();
792 $mail->Sender = $this->mailbox_from_addr;
793 $mail->From = $this->mailbox_from_addr;
794 $mail->FromName = $this->current_emailmarketing->from_name;
795 $mail->ClearCustomHeaders();
796 $mail->AddCustomHeader('X-CampTrackID:'.$this->target_tracker_key);
797 //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
798 $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;
799 $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;
801 $mail->AddReplyTo($replyToAddr,$locale->translateCharsetMIME(trim($replyToName), 'UTF-8', $OBCharset));
803 //parse and replace bean variables.
805 $template_data= $this->current_emailtemplate->parse_email_template(array('subject'=>$this->current_emailtemplate->subject,
806 'body_html'=>$this->current_emailtemplate->body_html,
807 'body'=>$this->current_emailtemplate->body,
812 //add email address to this list.
813 $macro_nv['sugar_to_email_address']=$module->email1;
814 $macro_nv['email_template_id']=$this->current_emailmarketing->template_id;
816 //parse and replace urls.
817 //this is new style of adding tracked urls to a campaign.
818 $tracker_url_template= $this->tracking_url . 'index.php?entryPoint=campaign_trackerv2&track=%s'.'&identifier='.$this->target_tracker_key;
819 $removeme_url_template=$this->tracking_url . 'index.php?entryPoint=removeme&identifier='.$this->target_tracker_key;
820 $template_data= $this->current_emailtemplate->parse_tracker_urls($template_data,$tracker_url_template,$this->tracker_urls,$removeme_url_template);
821 $mail->AddAddress($module->email1,$locale->translateCharsetMIME(trim($module->name), 'UTF-8', $OBCharset) );
823 //refetch strings in case they have been changed by creation of email templates or other beans.
824 $mod_strings = return_module_language( $sugar_config['default_language'], 'EmailMan');
827 $mail->Subject = $mod_strings['LBL_PREPEND_TEST'] . $template_data['subject'];
829 $mail->Subject = $template_data['subject'];
832 //check if this template is meant to be used as "text only"
834 if(isset($this->current_emailtemplate->text_only) && $this->current_emailtemplate->text_only){$text_only =true;}
835 //if this template is textonly, then just send text body. Do not add tracker, opt out,
836 //or perform other processing as it will not show up in text only email
838 $this->description_html = '';
839 $mail->IsHTML(false);
840 $mail->Body = $template_data['body'];
843 $mail->Body = wordwrap($template_data['body_html'], 900);
844 //BEGIN:this code will trigger for only campaigns pending before upgrade to 4.2.0.
845 //will be removed for the next release.
846 if(!isset($btracker)) $btracker=false;
848 $mail->Body .= "<br><br><a href='". $tracker_url ."'>" . $tracker_text . "</a><br><br>";
850 if (!empty($tracker_url)) {
851 $mail->Body = str_replace('TRACKER_URL_START', "<a href='" . $tracker_url ."'>", $mail->Body);
852 $mail->Body = str_replace('TRACKER_URL_END', "</a>", $mail->Body);
853 $mail->AltBody = str_replace('TRACKER_URL_START', "<a href='" . $tracker_url ."'>", $mail->AltBody);
854 $mail->AltBody = str_replace('TRACKER_URL_END', "</a>", $mail->AltBody);
859 //do not add the default remove me link if the campaign has a trackerurl of the opotout link
860 if ($this->has_optout_links==false) {
861 $mail->Body .= "<br><font size='2'>{$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></font>";
863 // cn: bug 11979 - adding single quote to comform with HTML email RFC
864 $mail->Body .= "<br><IMG HEIGHT='1' WIDTH='1' src='{$this->tracking_url}index.php?entryPoint=image&identifier={$this->target_tracker_key}'>";
866 $mail->AltBody = $template_data['body'];
868 $mail->AltBody .="\n". $tracker_url;
870 if ($this->has_optout_links==false) {
871 $mail->AltBody .="\n\n\n{$mod_strings['TXT_REMOVE_ME_ALT']} ". $this->tracking_url . "index.php?entryPoint=removeme&identifier=$this->target_tracker_key";
876 // cn: bug 4684, handle attachments in email templates.
877 $mail->handleAttachments($this->notes_array);
878 $tmp_Subject = $mail->Subject;
879 $mail->prepForOutbound();
881 $success = $mail->Send();
882 //Do not save the encoded subject.
883 $mail->Subject = $tmp_Subject;
886 if ($save_emails==1) {
887 $email_id=$this->create_indiv_email($module,$mail);
889 //find/create reference email record. all campaign targets reveiving this message will be linked with this message.
890 $email_id=$this->create_ref_email($this->marketing_id,
891 $this->current_emailtemplate->subject,
892 $this->current_emailtemplate->body,
893 $this->current_emailtemplate->body_html,
894 $this->current_campaign->name,
895 $this->mailbox_from_addr,
901 $this->newmessage = false;
906 $this->set_as_sent($module->email1, true, $email_id, 'Emails', 'targeted');
909 if(!empty($layout_def['parent_id'])) {
910 if (isset($layout_def['fields'][strtoupper($layout_def['parent_id'])])) {
911 $parent.="&parent_id=".$layout_def['fields'][strtoupper($layout_def['parent_id'])];
914 if(!empty($layout_def['parent_module'])) {
915 if (isset($layout_def['fields'][strtoupper($layout_def['parent_module'])])) {
916 $parent.="&parent_module=".$layout_def['fields'][strtoupper($layout_def['parent_module'])];
919 //log send error. save for next attempt after 24hrs. no campaign log entry will be created.
920 $this->set_as_sent($module->email1,false,null,null,'send error');
924 $this->target_tracker_key=create_guid();
926 if (isset($module->email_opt_out) && ($module->email_opt_out === 'on' || $module->email_opt_out == '1' || $module->email_opt_out == 1)) {
927 $this->set_as_sent($module->email1,true,null,null,'removed');
929 if (isset($module->invalid_email) && ($module->invalid_email == 1 || $module->invalid_email == '1')) {
930 $this->set_as_sent($module->email1,true,null,null,'invalid email');
932 $this->set_as_sent($module->email1,true, null,null,'send error');
941 * Validates the passed email address.
942 * Limitations of this algorithm: does not validate email addressess that end with .meuseum
945 function valid_email_address($email_address) {
947 $email_address=trim($email_address);
948 if (empty($email_address)) {
952 $pattern='/[A-Z0-9\._%-]+@[A-Z0-9\.-]+\.[A-Za-z]{2,}$/i';
953 $ret=preg_match($pattern, $email_address);
955 if ($ret===false or $ret==0) {
962 * This function takes in the given bean and searches for a related email address
963 * that has been designated as primary. If one is found, true is returned
964 * If no primary email address is found, then false is returned
967 function is_primary_email_address($bean){
968 $email_address=trim($bean->email1);
970 if (empty($email_address)) {
973 //query for this email address rel and see if this is primary address
974 $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";
975 $res = $bean->db->query($primary_qry);
976 $prim_row=$this->db->fetchByAssoc($res);
977 //return true if this is primary
978 if (!empty($prim_row)) {
985 function create_export_query(&$order_by, &$where) {
986 $custom_join = $this->custom_fields->getJOIN(true, true,$where);
987 $query = "SELECT emailman.*";
989 $query .= $custom_join['select'];
992 $query .= " FROM emailman ";
995 $query .= $custom_join['join'];
998 $where_auto = "( emailman.deleted IS NULL OR emailman.deleted=0 )";
1001 $query .= "where ($where) AND ".$where_auto;
1003 $query .= "where ".$where_auto;
1005 if(!empty($order_by))
1007 $query .= ' ORDER BY '. $this->process_order_by($order_by, null);