3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 require_once 'Mail/mime.php';
36 class CRM_Mailing_BAO_Mailing
extends CRM_Mailing_DAO_Mailing
{
39 * An array that holds the complete templates
40 * including any headers or footers that need to be prepended
41 * or appended to the body
43 private $preparedTemplates = NULL;
46 * An array that holds the complete templates
47 * including any headers or footers that need to be prepended
48 * or appended to the body
50 private $templates = NULL;
53 * An array that holds the tokens that are specifically found in our text and html bodies
55 private $tokens = NULL;
58 * An array that holds the tokens that are specifically found in our text and html bodies
60 private $flattenedTokens = NULL;
63 * The header associated with this mailing
65 private $header = NULL;
68 * The footer associated with this mailing
70 private $footer = NULL;
73 * The HTML content of the message
78 * The text content of the message
83 * Cached BAO for the domain
85 private $_domain = NULL;
90 function __construct() {
91 parent
::__construct();
94 static function &getRecipientsCount($job_id, $mailing_id = NULL, $mode = NULL) {
95 // need this for backward compatibility, so we can get count for old mailings
96 // please do not use this function if possible
97 $eq = self
::getRecipients($job_id, $mailing_id);
101 // note that $job_id is used only as a variable in the temp table construction
102 // and does not play a role in the queries generated
103 static function &getRecipients(
108 $storeRecipients = FALSE,
109 $dedupeEmail = FALSE,
111 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
113 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
114 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
115 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
116 $eq = CRM_Mailing_Event_DAO_Queue
::getTableName();
117 $ed = CRM_Mailing_Event_DAO_Delivered
::getTableName();
118 $eb = CRM_Mailing_Event_DAO_Bounce
::getTableName();
120 $email = CRM_Core_DAO_Email
::getTableName();
121 if ($mode == 'sms') {
122 $phone = CRM_Core_DAO_Phone
::getTableName();
124 $contact = CRM_Contact_DAO_Contact
::getTableName();
126 $group = CRM_Contact_DAO_Group
::getTableName();
127 $g2contact = CRM_Contact_DAO_GroupContact
::getTableName();
129 /* Create a temp table for contact exclusion */
130 $mailingGroup->query(
131 "CREATE TEMPORARY TABLE X_$job_id
132 (contact_id int primary key)
136 /* Add all the members of groups excluded from this mailing to the temp
139 $excludeSubGroup = "INSERT INTO X_$job_id (contact_id)
140 SELECT DISTINCT $g2contact.contact_id
143 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
145 $mg.mailing_id = {$mailing_id}
146 AND $g2contact.status = 'Added'
147 AND $mg.group_type = 'Exclude'";
148 $mailingGroup->query($excludeSubGroup);
150 /* Add all unsubscribe members of base group from this mailing to the temp
153 $unSubscribeBaseGroup = "INSERT INTO X_$job_id (contact_id)
154 SELECT DISTINCT $g2contact.contact_id
157 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
159 $mg.mailing_id = {$mailing_id}
160 AND $g2contact.status = 'Removed'
161 AND $mg.group_type = 'Base'";
162 $mailingGroup->query($unSubscribeBaseGroup);
164 /* Add all the (intended) recipients of an excluded prior mailing to
167 $excludeSubMailing = "INSERT IGNORE INTO X_$job_id (contact_id)
168 SELECT DISTINCT $eq.contact_id
171 ON $eq.job_id = $job.id
173 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
175 $mg.mailing_id = {$mailing_id}
176 AND $mg.group_type = 'Exclude'";
177 $mailingGroup->query($excludeSubMailing);
179 // get all the saved searches AND hierarchical groups
180 // and load them in the cache
182 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
184 INNER JOIN $mg ON $mg.entity_id = $group.id
185 WHERE $mg.entity_table = '$group'
186 AND $mg.group_type = 'Exclude'
187 AND $mg.mailing_id = {$mailing_id}
188 AND ( saved_search_id != 0
189 OR saved_search_id IS NOT NULL
190 OR children IS NOT NULL )
193 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
194 while ($groupDAO->fetch()) {
195 if ($groupDAO->cache_date
== NULL) {
196 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
199 $smartGroupExclude = "
200 INSERT IGNORE INTO X_$job_id (contact_id)
202 FROM civicrm_group_contact_cache c
203 WHERE c.group_id = {$groupDAO->id}
205 $mailingGroup->query($smartGroupExclude);
208 $tempColumn = 'email_id';
209 if ($mode == 'sms') {
210 $tempColumn = 'phone_id';
213 /* Get all the group contacts we want to include */
215 $mailingGroup->query(
216 "CREATE TEMPORARY TABLE I_$job_id
217 ($tempColumn int, contact_id int primary key)
221 /* Get the group contacts, but only those which are not in the
222 * exclusion temp table */
224 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
226 SELECT DISTINCT $email.id as email_id,
227 $contact.id as contact_id
230 ON $email.contact_id = $contact.id
231 INNER JOIN $g2contact
232 ON $contact.id = $g2contact.contact_id
234 ON $g2contact.group_id = $mg.entity_id
235 AND $mg.entity_table = '$group'
237 ON $contact.id = X_$job_id.contact_id
239 ($mg.group_type = 'Include')
240 AND $mg.search_id IS NULL
241 AND $g2contact.status = 'Added'
242 AND $contact.do_not_email = 0
243 AND $contact.is_opt_out = 0
244 AND $contact.is_deceased = 0
245 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
246 AND $email.email IS NOT NULL
247 AND $email.email != ''
248 AND $email.on_hold = 0
249 AND $mg.mailing_id = {$mailing_id}
250 AND X_$job_id.contact_id IS null
251 ORDER BY $email.is_bulkmail";
253 if ($mode == 'sms') {
254 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
255 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
257 SELECT DISTINCT $phone.id as phone_id,
258 $contact.id as contact_id
261 ON $phone.contact_id = $contact.id
262 INNER JOIN $g2contact
263 ON $contact.id = $g2contact.contact_id
265 ON $g2contact.group_id = $mg.entity_id
266 AND $mg.entity_table = '$group'
268 ON $contact.id = X_$job_id.contact_id
270 ($mg.group_type = 'Include')
271 AND $mg.search_id IS NULL
272 AND $g2contact.status = 'Added'
273 AND $contact.do_not_sms = 0
274 AND $contact.is_opt_out = 0
275 AND $contact.is_deceased = 0
276 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
277 AND $phone.phone IS NOT NULL
278 AND $phone.phone != ''
279 AND $mg.mailing_id = {$mailing_id}
280 AND X_$job_id.contact_id IS null";
282 $mailingGroup->query($query);
284 /* Query prior mailings */
286 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
287 SELECT DISTINCT $email.id as email_id,
288 $contact.id as contact_id
291 ON $email.contact_id = $contact.id
293 ON $eq.contact_id = $contact.id
295 ON $eq.job_id = $job.id
297 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
299 ON $contact.id = X_$job_id.contact_id
301 ($mg.group_type = 'Include')
302 AND $contact.do_not_email = 0
303 AND $contact.is_opt_out = 0
304 AND $contact.is_deceased = 0
305 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
306 AND $email.on_hold = 0
307 AND $mg.mailing_id = {$mailing_id}
308 AND X_$job_id.contact_id IS null
309 ORDER BY $email.is_bulkmail";
311 if ($mode == 'sms') {
312 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
313 SELECT DISTINCT $phone.id as phone_id,
314 $contact.id as contact_id
317 ON $phone.contact_id = $contact.id
319 ON $eq.contact_id = $contact.id
321 ON $eq.job_id = $job.id
323 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
325 ON $contact.id = X_$job_id.contact_id
327 ($mg.group_type = 'Include')
328 AND $contact.do_not_sms = 0
329 AND $contact.is_opt_out = 0
330 AND $contact.is_deceased = 0
331 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
332 AND $mg.mailing_id = {$mailing_id}
333 AND X_$job_id.contact_id IS null";
335 $mailingGroup->query($query);
338 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
340 INNER JOIN $mg ON $mg.entity_id = $group.id
341 WHERE $mg.entity_table = '$group'
342 AND $mg.group_type = 'Include'
343 AND $mg.search_id IS NULL
344 AND $mg.mailing_id = {$mailing_id}
345 AND ( saved_search_id != 0
346 OR saved_search_id IS NOT NULL
347 OR children IS NOT NULL )
350 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
351 while ($groupDAO->fetch()) {
352 if ($groupDAO->cache_date
== NULL) {
353 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
356 $smartGroupInclude = "
357 INSERT IGNORE INTO I_$job_id (email_id, contact_id)
358 SELECT e.id as email_id, c.id as contact_id
359 FROM civicrm_contact c
360 INNER JOIN civicrm_email e ON e.contact_id = c.id
361 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
362 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
363 WHERE gc.group_id = {$groupDAO->id}
364 AND c.do_not_email = 0
366 AND c.is_deceased = 0
367 AND (e.is_bulkmail = 1 OR e.is_primary = 1)
369 AND X_$job_id.contact_id IS null
370 ORDER BY e.is_bulkmail
372 if ($mode == 'sms') {
373 $smartGroupInclude = "
374 INSERT IGNORE INTO I_$job_id (phone_id, contact_id)
375 SELECT p.id as phone_id, c.id as contact_id
376 FROM civicrm_contact c
377 INNER JOIN civicrm_phone p ON p.contact_id = c.id
378 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
379 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
380 WHERE gc.group_id = {$groupDAO->id}
383 AND c.is_deceased = 0
384 AND p.phone_type_id = {$phoneTypes['Mobile']}
385 AND X_$job_id.contact_id IS null";
387 $mailingGroup->query($smartGroupInclude);
391 * Construct the filtered search queries
394 SELECT search_id, search_args, entity_id
396 WHERE $mg.search_id IS NOT NULL
397 AND $mg.mailing_id = {$mailing_id}
399 $dao = CRM_Core_DAO
::executeQuery($query);
400 while ($dao->fetch()) {
401 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
405 $query = "REPLACE INTO I_$job_id ({$tempColumn}, contact_id)
407 $mailingGroup->query($query);
410 /* Get the emails with only location override */
412 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
413 SELECT DISTINCT $email.id as local_email_id,
414 $contact.id as contact_id
417 ON $email.contact_id = $contact.id
418 INNER JOIN $g2contact
419 ON $contact.id = $g2contact.contact_id
421 ON $g2contact.group_id = $mg.entity_id
423 ON $contact.id = X_$job_id.contact_id
425 $mg.entity_table = '$group'
426 AND $mg.group_type = 'Include'
427 AND $g2contact.status = 'Added'
428 AND $contact.do_not_email = 0
429 AND $contact.is_opt_out = 0
430 AND $contact.is_deceased = 0
431 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
432 AND $email.on_hold = 0
433 AND $mg.mailing_id = {$mailing_id}
434 AND X_$job_id.contact_id IS null
435 ORDER BY $email.is_bulkmail";
436 if ($mode == "sms") {
437 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
438 SELECT DISTINCT $phone.id as phone_id,
439 $contact.id as contact_id
442 ON $phone.contact_id = $contact.id
443 INNER JOIN $g2contact
444 ON $contact.id = $g2contact.contact_id
446 ON $g2contact.group_id = $mg.entity_id
448 ON $contact.id = X_$job_id.contact_id
450 $mg.entity_table = '$group'
451 AND $mg.group_type = 'Include'
452 AND $g2contact.status = 'Added'
453 AND $contact.do_not_sms = 0
454 AND $contact.is_opt_out = 0
455 AND $contact.is_deceased = 0
456 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
457 AND $mg.mailing_id = {$mailing_id}
458 AND X_$job_id.contact_id IS null";
460 $mailingGroup->query($query);
464 $eq = new CRM_Mailing_Event_BAO_Queue();
466 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
467 $aclWhere = $aclWhere ?
"WHERE {$aclWhere}" : '';
469 if ($limit && $offset !== NULL) {
470 $offset = CRM_Utils_Type
::escape($offset, 'Int');
471 $limit = CRM_Utils_Type
::escape($limit, 'Int');
473 $limitString = "LIMIT $offset, $limit";
476 if ($storeRecipients && $mailing_id) {
479 FROM civicrm_mailing_recipients
480 WHERE mailing_id = %1
482 $params = array(1 => array($mailing_id, 'Integer'));
483 CRM_Core_DAO
::executeQuery($sql, $params);
486 $groupBy = $groupJoin = '';
488 $groupJoin = " INNER JOIN civicrm_email e ON e.id = i.email_id";
489 $groupBy = " GROUP BY e.email ";
493 INSERT INTO civicrm_mailing_recipients ( mailing_id, contact_id, {$tempColumn} )
494 SELECT %1, i.contact_id, i.{$tempColumn}
495 FROM civicrm_contact contact_a
496 INNER JOIN I_$job_id i ON contact_a.id = i.contact_id
501 ORDER BY i.contact_id, i.{$tempColumn}
504 CRM_Core_DAO
::executeQuery($sql, $params);
506 // if we need to add all emails marked bulk, do it as a post filter
507 // on the mailing recipients table
508 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
509 self
::addMultipleEmails($mailing_id);
513 /* Delete the temp table */
515 $mailingGroup->reset();
516 $mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
517 $mailingGroup->query("DROP TEMPORARY TABLE I_$job_id");
522 private function _getMailingGroupIds($type = 'Include') {
523 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
524 $group = CRM_Contact_DAO_Group
::getTableName();
525 if (!isset($this->id
)) {
526 // we're just testing tokens, so return any group
527 $query = "SELECT id AS entity_id
533 $query = "SELECT entity_id
535 WHERE mailing_id = {$this->id}
536 AND group_type = '$type'
537 AND entity_table = '$group'";
539 $mailingGroup->query($query);
542 while ($mailingGroup->fetch()) {
543 $groupIds[] = $mailingGroup->entity_id
;
551 * Returns the regex patterns that are used for preparing the text and html templates
556 private function &getPatterns($onlyHrefs = FALSE) {
560 $protos = '(https?|ftp)';
562 $gunk = '\{\}/#~:.?+=&;%@!\,\-';
564 $any = "{$letters}{$gunk}{$punc}";
566 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
569 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
572 $patterns[] = $pattern;
573 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
574 $patterns[] = '\{\w+\.\w+\}';
576 $patterns = '{' . join('|', $patterns) . '}im';
582 * returns an array that denotes the type of token that we are dealing with
583 * we use the type later on when we are doing a token replcement lookup
585 * @param string $token The token for which we will be doing adata lookup
587 * @return array $funcStruct An array that holds the token itself and the type.
588 * the type will tell us which function to use for the data lookup
589 * if we need to do a lookup at all
591 function &getDataFunc($token) {
592 static $_categories = NULL;
593 static $_categoryString = NULL;
595 $_categories = array(
602 CRM_Utils_Hook
::tokens($_categories);
603 $_categoryString = implode('|', array_keys($_categories));
606 $funcStruct = array('type' => NULL, 'token' => $token);
608 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
609 // it is a url so we need to check to see if there are any tokens embedded
610 // if so then call this function again to get the token dataFunc
611 // and assign the type 'embedded' so that the data retrieving function
612 // will know what how to handle this token.
613 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
614 $funcStruct['type'] = 'embedded_url';
615 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
616 foreach ($matches[1] as $match) {
617 $preg_token = '/' . preg_quote($match, '/') . '/';
618 $list = preg_split($preg_token, $token, 2);
619 $funcStruct['embed_parts'][] = $list[0];
621 $funcStruct['token'][] = $this->getDataFunc($match);
623 // fixed truncated url, CRM-7113
625 $funcStruct['embed_parts'][] = $token;
629 $funcStruct['type'] = 'url';
632 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
633 $funcStruct['type'] = $matches[1];
634 $funcStruct['token'] = $matches[2];
636 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
637 // we are an escaped token
638 // so remove the escape chars
639 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
640 $funcStruct['token'] = '{' . $unescaped_token . '}';
647 * Prepares the text and html templates
648 * for generating the emails and returns a copy of the
654 private function getPreparedTemplates() {
655 if (!$this->preparedTemplates
) {
656 $patterns['html'] = $this->getPatterns(TRUE);
657 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
658 $templates = $this->getTemplates();
660 $this->preparedTemplates
= array();
663 'html', 'text', 'subject') as $key) {
664 if (!isset($templates[$key])) {
670 $split_template = array();
672 $email = $templates[$key];
673 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
674 foreach ($matches[0] as $idx => $token) {
675 $preg_token = '/' . preg_quote($token, '/') . '/im';
676 list($split_template[], $email) = preg_split($preg_token, $email, 2);
677 array_push($tokens, $this->getDataFunc($token));
680 $split_template[] = $email;
682 $this->preparedTemplates
[$key]['template'] = $split_template;
683 $this->preparedTemplates
[$key]['tokens'] = $tokens;
686 return ($this->preparedTemplates
);
691 * Retrieve a ref to an array that holds the email and text templates for this email
692 * assembles the complete template including the header and footer
693 * that the user has uploaded or declared (if they have dome that)
696 * @return array reference to an assoc array
700 private function &getTemplates() {
701 if (!$this->templates
) {
702 $this->getHeaderFooter();
703 $this->templates
= array();
705 if ($this->body_text
) {
708 $template[] = $this->header
->body_text
;
711 $template[] = $this->body_text
;
714 $template[] = $this->footer
->body_text
;
717 $this->templates
['text'] = join("\n", $template);
720 if ($this->body_html
) {
724 $template[] = $this->header
->body_html
;
727 $template[] = $this->body_html
;
730 $template[] = $this->footer
->body_html
;
733 $this->templates
['html'] = join("\n", $template);
735 // this is where we create a text template from the html template if the text template did not exist
736 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
737 // user uploads an html email only
738 if (!$this->body_text
) {
739 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
743 if ($this->subject
) {
745 $template[] = $this->subject
;
746 $this->templates
['subject'] = join("\n", $template);
749 return $this->templates
;
754 * Retrieve a ref to an array that holds all of the tokens in the email body
755 * where the keys are the type of token and the values are ordinal arrays
756 * that hold the token names (even repeated tokens) in the order in which
757 * they appear in the body of the email.
759 * note: the real work is done in the _getTokens() function
761 * this function needs to have some sort of a body assigned
762 * either text or html for this to have any meaningful impact
764 * @return array reference to an assoc array
768 public function &getTokens() {
769 if (!$this->tokens
) {
771 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
773 if ($this->body_html
) {
774 $this->_getTokens('html');
775 if (!$this->body_text
) {
776 // Since the text template was created from html, use the html tokens.
777 // @see CRM_Mailing_BAO_Mailing::getTemplates()
778 $this->tokens
['text'] = $this->tokens
['html'];
782 if ($this->body_text
) {
783 $this->_getTokens('text');
786 if ($this->subject
) {
787 $this->_getTokens('subject');
791 return $this->tokens
;
795 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
796 * hook in one call and standardizes it across other token workflows
798 * @return array reference to an assoc array
802 public function &getFlattenedTokens() {
803 if (!$this->flattenedTokens
) {
804 $tokens = $this->getTokens();
806 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
809 return $this->flattenedTokens
;
814 * _getTokens parses out all of the tokens that have been
815 * included in the html and text bodies of the email
816 * we get the tokens and then separate them into an
817 * internal structure named tokens that has the same
818 * form as the static tokens property(?) of the CRM_Utils_Token class.
819 * The difference is that there might be repeated token names as we want the
820 * structures to represent the order in which tokens were found from left to right, top to bottom.
823 * @param str $prop name of the property that holds the text that we want to scan for tokens (html, text)
828 private function _getTokens($prop) {
829 $templates = $this->getTemplates();
831 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
833 foreach ($newTokens as $type => $names) {
834 if (!isset($this->tokens
[$prop][$type])) {
835 $this->tokens
[$prop][$type] = array();
837 foreach ($names as $key => $name) {
838 $this->tokens
[$prop][$type][] = $name;
844 * Generate an event queue for a test job
846 * @params array $params contains form values
853 public function getTestRecipients($testParams) {
854 if (array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
855 $contacts = civicrm_api('contact','get', array(
857 'group' => $testParams['test_group'],
859 'options' => array('limit' => 100000000000,
863 foreach (array_keys($contacts['values']) as $groupContact) {
865 SELECT civicrm_email.id AS email_id,
866 civicrm_email.is_primary as is_primary,
867 civicrm_email.is_bulkmail as is_bulkmail
869 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
870 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
871 AND civicrm_contact.id = {$groupContact}
872 AND civicrm_contact.do_not_email = 0
873 AND civicrm_contact.is_deceased = 0
874 AND civicrm_email.on_hold = 0
875 AND civicrm_contact.is_opt_out = 0
876 GROUP BY civicrm_email.id
877 ORDER BY civicrm_email.is_bulkmail DESC
879 $dao = CRM_Core_DAO
::executeQuery($query);
882 'job_id' => $testParams['job_id'],
883 'email_id' => $dao->email_id
,
884 'contact_id' => $groupContact,
886 $queue = CRM_Mailing_Event_BAO_Queue
::create($params);
893 * Retrieve the header and footer for this mailing
900 private function getHeaderFooter() {
901 if (!$this->header
and $this->header_id
) {
902 $this->header
= new CRM_Mailing_BAO_Component();
903 $this->header
->id
= $this->header_id
;
904 $this->header
->find(TRUE);
905 $this->header
->free();
908 if (!$this->footer
and $this->footer_id
) {
909 $this->footer
= new CRM_Mailing_BAO_Component();
910 $this->footer
->id
= $this->footer_id
;
911 $this->footer
->find(TRUE);
912 $this->footer
->free();
917 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
918 * add a Message-ID header if needed.
920 * i.e. if the global includeMessageId is set and there isn't already a
921 * Message-ID in the array.
922 * The message ID is structured the same way as a verp. However no interpretation
923 * is placed on the values received, so they do not need to follow the verp
926 * @param array $headers Array of message headers to update, in-out
927 * @param string $prefix Prefix for the message ID, use same prefixes as verp
929 * @param string $job_id Job ID component of the generated message ID
930 * @param string $event_queue_id Event Queue ID component of the generated message ID
931 * @param string $hash Hash component of the generated message ID.
935 static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
936 $config = CRM_Core_Config
::singleton();
937 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
938 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
939 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
941 if ($includeMessageId && (!array_key_exists('Message-ID', $headers))) {
942 $headers['Message-ID'] = '<' . implode($config->verpSeparator
,
944 $localpart . $prefix,
949 ) . "@{$emailDomain}>";
954 * static wrapper for getting verp and urls
956 * @param int $job_id ID of the Job associated with this message
957 * @param int $event_queue_id ID of the EventQueue
958 * @param string $hash Hash of the EventQueue
959 * @param string $email Destination address
961 * @return array (reference) array array ref that hold array refs to the verp info and urls
963 static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
964 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
965 $config = CRM_Core_Config
::singleton();
966 $bao = new CRM_Mailing_BAO_Mailing();
967 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
968 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
970 // use $bao's instance method to get verp and urls
971 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
972 return array($verp, $urls);
976 * get verp, urls and headers
978 * @param int $job_id ID of the Job associated with this message
979 * @param int $event_queue_id ID of the EventQueue
980 * @param string $hash Hash of the EventQueue
981 * @param string $email Destination address
983 * @param bool $isForward
985 * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers@access private
987 private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
988 $config = CRM_Core_Config
::singleton();
992 * reply: user replied to mailing
993 * bounce: email address bounced
994 * unsubscribe: contact opts out of all target lists for the mailing
995 * resubscribe: contact opts back into all target lists for the mailing
996 * optOut: contact unsubscribes from the domain
1002 'unsubscribe' => 'u',
1003 'resubscribe' => 'e',
1007 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1008 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1010 foreach ($verpTokens as $key => $value) {
1011 $verp[$key] = implode($config->verpSeparator
,
1013 $localpart . $value,
1018 ) . "@$emailDomain";
1021 //handle should override VERP address.
1022 $skipEncode = FALSE;
1025 self
::overrideVerp($job_id)
1027 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
1031 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
1032 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1033 TRUE, NULL, TRUE, TRUE
1035 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
1036 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1037 TRUE, NULL, TRUE, TRUE
1039 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
1040 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1041 TRUE, NULL, TRUE, TRUE
1043 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1044 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1045 TRUE, NULL, TRUE, TRUE
1047 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1049 TRUE, NULL, TRUE, TRUE
1054 'Reply-To' => $verp['reply'],
1055 'Return-Path' => $verp['bounce'],
1056 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1057 'Subject' => $this->subject
,
1058 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1060 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1062 $headers['Subject'] = "[Fwd:{$this->subject}]";
1064 return array(&$verp, &$urls, &$headers);
1070 * @param int $job_id ID of the Job associated with this message
1071 * @param int $event_queue_id ID of the EventQueue
1072 * @param string $hash Hash of the EventQueue
1073 * @param string $contactId ID of the Contact
1074 * @param string $email Destination address
1075 * @param string $recipient To: of the recipient
1076 * @param boolean $test Is this mailing a test?
1077 * @param $contactDetails
1078 * @param $attachments
1079 * @param boolean $isForward Is this mailing compose for forward?
1080 * @param string $fromEmail email address of who is forwardinf it.
1082 * @param null $replyToEmail
1084 * @return object The mail object
1087 public function &compose($job_id, $event_queue_id, $hash, $contactId,
1088 $email, &$recipient, $test,
1089 $contactDetails, &$attachments, $isForward = FALSE,
1090 $fromEmail = NULL, $replyToEmail = NULL
1092 $config = CRM_Core_Config
::singleton();
1093 $knownTokens = $this->getTokens();
1095 if ($this->_domain
== NULL) {
1096 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1099 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1107 //set from email who is forwarding it and not original one.
1109 unset($headers['From']);
1110 $headers['From'] = "<{$fromEmail}>";
1113 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1114 $headers['Reply-To'] = "{$replyToEmail}";
1117 if ($contactDetails) {
1118 $contact = $contactDetails;
1120 elseif ($contactId === 0) {
1123 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1126 $params = array(array('contact_id', '=', $contactId, 0, 0));
1127 list($contact, $_) = CRM_Contact_BAO_Query
::apiQuery($params);
1130 $contact = reset($contact);
1132 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1133 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1134 array(1 => $contactId)
1136 // setting this because function is called by reference
1137 //@todo test not calling function by reference
1142 // also call the hook to get contact details
1143 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1146 $pTemplates = $this->getPreparedTemplates();
1149 foreach ($pTemplates as $type => $pTemplate) {
1150 $html = ($type == 'html') ?
TRUE : FALSE;
1151 $pEmails[$type] = array();
1152 $pEmail = &$pEmails[$type];
1153 $template = &$pTemplates[$type]['template'];
1154 $tokens = &$pTemplates[$type]['tokens'];
1156 if (!empty($tokens)) {
1157 foreach ($tokens as $idx => $token) {
1158 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1159 array_push($pEmail, $template[$idx]);
1160 array_push($pEmail, $token_data);
1164 array_push($pEmail, $template[$idx]);
1167 if (isset($template[($idx +
1)])) {
1168 array_push($pEmail, $template[($idx +
1)]);
1173 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1174 $html = &$pEmails['html'];
1178 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1179 $text = &$pEmails['text'];
1182 // push the tracking url on to the html email if necessary
1183 if ($this->open_tracking
&& $html) {
1184 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1185 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1189 $message = new Mail_mime("\n");
1191 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1193 $smarty = CRM_Core_Smarty
::singleton();
1194 // also add the contact tokens to the template
1195 $smarty->assign_by_ref('contact', $contact);
1198 $mailParams = $headers;
1199 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1200 $contact['preferred_mail_format'] == 'Both' ||
1201 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1203 $textBody = join('', $text);
1205 $textBody = $smarty->fetch("string:$textBody");
1207 $mailParams['text'] = $textBody;
1210 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1211 $contact['preferred_mail_format'] == 'Both'
1213 $htmlBody = join('', $html);
1215 $htmlBody = $smarty->fetch("string:$htmlBody");
1217 $mailParams['html'] = $htmlBody;
1220 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1222 // something went wrong, lets log it and return null (by reference)
1223 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1230 $mailParams['attachments'] = $attachments;
1232 $mailingSubject = CRM_Utils_Array
::value('subject', $pEmails);
1233 if (is_array($mailingSubject)) {
1234 $mailingSubject = join('', $mailingSubject);
1236 $mailParams['Subject'] = $mailingSubject;
1238 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1241 $mailParams['toEmail'] = $email;
1243 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1245 // CRM-10699 support custom email headers
1246 if (!empty($mailParams['headers'])) {
1247 $headers = array_merge($headers, $mailParams['headers']);
1249 //cycle through mailParams and set headers array
1250 foreach ($mailParams as $paramKey => $paramValue) {
1251 //exclude values not intended for the header
1252 if (!in_array($paramKey, array(
1253 'text', 'html', 'attachments', 'toName', 'toEmail'))) {
1254 $headers[$paramKey] = $paramValue;
1258 if (!empty($mailParams['text'])) {
1259 $message->setTxtBody($mailParams['text']);
1262 if (!empty($mailParams['html'])) {
1263 $message->setHTMLBody($mailParams['html']);
1266 if (!empty($mailParams['attachments'])) {
1267 foreach ($mailParams['attachments'] as $fileID => $attach) {
1268 $message->addAttachment($attach['fullPath'],
1269 $attach['mime_type'],
1270 $attach['cleanName']
1275 //pickup both params from mail params.
1276 $toName = trim($mailParams['toName']);
1277 $toEmail = trim($mailParams['toEmail']);
1278 if ($toName == $toEmail ||
1279 strpos($toName, '@') !== FALSE
1284 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1287 $headers['To'] = "$toName <$toEmail>";
1289 $headers['Precedence'] = 'bulk';
1290 // Will test in the mail processor if the X-VERP is set in the bounced email.
1291 // (As an option to replace real VERP for those that can't set it up)
1292 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1295 //token replacement of subject
1296 $headers['Subject'] = $mailingSubject;
1298 CRM_Utils_Mail
::setMimeParams($message);
1299 $headers = $message->headers($headers);
1301 //get formatted recipient
1302 $recipient = $headers['To'];
1304 // make sure we unset a lot of stuff
1316 * get mailing object and replaces subscribeInvite,
1317 * domain and mailing tokens
1320 public static function tokenReplace(&$mailing) {
1321 $domain = CRM_Core_BAO_Domain
::getDomain();
1323 foreach (array('text', 'html') as $type) {
1324 $tokens = $mailing->getTokens();
1325 if (isset($mailing->templates
[$type])) {
1326 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1327 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1328 $mailing->templates
[$type],
1330 $type == 'html' ?
TRUE : FALSE,
1333 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1340 * getTokenData receives a token from an email
1341 * and returns the appropriate data for the token
1344 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1345 $type = $token_a['type'];
1346 $token = $token_a['token'];
1349 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1351 if ($type == 'embedded_url') {
1352 $embed_data = array();
1353 foreach ($token as $t) {
1354 $embed_data[] = $this->getTokenData($t, $html = FALSE, $contact, $verp, $urls, $event_queue_id);
1356 $numSlices = count($embed_data);
1358 for ($i = 0; $i < $numSlices; $i++
) {
1359 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1361 if (isset($token_a['embed_parts'][$numSlices])) {
1362 $url .= $token_a['embed_parts'][$numSlices];
1364 // add trailing quote since we've gobbled it up in a previous regex
1365 // function getPatterns, line 431
1366 if (preg_match('/^href[ ]*=[ ]*\'/', $url)) {
1369 elseif (preg_match('/^href[ ]*=[ ]*\"/', $url)) {
1374 elseif ($type == 'url') {
1375 if ($this->url_tracking
) {
1376 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1382 elseif ($type == 'contact') {
1383 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1385 elseif ($type == 'action') {
1386 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1388 elseif ($type == 'domain') {
1389 $domain = CRM_Core_BAO_Domain
::getDomain();
1390 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1392 elseif ($type == 'mailing') {
1393 if ($token == 'name') {
1394 $data = $this->name
;
1396 elseif ($token == 'group') {
1397 $groups = $this->getGroupNames();
1398 $data = implode(', ', $groups);
1402 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1408 * Return a list of group names for this mailing. Does not work with
1409 * prior-mailing targets.
1411 * @return array Names of groups receiving this mailing
1414 public function &getGroupNames() {
1415 if (!isset($this->id
)) {
1418 $mg = new CRM_Mailing_DAO_MailingGroup();
1419 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1420 $group = CRM_Contact_BAO_Group
::getTableName();
1422 $mg->query("SELECT $group.title as name FROM $mgtable
1423 INNER JOIN $group ON $mgtable.entity_id = $group.id
1424 WHERE $mgtable.mailing_id = {$this->id}
1425 AND $mgtable.entity_table = '$group'
1426 AND $mgtable.group_type = 'Include'
1427 ORDER BY $group.name");
1430 while ($mg->fetch()) {
1431 $groups[] = $mg->name
;
1438 * function to add the mailings
1440 * @param array $params reference array contains the values submitted by the form
1441 * @param array $ids reference array contains the id
1448 static function add(&$params, $ids = array()) {
1449 $id = CRM_Utils_Array
::value('mailing_id', $ids, CRM_Utils_Array
::value('id', $params));
1452 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1455 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1458 $mailing = new CRM_Mailing_DAO_Mailing();
1460 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1462 if (!isset($params['replyto_email']) &&
1463 isset($params['from_email'])
1465 $params['replyto_email'] = $params['from_email'];
1468 $mailing->copyValues($params);
1470 $result = $mailing->save();
1472 if (!empty($ids['mailing'])) {
1473 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1476 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1483 * Construct a new mailing object, along with job and mailing_group
1484 * objects, from the form values of the create mailing wizard.
1486 * @params array $params Form values
1491 * @return object $mailing The new mailing object
1495 public static function create(&$params, $ids = array()) {
1498 // Do the below only for an insert
1499 // for an update, we should not set the defaults
1500 if (!isset($ids['id']) && !isset($ids['mailing_id'])) {
1501 // Retrieve domain email and name for default sender
1502 $domain = civicrm_api(
1507 'current_domain' => 1,
1511 if (isset($domain['from_email'])) {
1512 $domain_email = $domain['from_email'];
1513 $domain_name = $domain['from_name'];
1516 $domain_email = 'info@EXAMPLE.ORG';
1517 $domain_name = 'EXAMPLE.ORG';
1519 if (!isset($params['created_id'])) {
1520 $session =& CRM_Core_Session
::singleton();
1521 $params['created_id'] = $session->get('userID');
1524 // load the default config settings for each
1525 // eg reply_id, unsubscribe_id need to use
1526 // correct template IDs here
1527 'override_verp' => TRUE,
1528 'forward_replies' => FALSE,
1529 'open_tracking' => TRUE,
1530 'url_tracking' => TRUE,
1531 'visibility' => 'User and User Admin Only',
1532 'replyto_email' => $domain_email,
1533 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1534 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1535 'from_email' => $domain_email,
1536 'from_name' => $domain_name,
1537 'msg_template_id' => NULL,
1538 'created_id' => $params['created_id'],
1539 'approver_id' => NULL,
1540 'auto_responder' => 0,
1541 'created_date' => date('YmdHis'),
1542 'scheduled_date' => NULL,
1543 'approval_date' => NULL,
1546 // Get the default from email address, if not provided.
1547 if (empty($defaults['from_email'])) {
1548 $defaultAddress = CRM_Core_OptionGroup
::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
1549 foreach ($defaultAddress as $id => $value) {
1550 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1551 $defaults['from_email'] = $match[2];
1552 $defaults['from_name'] = $match[1];
1557 $params = array_merge($defaults, $params);
1561 * Could check and warn for the following cases:
1563 * - groups OR mailings should be populated.
1564 * - body html OR body text should be populated.
1567 $transaction = new CRM_Core_Transaction();
1569 $mailing = self
::add($params, $ids);
1571 if (is_a($mailing, 'CRM_Core_Error')) {
1572 $transaction->rollback();
1575 // update mailings with hash values
1576 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1578 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1579 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
1581 /* Create the mailing group record */
1582 $mg = new CRM_Mailing_DAO_MailingGroup();
1583 foreach (array('groups', 'mailings') as $entity) {
1584 foreach (array('include', 'exclude', 'base') as $type) {
1585 if (isset($params[$entity]) && !empty($params[$entity][$type]) &&
1586 is_array($params[$entity][$type])) {
1587 foreach ($params[$entity][$type] as $entityId) {
1589 $mg->mailing_id
= $mailing->id
;
1590 $mg->entity_table
= ($entity == 'groups') ?
$groupTableName : $mailingTableName;
1591 $mg->entity_id
= $entityId;
1592 $mg->group_type
= $type;
1599 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1601 $mg->mailing_id
= $mailing->id
;
1602 $mg->entity_table
= $groupTableName;
1603 $mg->entity_id
= $params['group_id'];
1604 $mg->search_id
= $params['search_id'];
1605 $mg->search_args
= $params['search_args'];
1606 $mg->group_type
= 'Include';
1610 // check and attach and files as needed
1611 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1613 $transaction->commit();
1616 * create parent job if not yet created
1617 * condition on the existence of a scheduled date
1619 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null') {
1620 $job = new CRM_Mailing_BAO_MailingJob();
1621 $job->mailing_id
= $mailing->id
;
1622 $job->status
= 'Scheduled';
1625 if ( !$job->find(TRUE) ) {
1626 $job->scheduled_date
= $params['scheduled_date'];
1630 // Populate the recipients.
1631 $mailing->getRecipients($job->id
, $mailing->id
, NULL, NULL, TRUE, FALSE);
1638 * get hash value of the mailing
1641 public static function getMailingHash($id) {
1643 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'hash_mailing_url')) {
1644 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1650 * Generate a report. Fetch event count information, mailing data, and job
1653 * @param int $id The mailing id to report
1654 * @param boolean $skipDetails whether return all detailed report
1656 * @param bool $isSMS
1658 * @return array Associative array of reporting data
1662 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1663 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1665 $mailing = new CRM_Mailing_BAO_Mailing();
1668 'mailing' => self
::getTableName(),
1669 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1670 'group' => CRM_Contact_BAO_Group
::getTableName(),
1671 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1672 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1673 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1674 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1675 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1677 CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1678 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1679 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1680 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1682 CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1683 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1684 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1689 $additionalWhereClause = " AND ";
1691 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1694 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1697 /* Get the mailing info */
1700 SELECT {$t['mailing']}.*
1701 FROM {$t['mailing']}
1702 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1706 $report['mailing'] = array();
1707 foreach (array_keys(self
::fields()) as $field) {
1708 $report['mailing'][$field] = $mailing->$field;
1712 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1713 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1714 $report['mailing']['campaign'] = $campaigns[$campaignId];
1717 //mailing report is called by activity
1718 //we dont need all detail report
1723 /* Get the component info */
1727 $components = array(
1728 'header' => ts('Header'),
1729 'footer' => ts('Footer'),
1730 'reply' => ts('Reply'),
1731 'unsubscribe' => ts('Unsubscribe'),
1732 'optout' => ts('Opt-Out'),
1734 foreach (array_keys($components) as $type) {
1735 $query[] = "SELECT {$t['component']}.name as name,
1737 {$t['component']}.id as id
1738 FROM {$t['component']}
1739 INNER JOIN {$t['mailing']}
1740 ON {$t['mailing']}.{$type}_id =
1741 {$t['component']}.id
1742 WHERE {$t['mailing']}.id = $mailing_id";
1744 $q = '(' . implode(') UNION (', $query) . ')';
1745 $mailing->query($q);
1747 $report['component'] = array();
1748 while ($mailing->fetch()) {
1749 $report['component'][] = array(
1750 'type' => $components[$mailing->type
],
1751 'name' => $mailing->name
,
1753 CRM_Utils_System
::url('civicrm/mailing/component',
1754 "reset=1&action=update&id={$mailing->id}"
1759 /* Get the recipient group info */
1762 SELECT {$t['mailing_group']}.group_type as group_type,
1763 {$t['group']}.id as group_id,
1764 {$t['group']}.title as group_title,
1765 {$t['group']}.is_hidden as group_hidden,
1766 {$t['mailing']}.id as mailing_id,
1767 {$t['mailing']}.name as mailing_name
1768 FROM {$t['mailing_group']}
1769 LEFT JOIN {$t['group']}
1770 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1771 AND {$t['mailing_group']}.entity_table =
1773 LEFT JOIN {$t['mailing']}
1774 ON {$t['mailing_group']}.entity_id =
1776 AND {$t['mailing_group']}.entity_table =
1779 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1782 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1783 while ($mailing->fetch()) {
1785 if (isset($mailing->group_id
)) {
1786 $row['id'] = $mailing->group_id
;
1787 $row['name'] = $mailing->group_title
;
1788 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1789 "reset=1&force=1&context=smog&gid={$row['id']}"
1793 $row['id'] = $mailing->mailing_id
;
1794 $row['name'] = $mailing->mailing_name
;
1795 $row['mailing'] = TRUE;
1796 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1801 /* Rename hidden groups */
1803 if ($mailing->group_hidden
== 1) {
1804 $row['name'] = "Search Results";
1807 if ($mailing->group_type
== 'Include') {
1808 $report['group']['include'][] = $row;
1810 elseif ($mailing->group_type
== 'Base') {
1811 $report['group']['base'][] = $row;
1814 $report['group']['exclude'][] = $row;
1818 /* Get the event totals, grouped by job (retries) */
1821 SELECT {$t['job']}.*,
1822 COUNT(DISTINCT {$t['queue']}.id) as queue,
1823 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1824 COUNT(DISTINCT {$t['reply']}.id) as reply,
1825 COUNT(DISTINCT {$t['forward']}.id) as forward,
1826 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1827 COUNT(DISTINCT {$t['urlopen']}.id) as url,
1828 COUNT(DISTINCT {$t['spool']}.id) as spool
1830 LEFT JOIN {$t['queue']}
1831 ON {$t['queue']}.job_id = {$t['job']}.id
1832 LEFT JOIN {$t['reply']}
1833 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
1834 LEFT JOIN {$t['forward']}
1835 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
1836 LEFT JOIN {$t['bounce']}
1837 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
1838 LEFT JOIN {$t['delivered']}
1839 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
1840 AND {$t['bounce']}.id IS null
1841 LEFT JOIN {$t['urlopen']}
1842 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1843 LEFT JOIN {$t['spool']}
1844 ON {$t['spool']}.job_id = {$t['job']}.id
1845 WHERE {$t['job']}.mailing_id = $mailing_id
1846 AND {$t['job']}.is_test = 0
1847 GROUP BY {$t['job']}.id");
1849 $report['jobs'] = array();
1850 $report['event_totals'] = array();
1852 'queue', 'delivered', 'url', 'forward',
1853 'reply', 'unsubscribe', 'optout', 'opened', 'bounce', 'spool',
1856 // initialize various counters
1857 foreach ($elements as $field) {
1858 $report['event_totals'][$field] = 0;
1861 while ($mailing->fetch()) {
1863 foreach ($elements as $field) {
1864 if (isset($mailing->$field)) {
1865 $row[$field] = $mailing->$field;
1866 $report['event_totals'][$field] +
= $mailing->$field;
1870 // compute open total separately to discount duplicates
1872 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
1873 $report['event_totals']['opened'] +
= $row['opened'];
1875 // compute unsub total separately to discount duplicates
1877 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
1878 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
1880 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
1881 $report['event_totals']['optout'] +
= $row['optout'];
1883 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
1884 $row[$field] = $mailing->$field;
1887 if ($mailing->queue
) {
1888 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
1889 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
1890 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
1891 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
1894 $row['delivered_rate'] = 0;
1895 $row['bounce_rate'] = 0;
1896 $row['unsubscribe_rate'] = 0;
1897 $row['optout_rate'] = 0;
1900 $row['links'] = array(
1901 'clicks' => CRM_Utils_System
::url(
1902 'civicrm/mailing/report/event',
1903 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
1905 'queue' => CRM_Utils_System
::url(
1906 'civicrm/mailing/report/event',
1907 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
1909 'delivered' => CRM_Utils_System
::url(
1910 'civicrm/mailing/report/event',
1911 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
1913 'bounce' => CRM_Utils_System
::url(
1914 'civicrm/mailing/report/event',
1915 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
1917 'unsubscribe' => CRM_Utils_System
::url(
1918 'civicrm/mailing/report/event',
1919 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
1921 'forward' => CRM_Utils_System
::url(
1922 'civicrm/mailing/report/event',
1923 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
1925 'reply' => CRM_Utils_System
::url(
1926 'civicrm/mailing/report/event',
1927 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
1929 'opened' => CRM_Utils_System
::url(
1930 'civicrm/mailing/report/event',
1931 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
1936 'scheduled_date', 'start_date', 'end_date') as $key) {
1937 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
1939 $report['jobs'][] = $row;
1942 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
1944 // we need to do this for backward compatibility, since old mailings did not
1945 // use the mailing_recipients table
1946 if ($newTableSize > 0) {
1947 $report['event_totals']['queue'] = $newTableSize;
1950 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id, $mailing_id);
1953 if (!empty($report['event_totals']['queue'])) {
1954 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
1955 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
1956 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
1957 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
1960 $report['event_totals']['delivered_rate'] = 0;
1961 $report['event_totals']['bounce_rate'] = 0;
1962 $report['event_totals']['unsubscribe_rate'] = 0;
1963 $report['event_totals']['optout_rate'] = 0;
1966 /* Get the click-through totals, grouped by URL */
1969 SELECT {$t['url']}.url,
1971 COUNT({$t['urlopen']}.id) as clicks,
1972 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
1974 LEFT JOIN {$t['urlopen']}
1975 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
1976 LEFT JOIN {$t['queue']}
1977 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1978 LEFT JOIN {$t['job']}
1979 ON {$t['queue']}.job_id = {$t['job']}.id
1980 WHERE {$t['url']}.mailing_id = $mailing_id
1981 AND {$t['job']}.is_test = 0
1982 GROUP BY {$t['url']}.id");
1984 $report['click_through'] = array();
1986 while ($mailing->fetch()) {
1987 $report['click_through'][] = array(
1988 'url' => $mailing->url
,
1990 CRM_Utils_System
::url(
1991 'civicrm/mailing/report/event',
1992 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
1995 CRM_Utils_System
::url(
1996 'civicrm/mailing/report/event',
1997 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
1999 'clicks' => $mailing->clicks
,
2000 'unique' => $mailing->unique_clicks
,
2001 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2005 $report['event_totals']['links'] = array(
2006 'clicks' => CRM_Utils_System
::url(
2007 'civicrm/mailing/report/event',
2008 "reset=1&event=click&mid=$mailing_id"
2010 'clicks_unique' => CRM_Utils_System
::url(
2011 'civicrm/mailing/report/event',
2012 "reset=1&event=click&mid=$mailing_id&distinct=1"
2014 'queue' => CRM_Utils_System
::url(
2015 'civicrm/mailing/report/event',
2016 "reset=1&event=queue&mid=$mailing_id"
2018 'delivered' => CRM_Utils_System
::url(
2019 'civicrm/mailing/report/event',
2020 "reset=1&event=delivered&mid=$mailing_id"
2022 'bounce' => CRM_Utils_System
::url(
2023 'civicrm/mailing/report/event',
2024 "reset=1&event=bounce&mid=$mailing_id"
2026 'unsubscribe' => CRM_Utils_System
::url(
2027 'civicrm/mailing/report/event',
2028 "reset=1&event=unsubscribe&mid=$mailing_id"
2030 'optout' => CRM_Utils_System
::url(
2031 'civicrm/mailing/report/event',
2032 "reset=1&event=optout&mid=$mailing_id"
2034 'forward' => CRM_Utils_System
::url(
2035 'civicrm/mailing/report/event',
2036 "reset=1&event=forward&mid=$mailing_id"
2038 'reply' => CRM_Utils_System
::url(
2039 'civicrm/mailing/report/event',
2040 "reset=1&event=reply&mid=$mailing_id"
2042 'opened' => CRM_Utils_System
::url(
2043 'civicrm/mailing/report/event',
2044 "reset=1&event=opened&mid=$mailing_id"
2049 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2050 if (CRM_Core_Permission
::check('view all contacts')) {
2051 $actionLinks[CRM_Core_Action
::ADVANCED
] =
2053 'name' => ts('Advanced Search'),
2054 'url' => 'civicrm/contact/search/advanced',
2057 $action = array_sum(array_keys($actionLinks));
2059 $report['event_totals']['actionlinks'] = array();
2061 'clicks', 'clicks_unique', 'queue', 'delivered', 'bounce', 'unsubscribe',
2062 'forward', 'reply', 'opened', 'optout',
2064 $url = 'mailing/detail';
2065 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2066 $searchFilter = "force=1&mailing_id=%%mid%%";
2069 $reportFilter .= "&delivery_status_value=successful";
2070 $searchFilter .= "&mailing_delivery_status=Y";
2074 $url = "mailing/bounce";
2075 $searchFilter .= "&mailing_delivery_status=N";
2079 $reportFilter .= "&is_forwarded_value=1";
2080 $searchFilter .= "&mailing_forward=1";
2084 $reportFilter .= "&is_replied_value=1";
2085 $searchFilter .= "&mailing_reply_status=Y";
2089 $reportFilter .= "&is_unsubscribed_value=1";
2090 $searchFilter .= "&mailing_unsubscribe=1";
2094 $reportFilter .= "&is_optout_value=1";
2095 $searchFilter .= "&mailing_optout=1";
2099 $url = "mailing/opened";
2100 $searchFilter .= "&mailing_open_status=Y";
2104 case 'clicks_unique':
2105 $url = "mailing/clicks";
2106 $searchFilter .= "&mailing_click_status=Y";
2109 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2110 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2111 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2113 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2116 array('mid' => $mailing_id),
2119 'mailing.report.action',
2129 * Get the count of mailings
2136 public function getCount() {
2138 $this->selectAdd('COUNT(id) as count');
2140 $session = CRM_Core_Session
::singleton();
2143 return $this->count
;
2146 static function checkPermission($id) {
2151 $mailingIDs = self
::mailingACLIDs();
2152 if ($mailingIDs === TRUE) {
2156 if (!in_array($id, $mailingIDs)) {
2157 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2162 static function mailingACL($alias = NULL) {
2163 $mailingACL = " ( 0 ) ";
2165 $mailingIDs = self
::mailingACLIDs();
2166 if ($mailingIDs === TRUE) {
2170 if (!empty($mailingIDs)) {
2171 $mailingIDs = implode(',', $mailingIDs);
2172 $tableName = !$alias ? self
::getTableName() : $alias;
2173 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2179 * returns all the mailings that this user can access. This is dependent on
2180 * all the groups that the user has access to.
2181 * However since most civi installs dont use ACL's we special case the condition
2182 * where the user has access to ALL groups, and hence ALL mailings and return a
2183 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2185 * @return boolean | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty)
2188 static function mailingACLIDs() {
2190 // optimize common case where admin has access
2193 CRM_Core_Permission
::check('view all contacts') ||
2194 CRM_Core_Permission
::check('edit all contacts')
2199 $mailingIDs = array();
2201 // get all the groups that this user can access
2202 // if they dont have universal access
2203 $groups = CRM_Core_PseudoConstant
::group(NULL, FALSE);
2204 if (!empty($groups)) {
2205 $groupIDs = implode(',', array_keys($groups));
2207 // get all the mailings that are in this subset of groups
2209 SELECT DISTINCT( m.id ) as id
2210 FROM civicrm_mailing m
2211 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2212 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2213 OR ( g.entity_table IS NULL AND g.entity_id IS NULL ) )
2215 $dao = CRM_Core_DAO
::executeQuery($query);
2217 $mailingIDs = array();
2218 while ($dao->fetch()) {
2219 $mailingIDs[] = $dao->id
;
2227 * Get the rows for a browse operation
2229 * @param int $offset The row number to start from
2230 * @param int $rowCount The nmber of rows to return
2231 * @param string $sort The sql string that describes the sort order
2233 * @param null $additionalClause
2234 * @param null $additionalParams
2236 * @return array The rows
2239 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2240 $mailing = self
::getTableName();
2241 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2242 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2243 $session = CRM_Core_Session
::singleton();
2245 $mailingACL = self
::mailingACL();
2247 //get all campaigns.
2248 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2250 // we only care about parent jobs, since that holds all the info on
2256 $mailing.approval_status_id,
2257 MIN($job.scheduled_date) as scheduled_date,
2258 MIN($job.start_date) as start_date,
2259 MAX($job.end_date) as end_date,
2260 createdContact.sort_name as created_by,
2261 scheduledContact.sort_name as scheduled_by,
2262 $mailing.created_id as created_id,
2263 $mailing.scheduled_id as scheduled_id,
2264 $mailing.is_archived as archived,
2265 $mailing.created_date as created_date,
2267 $mailing.sms_provider_id as sms_provider_id
2269 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2270 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2271 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2272 WHERE $mailingACL $additionalClause
2273 GROUP BY $mailing.id ";
2276 $orderBy = trim($sort->orderBy());
2277 if (!empty($orderBy)) {
2278 $query .= " ORDER BY $orderBy";
2283 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2284 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2286 $query .= " LIMIT $offset, $rowCount ";
2289 if (!$additionalParams) {
2290 $additionalParams = array();
2293 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2296 while ($dao->fetch()) {
2299 'name' => $dao->name
,
2300 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2301 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2302 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2303 'scheduled_iso' => $dao->scheduled_date
,
2304 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2305 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2306 'created_by' => $dao->created_by
,
2307 'scheduled_by' => $dao->scheduled_by
,
2308 'created_id' => $dao->created_id
,
2309 'scheduled_id' => $dao->scheduled_id
,
2310 'archived' => $dao->archived
,
2311 'approval_status_id' => $dao->approval_status_id
,
2312 'campaign_id' => $dao->campaign_id
,
2313 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2314 'sms_provider_id' => $dao->sms_provider_id
,
2321 * Function to show detail Mailing report
2329 static function showEmailDetails($id) {
2330 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2334 * Delete Mails and all its associated records
2336 * @param int $id id of the mail to delete
2342 public static function del($id) {
2344 CRM_Core_Error
::fatal();
2347 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2349 // delete all file attachments
2350 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2354 $dao = new CRM_Mailing_DAO_Mailing();
2358 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2360 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2364 * Delete Jobss and all its associated records
2365 * related to test Mailings
2367 * @param int $id id of the Job to delete
2373 public static function delJob($id) {
2375 CRM_Core_Error
::fatal();
2378 $dao = new CRM_Mailing_BAO_MailingJob();
2383 function getReturnProperties() {
2384 $tokens = &$this->getTokens();
2386 $properties = array();
2387 if (isset($tokens['html']) &&
2388 isset($tokens['html']['contact'])
2390 $properties = array_merge($properties, $tokens['html']['contact']);
2393 if (isset($tokens['text']) &&
2394 isset($tokens['text']['contact'])
2396 $properties = array_merge($properties, $tokens['text']['contact']);
2399 if (isset($tokens['subject']) &&
2400 isset($tokens['subject']['contact'])
2402 $properties = array_merge($properties, $tokens['subject']['contact']);
2405 $returnProperties = array();
2406 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2408 foreach ($properties as $p) {
2409 $returnProperties[$p] = 1;
2412 return $returnProperties;
2416 * Function to build the compose mail form
2423 public static function commonCompose(&$form) {
2425 $tokens = CRM_Core_SelectValues
::contactTokens();
2427 $className = CRM_Utils_System
::getClassName($form);
2428 if ($className == 'CRM_Mailing_Form_Upload') {
2429 $tokens = array_merge(CRM_Core_SelectValues
::mailingTokens(), $tokens);
2431 elseif ($className == 'CRM_Admin_Form_ScheduleReminders') {
2432 $tokens = array_merge(CRM_Core_SelectValues
::activityTokens(), $tokens);
2433 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
2434 $tokens = array_merge(CRM_Core_SelectValues
::membershipTokens(), $tokens);
2436 elseif ($className == 'CRM_Event_Form_ManageEvent_ScheduleReminders') {
2437 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
2440 //sorted in ascending order tokens by ignoring word case
2441 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2443 $form->_templates
= CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2444 if (!empty($form->_templates
)) {
2445 $form->assign('templates', TRUE);
2446 $form->add('select', 'template', ts('Use Template'),
2448 '' => ts('- select -')) +
$form->_templates
, FALSE,
2449 array('onChange' => "selectValue( this.value );")
2451 $form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
2454 $form->add('checkbox', 'saveTemplate', ts('Save As New Template'), NULL, FALSE,
2455 array('onclick' => "showSaveDetails(this);")
2457 $form->add('text', 'saveTemplateName', ts('Template Title'));
2460 //insert message Text by selecting "Select Template option"
2461 $form->add('textarea',
2463 ts('Plain-text format'),
2465 'cols' => '80', 'rows' => '8',
2466 'onkeyup' => "return verify(this)",
2470 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2471 $className != 'CRM_Contact_Form_Task_SMS'
2473 $form->addWysiwyg('html_message',
2476 'cols' => '80', 'rows' => '8',
2477 'onkeyup' => "return verify(this)",
2484 * Function to build the compose PDF letter form
2491 public static function commonLetterCompose(&$form) {
2493 $tokens = CRM_Core_SelectValues
::contactTokens();
2494 if (CRM_Utils_System
::getClassName($form) == 'CRM_Mailing_Form_Upload') {
2495 $tokens = array_merge(CRM_Core_SelectValues
::mailingTokens(), $tokens);
2497 //@todo move this fn onto the form
2498 if (CRM_Utils_System
::getClassName($form) == 'CRM_Contribute_Form_Task_PDFLetter') {
2499 $tokens = array_merge(CRM_Core_SelectValues
::contributionTokens(), $tokens);
2502 if(method_exists($form, 'listTokens')) {
2503 $tokens = array_merge($form->listTokens(), $tokens);
2506 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2508 $form->_templates
= CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2509 if (!empty($form->_templates
)) {
2510 $form->assign('templates', TRUE);
2511 $form->add('select', 'template', ts('Select Template'),
2513 '' => ts('- select -')) +
$form->_templates
, FALSE,
2514 array('onChange' => "selectValue( this.value );")
2516 $form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
2519 $form->add('checkbox', 'saveTemplate', ts('Save As New Template'), NULL, FALSE,
2520 array('onclick' => "showSaveDetails(this);")
2522 $form->add('text', 'saveTemplateName', ts('Template Title'));
2525 $form->addWysiwyg('html_message',
2528 'cols' => '80', 'rows' => '8',
2529 'onkeyup' => "return verify(this)",
2532 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2533 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2534 $action == CRM_Core_Action
::VIEW
2536 $form->freeze('html_message');
2541 * Get the search based mailing Ids
2543 * @return array $mailingIDs, searched base mailing ids.
2546 public function searchMailingIDs() {
2547 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2548 $mailing = self
::getTableName();
2551 SELECT $mailing.id as mailing_id
2552 FROM $mailing, $group
2553 WHERE $group.mailing_id = $mailing.id
2554 AND $group.group_type = 'Base'";
2556 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2557 $mailingIDs = array();
2558 while ($searchDAO->fetch()) {
2559 $mailingIDs[] = $searchDAO->mailing_id
;
2566 * Get the content/components of mailing based on mailing Id
2568 * @param $report array of mailing report
2570 * @param $form reference of this
2572 * @param bool $isSMS
2574 * @return array $report array content/component.@access public
2576 static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2577 $htmlHeader = $textHeader = NULL;
2578 $htmlFooter = $textFooter = NULL;
2581 if ($report['mailing']['header_id']) {
2582 $header = new CRM_Mailing_BAO_Component();
2583 $header->id
= $report['mailing']['header_id'];
2584 $header->find(TRUE);
2585 $htmlHeader = $header->body_html
;
2586 $textHeader = $header->body_text
;
2589 if ($report['mailing']['footer_id']) {
2590 $footer = new CRM_Mailing_BAO_Component();
2591 $footer->id
= $report['mailing']['footer_id'];
2592 $footer->find(TRUE);
2593 $htmlFooter = $footer->body_html
;
2594 $textFooter = $footer->body_text
;
2598 $mailingKey = $form->_mailing_id
;
2600 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2601 $mailingKey = $hash;
2605 if (!empty($report['mailing']['body_text'])) {
2606 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2607 $form->assign('textViewURL', $url);
2611 if (!empty($report['mailing']['body_html'])) {
2612 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2613 $form->assign('htmlViewURL', $url);
2618 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2623 static function overrideVerp($jobID) {
2624 static $_cache = array();
2626 if (!isset($_cache[$jobID])) {
2628 SELECT override_verp
2629 FROM civicrm_mailing
2630 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2631 WHERE civicrm_mailing_job.id = %1
2633 $params = array(1 => array($jobID, 'Integer'));
2634 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2636 return $_cache[$jobID];
2639 static function processQueue($mode = NULL) {
2640 $config = &CRM_Core_Config
::singleton();
2641 // CRM_Core_Error::debug_log_message("Beginning processQueue run: {$config->mailerJobsMax}, {$config->mailerJobSize}");
2643 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2644 CRM_Core_Error
::fatal(ts('The <a href="%1">default mailbox</a> has not been configured. You will find <a href="%2">more info in the online user and administrator guide</a>', array(1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'), 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/")));
2647 // check if we are enforcing number of parallel cron jobs
2649 $gotCronLock = FALSE;
2651 if (property_exists($config, 'mailerJobsMax') && $config->mailerJobsMax
&& $config->mailerJobsMax
> 1) {
2652 $lockArray = range(1, $config->mailerJobsMax
);
2653 shuffle($lockArray);
2655 // check if we are using global locks
2656 $serverWideLock = CRM_Core_BAO_Setting
::getItem(
2657 CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
2658 'civimail_server_wide_lock'
2660 foreach ($lockArray as $lockID) {
2661 $cronLock = new CRM_Core_Lock("civimail.cronjob.{$lockID}", NULL, $serverWideLock);
2662 if ($cronLock->isAcquired()) {
2663 $gotCronLock = TRUE;
2668 // exit here since we have enuf cronjobs running
2669 if (!$gotCronLock) {
2670 CRM_Core_Error
::debug_log_message('Returning early, since max number of cronjobs running');
2675 // load bootstrap to call hooks
2677 // Split up the parent jobs into multiple child jobs
2678 $mailerJobSize = (property_exists($config, 'mailerJobSize')) ?
$config->mailerJobSize
: NULL;
2679 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2680 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2681 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2683 // lets release the global cron lock if we do have one
2685 $cronLock->release();
2688 // CRM_Core_Error::debug_log_message('Ending processQueue run');
2692 private static function addMultipleEmails($mailingID) {
2694 INSERT INTO civicrm_mailing_recipients
2695 (mailing_id, email_id, contact_id)
2696 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2698 AND e.is_bulkmail = 1
2700 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2701 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2703 $params = array(1 => array($mailingID, 'Integer'));
2705 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2708 static function getMailingsList($isSMS = FALSE) {
2709 static $list = array();
2712 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2715 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2720 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2721 FROM civicrm_mailing
2722 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2723 ORDER BY civicrm_mailing.name";
2724 $mailing = CRM_Core_DAO
::executeQuery($query);
2726 while ($mailing->fetch()) {
2727 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2734 static function hiddenMailingGroup($mid) {
2737 FROM civicrm_mailing m
2738 INNER JOIN civicrm_mailing_group mg ON mg.mailing_id = m.id
2739 INNER JOIN civicrm_group g ON mg.entity_id = g.id AND mg.entity_table = 'civicrm_group'
2740 WHERE g.is_hidden = 1
2741 AND mg.group_type = 'Include'
2744 $params = array( 1 => array( $mid, 'Integer' ) );
2745 return CRM_Core_DAO
::singleValueQuery($sql, $params);
2749 * This function is a wrapper for ajax activity selector
2751 * @param array $params associated array for params record id.
2753 * @return array $contactActivities associated array of contact activities
2756 public static function getContactMailingSelector(&$params) {
2757 // format the params
2758 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2759 $params['rowCount'] = $params['rp'];
2760 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2761 $params['caseId'] = NULL;
2763 // get contact mailings
2764 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2767 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2770 if (!empty($mailings)) {
2771 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2772 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2775 // format params and add links
2776 $contactMailings = array();
2777 foreach ($mailings as $mailingId => $values) {
2778 $contactMailings[$mailingId]['subject'] = $values['subject'];
2779 $contactMailings[$mailingId]['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2780 $contactMailings[$mailingId]['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2781 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2783 $contactMailings[$mailingId]['mailing_creator'] = CRM_Utils_System
::href(
2784 $values['creator_name'],
2785 'civicrm/contact/view',
2786 "reset=1&cid={$values['creator_id']}");
2789 $contactMailings[$mailingId]['openstats'] = "Opens: ".
2790 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0).
2792 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
2794 $actionLinks = array(
2795 CRM_Core_Action
::VIEW
=> array(
2796 'name' => ts('View'),
2797 'url' => 'civicrm/mailing/view',
2798 'qs' => "reset=1&id=%%mkey%%",
2799 'title' => ts('View Mailing'),
2800 'class' => 'crm-popup',
2802 CRM_Core_Action
::BROWSE
=> array(
2803 'name' => ts('Mailing Report'),
2804 'url' => 'civicrm/mailing/report',
2805 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
2806 'title' => ts('View Mailing Report'),
2810 $mailingKey = $values['mailing_id'];
2811 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2812 $mailingKey = $hash;
2815 $contactMailings[$mailingId]['links'] = CRM_Core_Action
::formLink(
2819 'mid' => $values['mailing_id'],
2820 'cid' => $params['contact_id'],
2821 'mkey' => $mailingKey,
2825 'mailing.contact.action',
2827 $values['mailing_id']
2831 return $contactMailings;
2835 * Function to retrieve contact mailing
2837 * @param array $params associated array
2839 * @return array of mailings for a contact
2844 static public function getContactMailings(&$params) {
2845 $params['version'] = 3;
2846 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2847 $params['limit'] = $params['rp'];
2848 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2850 $result = civicrm_api('MailingContact', 'get', $params);
2851 return $result['values'];
2855 * Function to retrieve contact mailing count
2857 * @param array $params associated array
2859 * @return int count of mailings for a contact
2864 static public function getContactMailingsCount(&$params) {
2865 $params['version'] = 3;
2866 return civicrm_api('MailingContact', 'getcount', $params);