3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
33 require_once 'Mail/mime.php';
36 * Class CRM_Mailing_BAO_Mailing
38 class CRM_Mailing_BAO_Mailing
extends CRM_Mailing_DAO_Mailing
{
41 * An array that holds the complete templates
42 * including any headers or footers that need to be prepended
43 * or appended to the body.
45 private $preparedTemplates = NULL;
48 * An array that holds the complete templates
49 * including any headers or footers that need to be prepended
50 * or appended to the body.
52 private $templates = NULL;
55 * An array that holds the tokens that are specifically found in our text and html bodies.
57 private $tokens = NULL;
60 * An array that holds the tokens that are specifically found in our text and html bodies.
62 private $flattenedTokens = NULL;
65 * The header associated with this mailing.
67 private $header = NULL;
70 * The footer associated with this mailing.
72 private $footer = NULL;
75 * The HTML content of the message.
80 * The text content of the message.
85 * Cached BAO for the domain.
87 private $_domain = NULL;
92 public function __construct() {
93 parent
::__construct();
100 * @param int $mailing_id
104 public static function getRecipientsCount($job_id, $mailing_id = NULL) {
105 // need this for backward compatibility, so we can get count for old mailings
106 // please do not use this function if possible.
107 $eq = self
::getRecipients($job_id, $mailing_id);
112 * note that $job_id is used only as a variable in the temp table construction
113 * and does not play a role in the queries generated.
115 * (misnomer) a nonce value used to name temporary tables.
116 * @param int $mailing_id
117 * @param bool $storeRecipients
118 * @param bool $dedupeEmail
121 * @return CRM_Mailing_Event_BAO_Queue|string
123 public static function getRecipients(
126 $storeRecipients = FALSE,
127 $dedupeEmail = FALSE,
129 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
131 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
132 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
133 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
134 $eq = CRM_Mailing_Event_DAO_Queue
::getTableName();
136 $email = CRM_Core_DAO_Email
::getTableName();
137 if ($mode == 'sms') {
138 $phone = CRM_Core_DAO_Phone
::getTableName();
140 $contact = CRM_Contact_DAO_Contact
::getTableName();
142 $group = CRM_Contact_DAO_Group
::getTableName();
143 $g2contact = CRM_Contact_DAO_GroupContact
::getTableName();
145 $m = new CRM_Mailing_DAO_Mailing();
146 $m->id
= $mailing_id;
149 $email_selection_method = $m->email_selection_method
;
150 $location_type_id = $m->location_type_id
;
152 // Note: When determining the ORDER that results are returned, it's
153 // the record that comes last that counts. That's because we are
154 // INSERT'ing INTO a table with a primary id so that last record
155 // over writes any previous record.
156 switch ($email_selection_method) {
157 case 'location-exclude':
158 $location_filter = "($email.location_type_id != $location_type_id)";
159 // If there is more than one email that doesn't match the location,
160 // prefer the one marked is_bulkmail, followed by is_primary.
161 $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
164 case 'location-only':
165 $location_filter = "($email.location_type_id = $location_type_id)";
166 // If there is more than one email of the desired location, prefer
167 // the one marked is_bulkmail, followed by is_primary.
168 $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
171 case 'location-prefer':
172 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
174 // ORDER BY is more complicated because we have to set an arbitrary
175 // order that prefers the location that we want. We do that using
176 // the FIELD function. For more info, see:
177 // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
178 // We assign the location type we want the value "1" by putting it
179 // in the first position after we name the field. All other location
180 // types are left out, so they will be assigned the value 0. That
181 // means, they will all be equally tied for first place, with our
182 // location being last.
183 $order_by = "ORDER BY FIELD($email.location_type_id, $location_type_id), $email.is_bulkmail, $email.is_primary";
187 // fall through to default
189 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
190 $order_by = "ORDER BY $email.is_bulkmail";
193 // Create a temp table for contact exclusion.
194 $mailingGroup->query(
195 "CREATE TEMPORARY TABLE X_$job_id
196 (contact_id int primary key)
200 // Add all the members of groups excluded from this mailing to the temp
203 $excludeSubGroup = "INSERT INTO X_$job_id (contact_id)
204 SELECT DISTINCT $g2contact.contact_id
207 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
209 $mg.mailing_id = {$mailing_id}
210 AND $g2contact.status = 'Added'
211 AND $mg.group_type = 'Exclude'";
212 $mailingGroup->query($excludeSubGroup);
214 // Add all unsubscribe members of base group from this mailing to the temp
217 $unSubscribeBaseGroup = "INSERT INTO X_$job_id (contact_id)
218 SELECT DISTINCT $g2contact.contact_id
221 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
223 $mg.mailing_id = {$mailing_id}
224 AND $g2contact.status = 'Removed'
225 AND $mg.group_type = 'Base'";
226 $mailingGroup->query($unSubscribeBaseGroup);
228 // Add all the (intended) recipients of an excluded prior mailing to
231 $excludeSubMailing = "INSERT IGNORE INTO X_$job_id (contact_id)
232 SELECT DISTINCT $eq.contact_id
235 ON $eq.job_id = $job.id
237 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
239 $mg.mailing_id = {$mailing_id}
240 AND $mg.group_type = 'Exclude'";
241 $mailingGroup->query($excludeSubMailing);
243 // get all the saved searches AND hierarchical groups
244 // and load them in the cache
246 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
248 INNER JOIN $mg ON $mg.entity_id = $group.id
249 WHERE $mg.entity_table = '$group'
250 AND $mg.group_type = 'Exclude'
251 AND $mg.mailing_id = {$mailing_id}
252 AND ( saved_search_id != 0
253 OR saved_search_id IS NOT NULL
254 OR children IS NOT NULL )
257 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
258 while ($groupDAO->fetch()) {
259 if ($groupDAO->cache_date
== NULL) {
260 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
263 $smartGroupExclude = "
264 INSERT IGNORE INTO X_$job_id (contact_id)
266 FROM civicrm_group_contact_cache c
267 WHERE c.group_id = {$groupDAO->id}
269 $mailingGroup->query($smartGroupExclude);
272 $tempColumn = 'email_id';
273 if ($mode == 'sms') {
274 $tempColumn = 'phone_id';
277 // Get all the group contacts we want to include.
279 $mailingGroup->query(
280 "CREATE TEMPORARY TABLE I_$job_id
281 ($tempColumn int, contact_id int primary key)
285 // Get the group contacts, but only those which are not in the
286 // exclusion temp table.
288 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
290 SELECT DISTINCT $email.id as email_id,
291 $contact.id as contact_id
294 ON $email.contact_id = $contact.id
295 INNER JOIN $g2contact
296 ON $contact.id = $g2contact.contact_id
298 ON $g2contact.group_id = $mg.entity_id
299 AND $mg.entity_table = '$group'
301 ON $contact.id = X_$job_id.contact_id
303 ($mg.group_type = 'Include')
304 AND $mg.search_id IS NULL
305 AND $g2contact.status = 'Added'
306 AND $contact.do_not_email = 0
307 AND $contact.is_opt_out = 0
308 AND $contact.is_deceased <> 1
310 AND $email.email IS NOT NULL
311 AND $email.email != ''
312 AND $email.on_hold = 0
313 AND $mg.mailing_id = {$mailing_id}
314 AND X_$job_id.contact_id IS null
317 if ($mode == 'sms') {
318 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
319 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
321 SELECT DISTINCT $phone.id as phone_id,
322 $contact.id as contact_id
325 ON $phone.contact_id = $contact.id
326 INNER JOIN $g2contact
327 ON $contact.id = $g2contact.contact_id
329 ON $g2contact.group_id = $mg.entity_id
330 AND $mg.entity_table = '$group'
332 ON $contact.id = X_$job_id.contact_id
334 ($mg.group_type = 'Include')
335 AND $mg.search_id IS NULL
336 AND $g2contact.status = 'Added'
337 AND $contact.do_not_sms = 0
338 AND $contact.is_opt_out = 0
339 AND $contact.is_deceased <> 1
340 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
341 AND $phone.phone IS NOT NULL
342 AND $phone.phone != ''
343 AND $mg.mailing_id = {$mailing_id}
344 AND X_$job_id.contact_id IS null";
346 $mailingGroup->query($query);
348 // Query prior mailings.
350 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
351 SELECT DISTINCT $email.id as email_id,
352 $contact.id as contact_id
355 ON $email.contact_id = $contact.id
357 ON $eq.contact_id = $contact.id
359 ON $eq.job_id = $job.id
361 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
363 ON $contact.id = X_$job_id.contact_id
365 ($mg.group_type = 'Include')
366 AND $contact.do_not_email = 0
367 AND $contact.is_opt_out = 0
368 AND $contact.is_deceased <> 1
370 AND $email.on_hold = 0
371 AND $mg.mailing_id = {$mailing_id}
372 AND X_$job_id.contact_id IS null
375 if ($mode == 'sms') {
376 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
377 SELECT DISTINCT $phone.id as phone_id,
378 $contact.id as contact_id
381 ON $phone.contact_id = $contact.id
383 ON $eq.contact_id = $contact.id
385 ON $eq.job_id = $job.id
387 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
389 ON $contact.id = X_$job_id.contact_id
391 ($mg.group_type = 'Include')
392 AND $contact.do_not_sms = 0
393 AND $contact.is_opt_out = 0
394 AND $contact.is_deceased <> 1
395 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
396 AND $mg.mailing_id = {$mailing_id}
397 AND X_$job_id.contact_id IS null";
399 $mailingGroup->query($query);
402 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
404 INNER JOIN $mg ON $mg.entity_id = $group.id
405 WHERE $mg.entity_table = '$group'
406 AND $mg.group_type = 'Include'
407 AND $mg.search_id IS NULL
408 AND $mg.mailing_id = {$mailing_id}
409 AND ( saved_search_id != 0
410 OR saved_search_id IS NOT NULL
411 OR children IS NOT NULL )
414 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
415 while ($groupDAO->fetch()) {
416 if ($groupDAO->cache_date
== NULL) {
417 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
420 $smartGroupInclude = "
421 REPLACE INTO I_$job_id (email_id, contact_id)
422 SELECT civicrm_email.id as email_id, c.id as contact_id
423 FROM civicrm_contact c
424 INNER JOIN civicrm_email ON civicrm_email.contact_id = c.id
425 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
426 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
427 WHERE gc.group_id = {$groupDAO->id}
428 AND c.do_not_email = 0
430 AND c.is_deceased <> 1
432 AND civicrm_email.on_hold = 0
433 AND X_$job_id.contact_id IS null
436 if ($mode == 'sms') {
437 $smartGroupInclude = "
438 REPLACE INTO I_$job_id (phone_id, contact_id)
439 SELECT p.id as phone_id, c.id as contact_id
440 FROM civicrm_contact c
441 INNER JOIN civicrm_phone p ON p.contact_id = c.id
442 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
443 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
444 WHERE gc.group_id = {$groupDAO->id}
447 AND c.is_deceased <> 1
448 AND p.phone_type_id = {$phoneTypes['Mobile']}
449 AND X_$job_id.contact_id IS null";
451 $mailingGroup->query($smartGroupInclude);
454 // Construct the filtered search queries.
456 SELECT search_id, search_args, entity_id
458 WHERE $mg.search_id IS NOT NULL
459 AND $mg.mailing_id = {$mailing_id}
461 $dao = CRM_Core_DAO
::executeQuery($query);
462 while ($dao->fetch()) {
463 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
467 $query = "REPLACE INTO I_$job_id ({$tempColumn}, contact_id)
469 $mailingGroup->query($query);
472 // Get the emails with only location override.
474 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
475 SELECT DISTINCT $email.id as local_email_id,
476 $contact.id as contact_id
479 ON $email.contact_id = $contact.id
480 INNER JOIN $g2contact
481 ON $contact.id = $g2contact.contact_id
483 ON $g2contact.group_id = $mg.entity_id
485 ON $contact.id = X_$job_id.contact_id
487 $mg.entity_table = '$group'
488 AND $mg.group_type = 'Include'
489 AND $g2contact.status = 'Added'
490 AND $contact.do_not_email = 0
491 AND $contact.is_opt_out = 0
492 AND $contact.is_deceased <> 1
494 AND $email.on_hold = 0
495 AND $mg.mailing_id = {$mailing_id}
496 AND X_$job_id.contact_id IS null
498 if ($mode == "sms") {
499 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
500 SELECT DISTINCT $phone.id as phone_id,
501 $contact.id as contact_id
504 ON $phone.contact_id = $contact.id
505 INNER JOIN $g2contact
506 ON $contact.id = $g2contact.contact_id
508 ON $g2contact.group_id = $mg.entity_id
510 ON $contact.id = X_$job_id.contact_id
512 $mg.entity_table = '$group'
513 AND $mg.group_type = 'Include'
514 AND $g2contact.status = 'Added'
515 AND $contact.do_not_sms = 0
516 AND $contact.is_opt_out = 0
517 AND $contact.is_deceased <> 1
518 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
519 AND $mg.mailing_id = {$mailing_id}
520 AND X_$job_id.contact_id IS null";
522 $mailingGroup->query($query);
524 $eq = new CRM_Mailing_Event_BAO_Queue();
526 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
527 $aclWhere = $aclWhere ?
"WHERE {$aclWhere}" : '';
529 if ($storeRecipients && $mailing_id) {
532 FROM civicrm_mailing_recipients
533 WHERE mailing_id = %1
535 $params = array(1 => array($mailing_id, 'Integer'));
536 CRM_Core_DAO
::executeQuery($sql, $params);
539 $groupBy = $groupJoin = '';
541 $groupJoin = " INNER JOIN civicrm_email e ON e.id = i.email_id";
542 $groupBy = " GROUP BY e.email ";
546 INSERT INTO civicrm_mailing_recipients ( mailing_id, contact_id, {$tempColumn} )
547 SELECT %1, i.contact_id, i.{$tempColumn}
548 FROM civicrm_contact contact_a
549 INNER JOIN I_$job_id i ON contact_a.id = i.contact_id
554 ORDER BY i.contact_id, i.{$tempColumn}
557 CRM_Core_DAO
::executeQuery($sql, $params);
559 // if we need to add all emails marked bulk, do it as a post filter
560 // on the mailing recipients table
561 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
562 self
::addMultipleEmails($mailing_id);
566 // Delete the temp table.
568 $mailingGroup->reset();
569 $mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
570 $mailingGroup->query("DROP TEMPORARY TABLE I_$job_id");
576 * @param string $type
580 private function _getMailingGroupIds($type = 'Include') {
581 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
582 $group = CRM_Contact_DAO_Group
::getTableName();
583 if (!isset($this->id
)) {
584 // we're just testing tokens, so return any group
585 $query = "SELECT id AS entity_id
591 $query = "SELECT entity_id
593 WHERE mailing_id = {$this->id}
594 AND group_type = '$type'
595 AND entity_table = '$group'";
597 $mailingGroup->query($query);
600 while ($mailingGroup->fetch()) {
601 $groupIds[] = $mailingGroup->entity_id
;
608 * Returns the regex patterns that are used for preparing the text and html templates.
610 private function getPatterns($onlyHrefs = FALSE) {
614 $protos = '(https?|ftp)';
616 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
618 $any = "{$letters}{$gunk}{$punc}";
620 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
623 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
626 $patterns[] = $pattern;
627 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
628 $patterns[] = '\{\w+\.\w+\}';
630 $patterns = '{' . implode('|', $patterns) . '}im';
636 * Returns an array that denotes the type of token that we are dealing with
637 * we use the type later on when we are doing a token replacement lookup
639 * @param string $token
640 * The token for which we will be doing adata lookup.
643 * An array that holds the token itself and the type.
644 * the type will tell us which function to use for the data lookup
645 * if we need to do a lookup at all
647 public function &getDataFunc($token) {
648 static $_categories = NULL;
649 static $_categoryString = NULL;
651 $_categories = array(
658 CRM_Utils_Hook
::tokens($_categories);
659 $_categoryString = implode('|', array_keys($_categories));
662 $funcStruct = array('type' => NULL, 'token' => $token);
664 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
665 // it is a url so we need to check to see if there are any tokens embedded
666 // if so then call this function again to get the token dataFunc
667 // and assign the type 'embedded' so that the data retrieving function
668 // will know what how to handle this token.
669 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
670 $funcStruct['type'] = 'embedded_url';
671 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
672 foreach ($matches[1] as $match) {
673 $preg_token = '/' . preg_quote($match, '/') . '/';
674 $list = preg_split($preg_token, $token, 2);
675 $funcStruct['embed_parts'][] = $list[0];
677 $funcStruct['token'][] = $this->getDataFunc($match);
679 // fixed truncated url, CRM-7113
681 $funcStruct['embed_parts'][] = $token;
685 $funcStruct['type'] = 'url';
688 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
689 $funcStruct['type'] = $matches[1];
690 $funcStruct['token'] = $matches[2];
692 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
693 // we are an escaped token
694 // so remove the escape chars
695 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
696 $funcStruct['token'] = '{' . $unescaped_token . '}';
703 * Prepares the text and html templates
704 * for generating the emails and returns a copy of the
707 private function getPreparedTemplates() {
708 if (!$this->preparedTemplates
) {
709 $patterns['html'] = $this->getPatterns(TRUE);
710 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
711 $templates = $this->getTemplates();
713 $this->preparedTemplates
= array();
720 if (!isset($templates[$key])) {
726 $split_template = array();
728 $email = $templates[$key];
729 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
730 foreach ($matches[0] as $idx => $token) {
731 $preg_token = '/' . preg_quote($token, '/') . '/im';
732 list($split_template[], $email) = preg_split($preg_token, $email, 2);
733 array_push($tokens, $this->getDataFunc($token));
736 $split_template[] = $email;
738 $this->preparedTemplates
[$key]['template'] = $split_template;
739 $this->preparedTemplates
[$key]['tokens'] = $tokens;
742 return ($this->preparedTemplates
);
746 * Retrieve a ref to an array that holds the email and text templates for this email
747 * assembles the complete template including the header and footer
748 * that the user has uploaded or declared (if they have dome that)
751 * reference to an assoc array
753 private function &getTemplates() {
754 if (!$this->templates
) {
755 $this->getHeaderFooter();
756 $this->templates
= array();
758 if ($this->body_text
) {
761 $template[] = $this->header
->body_text
;
764 $template[] = $this->body_text
;
767 $template[] = $this->footer
->body_text
;
770 $this->templates
['text'] = implode("\n", $template);
773 if ($this->body_html
) {
777 $template[] = $this->header
->body_html
;
780 $template[] = $this->body_html
;
783 $template[] = $this->footer
->body_html
;
786 $this->templates
['html'] = implode("\n", $template);
788 // this is where we create a text template from the html template if the text template did not exist
789 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
790 // user uploads an html email only
791 if (!$this->body_text
) {
792 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
796 if ($this->subject
) {
798 $template[] = $this->subject
;
799 $this->templates
['subject'] = implode("\n", $template);
802 return $this->templates
;
807 * Retrieve a ref to an array that holds all of the tokens in the email body
808 * where the keys are the type of token and the values are ordinal arrays
809 * that hold the token names (even repeated tokens) in the order in which
810 * they appear in the body of the email.
812 * note: the real work is done in the _getTokens() function
814 * this function needs to have some sort of a body assigned
815 * either text or html for this to have any meaningful impact
818 * reference to an assoc array
820 public function &getTokens() {
821 if (!$this->tokens
) {
823 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
825 if ($this->body_html
) {
826 $this->_getTokens('html');
827 if (!$this->body_text
) {
828 // Since the text template was created from html, use the html tokens.
829 // @see CRM_Mailing_BAO_Mailing::getTemplates()
830 $this->tokens
['text'] = $this->tokens
['html'];
834 if ($this->body_text
) {
835 $this->_getTokens('text');
838 if ($this->subject
) {
839 $this->_getTokens('subject');
843 return $this->tokens
;
847 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
848 * hook in one call and standardizes it across other token workflows
851 * reference to an assoc array
853 public function &getFlattenedTokens() {
854 if (!$this->flattenedTokens
) {
855 $tokens = $this->getTokens();
857 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
860 return $this->flattenedTokens
;
865 * _getTokens parses out all of the tokens that have been
866 * included in the html and text bodies of the email
867 * we get the tokens and then separate them into an
868 * internal structure named tokens that has the same
869 * form as the static tokens property(?) of the CRM_Utils_Token class.
870 * The difference is that there might be repeated token names as we want the
871 * structures to represent the order in which tokens were found from left to right, top to bottom.
874 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
875 * Name of the property that holds the text that we want to scan for tokens (html, text).
879 private function _getTokens($prop) {
880 $templates = $this->getTemplates();
882 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
884 foreach ($newTokens as $type => $names) {
885 if (!isset($this->tokens
[$prop][$type])) {
886 $this->tokens
[$prop][$type] = array();
888 foreach ($names as $key => $name) {
889 $this->tokens
[$prop][$type][] = $name;
895 * Generate an event queue for a test job.
897 * @param array $testParams
898 * Contains form values.
902 public function getTestRecipients($testParams) {
903 if (array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
904 $contacts = civicrm_api('contact', 'get', array(
906 'group' => $testParams['test_group'],
909 'limit' => 100000000000,
914 foreach (array_keys($contacts['values']) as $groupContact) {
916 SELECT civicrm_email.id AS email_id,
917 civicrm_email.is_primary as is_primary,
918 civicrm_email.is_bulkmail as is_bulkmail
920 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
921 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
922 AND civicrm_contact.id = {$groupContact}
923 AND civicrm_contact.do_not_email = 0
924 AND civicrm_contact.is_deceased <> 1
925 AND civicrm_email.on_hold = 0
926 AND civicrm_contact.is_opt_out = 0
927 GROUP BY civicrm_email.id
928 ORDER BY civicrm_email.is_bulkmail DESC
930 $dao = CRM_Core_DAO
::executeQuery($query);
933 'job_id' => $testParams['job_id'],
934 'email_id' => $dao->email_id
,
935 'contact_id' => $groupContact,
937 CRM_Mailing_Event_BAO_Queue
::create($params);
944 * Load this->header and this->footer.
946 private function getHeaderFooter() {
947 if (!$this->header
and $this->header_id
) {
948 $this->header
= new CRM_Mailing_BAO_Component();
949 $this->header
->id
= $this->header_id
;
950 $this->header
->find(TRUE);
951 $this->header
->free();
954 if (!$this->footer
and $this->footer_id
) {
955 $this->footer
= new CRM_Mailing_BAO_Component();
956 $this->footer
->id
= $this->footer_id
;
957 $this->footer
->find(TRUE);
958 $this->footer
->free();
963 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
964 * add a Message-ID header if needed.
966 * i.e. if the global includeMessageId is set and there isn't already a
967 * Message-ID in the array.
968 * The message ID is structured the same way as a verp. However no interpretation
969 * is placed on the values received, so they do not need to follow the verp
972 * @param array $headers
973 * Array of message headers to update, in-out.
974 * @param string $prefix
975 * Prefix for the message ID, use same prefixes as verp.
977 * @param string $job_id
978 * Job ID component of the generated message ID.
979 * @param string $event_queue_id
980 * Event Queue ID component of the generated message ID.
981 * @param string $hash
982 * Hash component of the generated message ID.
986 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
987 $config = CRM_Core_Config
::singleton();
988 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
989 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
990 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
992 if ($includeMessageId && (!array_key_exists('Message-ID', $headers))) {
993 $headers['Message-ID'] = '<' . implode($config->verpSeparator
,
995 $localpart . $prefix,
1000 ) . "@{$emailDomain}>";
1005 * Static wrapper for getting verp and urls.
1007 * @param int $job_id
1008 * ID of the Job associated with this message.
1009 * @param int $event_queue_id
1010 * ID of the EventQueue.
1011 * @param string $hash
1012 * Hash of the EventQueue.
1013 * @param string $email
1014 * Destination address.
1017 * (reference) array array ref that hold array refs to the verp info and urls
1019 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
1020 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
1021 $config = CRM_Core_Config
::singleton();
1022 $bao = new CRM_Mailing_BAO_Mailing();
1023 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
1024 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
1026 // use $bao's instance method to get verp and urls
1027 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
1028 return array($verp, $urls);
1032 * Get verp, urls and headers
1034 * @param int $job_id
1035 * ID of the Job associated with this message.
1036 * @param int $event_queue_id
1037 * ID of the EventQueue.
1038 * @param string $hash
1039 * Hash of the EventQueue.
1040 * @param string $email
1041 * Destination address.
1043 * @param bool $isForward
1046 * array ref that hold array refs to the verp info, urls, and headers
1048 private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
1049 $config = CRM_Core_Config
::singleton();
1052 * Inbound VERP keys:
1053 * reply: user replied to mailing
1054 * bounce: email address bounced
1055 * unsubscribe: contact opts out of all target lists for the mailing
1056 * resubscribe: contact opts back into all target lists for the mailing
1057 * optOut: contact unsubscribes from the domain
1060 $verpTokens = array(
1063 'unsubscribe' => 'u',
1064 'resubscribe' => 'e',
1068 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1069 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1071 foreach ($verpTokens as $key => $value) {
1072 $verp[$key] = implode($config->verpSeparator
,
1074 $localpart . $value,
1079 ) . "@$emailDomain";
1082 //handle should override VERP address.
1083 $skipEncode = FALSE;
1086 self
::overrideVerp($job_id)
1088 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
1092 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
1093 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1094 TRUE, NULL, TRUE, TRUE
1096 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
1097 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1098 TRUE, NULL, TRUE, TRUE
1100 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
1101 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1102 TRUE, NULL, TRUE, TRUE
1104 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1105 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1106 TRUE, NULL, TRUE, TRUE
1108 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1110 TRUE, NULL, TRUE, TRUE
1115 'Reply-To' => $verp['reply'],
1116 'Return-Path' => $verp['bounce'],
1117 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1118 'Subject' => $this->subject
,
1119 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1121 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1123 $headers['Subject'] = "[Fwd:{$this->subject}]";
1125 return array(&$verp, &$urls, &$headers);
1129 * Compose a message.
1131 * @param int $job_id
1132 * ID of the Job associated with this message.
1133 * @param int $event_queue_id
1134 * ID of the EventQueue.
1135 * @param string $hash
1136 * Hash of the EventQueue.
1137 * @param string $contactId
1138 * ID of the Contact.
1139 * @param string $email
1140 * Destination address.
1141 * @param string $recipient
1142 * To: of the recipient.
1144 * Is this mailing a test?.
1145 * @param $contactDetails
1146 * @param $attachments
1147 * @param bool $isForward
1148 * Is this mailing compose for forward?.
1149 * @param string $fromEmail
1150 * Email address of who is forwardinf it.
1152 * @param null $replyToEmail
1154 * @return Mail_mime The mail object
1156 public function compose(
1157 $job_id, $event_queue_id, $hash, $contactId,
1158 $email, &$recipient, $test,
1159 $contactDetails, &$attachments, $isForward = FALSE,
1160 $fromEmail = NULL, $replyToEmail = NULL
1162 $config = CRM_Core_Config
::singleton();
1165 if ($this->_domain
== NULL) {
1166 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1169 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1177 //set from email who is forwarding it and not original one.
1179 unset($headers['From']);
1180 $headers['From'] = "<{$fromEmail}>";
1183 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1184 $headers['Reply-To'] = "{$replyToEmail}";
1187 if ($contactDetails) {
1188 $contact = $contactDetails;
1190 elseif ($contactId === 0) {
1193 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1196 $params = array(array('contact_id', '=', $contactId, 0, 0));
1197 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1200 $contact = reset($contact);
1202 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1203 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1204 array(1 => $contactId)
1206 // setting this because function is called by reference
1207 //@todo test not calling function by reference
1212 // also call the hook to get contact details
1213 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1216 $pTemplates = $this->getPreparedTemplates();
1219 foreach ($pTemplates as $type => $pTemplate) {
1220 $html = ($type == 'html') ?
TRUE : FALSE;
1221 $pEmails[$type] = array();
1222 $pEmail = &$pEmails[$type];
1223 $template = &$pTemplates[$type]['template'];
1224 $tokens = &$pTemplates[$type]['tokens'];
1226 if (!empty($tokens)) {
1227 foreach ($tokens as $idx => $token) {
1228 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1229 array_push($pEmail, $template[$idx]);
1230 array_push($pEmail, $token_data);
1234 array_push($pEmail, $template[$idx]);
1237 if (isset($template[($idx +
1)])) {
1238 array_push($pEmail, $template[($idx +
1)]);
1243 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1244 $html = &$pEmails['html'];
1248 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1249 $text = &$pEmails['text'];
1252 // push the tracking url on to the html email if necessary
1253 if ($this->open_tracking
&& $html) {
1254 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1255 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1259 $message = new Mail_mime("\n");
1261 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1263 $smarty = CRM_Core_Smarty
::singleton();
1264 // also add the contact tokens to the template
1265 $smarty->assign_by_ref('contact', $contact);
1268 $mailParams = $headers;
1269 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1270 $contact['preferred_mail_format'] == 'Both' ||
1271 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1274 $textBody = implode('', $text);
1276 $textBody = $smarty->fetch("string:$textBody");
1278 $mailParams['text'] = $textBody;
1281 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1282 $contact['preferred_mail_format'] == 'Both'
1285 $htmlBody = implode('', $html);
1287 $htmlBody = $smarty->fetch("string:$htmlBody");
1289 $mailParams['html'] = $htmlBody;
1292 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1294 // something went wrong, lets log it and return null (by reference)
1295 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1302 $mailParams['attachments'] = $attachments;
1304 $mailingSubject = CRM_Utils_Array
::value('subject', $pEmails);
1305 if (is_array($mailingSubject)) {
1306 $mailingSubject = implode('', $mailingSubject);
1308 $mailParams['Subject'] = $mailingSubject;
1310 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1313 $mailParams['toEmail'] = $email;
1315 // Add job ID to mailParams for external email delivery service to utilise
1316 $mailParams['job_id'] = $job_id;
1318 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1320 // CRM-10699 support custom email headers
1321 if (!empty($mailParams['headers'])) {
1322 $headers = array_merge($headers, $mailParams['headers']);
1324 //cycle through mailParams and set headers array
1325 foreach ($mailParams as $paramKey => $paramValue) {
1326 //exclude values not intended for the header
1327 if (!in_array($paramKey, array(
1335 $headers[$paramKey] = $paramValue;
1339 if (!empty($mailParams['text'])) {
1340 $message->setTxtBody($mailParams['text']);
1343 if (!empty($mailParams['html'])) {
1344 $message->setHTMLBody($mailParams['html']);
1347 if (!empty($mailParams['attachments'])) {
1348 foreach ($mailParams['attachments'] as $fileID => $attach) {
1349 $message->addAttachment($attach['fullPath'],
1350 $attach['mime_type'],
1351 $attach['cleanName']
1356 //pickup both params from mail params.
1357 $toName = trim($mailParams['toName']);
1358 $toEmail = trim($mailParams['toEmail']);
1359 if ($toName == $toEmail ||
1360 strpos($toName, '@') !== FALSE
1365 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1368 $headers['To'] = "$toName <$toEmail>";
1370 $headers['Precedence'] = 'bulk';
1371 // Will test in the mail processor if the X-VERP is set in the bounced email.
1372 // (As an option to replace real VERP for those that can't set it up)
1373 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1376 //token replacement of subject
1377 $headers['Subject'] = $mailingSubject;
1379 CRM_Utils_Mail
::setMimeParams($message);
1380 $headers = $message->headers($headers);
1382 //get formatted recipient
1383 $recipient = $headers['To'];
1385 // make sure we unset a lot of stuff
1397 * get mailing object and replaces subscribeInvite,
1398 * domain and mailing tokens
1400 public static function tokenReplace(&$mailing) {
1401 $domain = CRM_Core_BAO_Domain
::getDomain();
1403 foreach (array('text', 'html') as $type) {
1404 $tokens = $mailing->getTokens();
1405 if (isset($mailing->templates
[$type])) {
1406 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1407 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1408 $mailing->templates
[$type],
1410 $type == 'html' ?
TRUE : FALSE,
1413 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1420 * getTokenData receives a token from an email
1421 * and returns the appropriate data for the token
1423 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1424 $type = $token_a['type'];
1425 $token = $token_a['token'];
1428 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1430 if ($type == 'embedded_url') {
1431 $embed_data = array();
1432 foreach ($token as $t) {
1433 $embed_data[] = $this->getTokenData($t, $html = FALSE, $contact, $verp, $urls, $event_queue_id);
1435 $numSlices = count($embed_data);
1437 for ($i = 0; $i < $numSlices; $i++
) {
1438 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1440 if (isset($token_a['embed_parts'][$numSlices])) {
1441 $url .= $token_a['embed_parts'][$numSlices];
1443 // add trailing quote since we've gobbled it up in a previous regex
1444 // function getPatterns, line 431
1445 if (preg_match('/^href[ ]*=[ ]*\'/', $url)) {
1448 elseif (preg_match('/^href[ ]*=[ ]*\"/', $url)) {
1453 elseif ($type == 'url') {
1454 if ($this->url_tracking
) {
1455 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1456 if (!empty($html)) {
1457 $data = htmlentities($data, ENT_NOQUOTES
);
1464 elseif ($type == 'contact') {
1465 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1467 elseif ($type == 'action') {
1468 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1470 elseif ($type == 'domain') {
1471 $domain = CRM_Core_BAO_Domain
::getDomain();
1472 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1474 elseif ($type == 'mailing') {
1475 if ($token == 'name') {
1476 $data = $this->name
;
1478 elseif ($token == 'group') {
1479 $groups = $this->getGroupNames();
1480 $data = implode(', ', $groups);
1484 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1490 * Return a list of group names for this mailing. Does not work with
1491 * prior-mailing targets.
1494 * Names of groups receiving this mailing
1496 public function &getGroupNames() {
1497 if (!isset($this->id
)) {
1500 $mg = new CRM_Mailing_DAO_MailingGroup();
1501 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1502 $group = CRM_Contact_BAO_Group
::getTableName();
1504 $mg->query("SELECT $group.title as name FROM $mgtable
1505 INNER JOIN $group ON $mgtable.entity_id = $group.id
1506 WHERE $mgtable.mailing_id = {$this->id}
1507 AND $mgtable.entity_table = '$group'
1508 AND $mgtable.group_type = 'Include'
1509 ORDER BY $group.name");
1512 while ($mg->fetch()) {
1513 $groups[] = $mg->name
;
1522 * @param array $params
1523 * Reference array contains the values submitted by the form.
1525 * Reference array contains the id.
1528 * @return CRM_Mailing_DAO_Mailing
1530 public static function add(&$params, $ids = array()) {
1531 $id = CRM_Utils_Array
::value('mailing_id', $ids, CRM_Utils_Array
::value('id', $params));
1534 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1537 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1540 $mailing = new static();
1543 $mailing->find(TRUE);
1545 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1547 if (!isset($params['replyto_email']) &&
1548 isset($params['from_email'])
1550 $params['replyto_email'] = $params['from_email'];
1553 $mailing->copyValues($params);
1555 $result = $mailing->save();
1557 if (!empty($ids['mailing'])) {
1558 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1561 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1568 * Construct a new mailing object, along with job and mailing_group
1569 * objects, from the form values of the create mailing wizard.
1571 * This function is a bit evil. It not only merges $params and saves
1572 * the mailing -- it also schedules the mailing and chooses the recipients.
1573 * Since it merges $params, it's also the only place to correctly trigger
1574 * multi-field validation. It should be broken up.
1576 * In the mean time, use-cases which break under the weight of this
1577 * evil may find reprieve in these extra evil params:
1579 * - _skip_evil_bao_auto_recipients_: bool
1580 * - _skip_evil_bao_auto_schedule_: bool
1581 * - _evil_bao_validator_: string|callable
1583 * </twowrongsmakesaright>
1585 * @params array $params
1588 * @param array $params
1592 * $mailing The new mailing object
1593 * @throws \Exception
1595 public static function create(&$params, $ids = array()) {
1597 if (empty($ids) && isset($params['id'])) {
1598 $ids['mailing_id'] = $ids['id'] = $params['id'];
1602 // Do the below only for an insert
1603 // for an update, we should not set the defaults
1604 if (!isset($ids['id']) && !isset($ids['mailing_id'])) {
1605 // Retrieve domain email and name for default sender
1606 $domain = civicrm_api(
1611 'current_domain' => 1,
1615 if (isset($domain['from_email'])) {
1616 $domain_email = $domain['from_email'];
1617 $domain_name = $domain['from_name'];
1620 $domain_email = 'info@EXAMPLE.ORG';
1621 $domain_name = 'EXAMPLE.ORG';
1623 if (!isset($params['created_id'])) {
1624 $session =& CRM_Core_Session
::singleton();
1625 $params['created_id'] = $session->get('userID');
1628 // load the default config settings for each
1629 // eg reply_id, unsubscribe_id need to use
1630 // correct template IDs here
1631 'override_verp' => TRUE,
1632 'forward_replies' => FALSE,
1633 'open_tracking' => TRUE,
1634 'url_tracking' => TRUE,
1635 'visibility' => 'Public Pages',
1636 'replyto_email' => $domain_email,
1637 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1638 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1639 'from_email' => $domain_email,
1640 'from_name' => $domain_name,
1641 'msg_template_id' => NULL,
1642 'created_id' => $params['created_id'],
1643 'approver_id' => NULL,
1644 'auto_responder' => 0,
1645 'created_date' => date('YmdHis'),
1646 'scheduled_date' => NULL,
1647 'approval_date' => NULL,
1650 // Get the default from email address, if not provided.
1651 if (empty($defaults['from_email'])) {
1652 $defaultAddress = CRM_Core_OptionGroup
::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
1653 foreach ($defaultAddress as $id => $value) {
1654 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1655 $defaults['from_email'] = $match[2];
1656 $defaults['from_name'] = $match[1];
1661 $params = array_merge($defaults, $params);
1665 * Could check and warn for the following cases:
1667 * - groups OR mailings should be populated.
1668 * - body html OR body text should be populated.
1671 $transaction = new CRM_Core_Transaction();
1673 $mailing = self
::add($params, $ids);
1675 if (is_a($mailing, 'CRM_Core_Error')) {
1676 $transaction->rollback();
1679 // update mailings with hash values
1680 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1682 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1683 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
1685 /* Create the mailing group record */
1686 $mg = new CRM_Mailing_DAO_MailingGroup();
1687 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1688 foreach (array('groups', 'mailings') as $entity) {
1689 foreach (array('include', 'exclude', 'base') as $type) {
1690 if (isset($params[$entity][$type])) {
1691 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1696 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1698 $mg->mailing_id
= $mailing->id
;
1699 $mg->entity_table
= $groupTableName;
1700 $mg->entity_id
= $params['group_id'];
1701 $mg->search_id
= $params['search_id'];
1702 $mg->search_args
= $params['search_args'];
1703 $mg->group_type
= 'Include';
1707 // check and attach and files as needed
1708 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1710 // If we're going to autosend, then check validity before saving.
1711 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1712 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1713 $errors = call_user_func($cb, $mailing);
1714 if (!empty($errors)) {
1715 $fields = implode(',', array_keys($errors));
1716 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1720 $transaction->commit();
1722 // Create parent job if not yet created.
1723 // Condition on the existence of a scheduled date.
1724 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1725 $job = new CRM_Mailing_BAO_MailingJob();
1726 $job->mailing_id
= $mailing->id
;
1727 $job->status
= 'Scheduled';
1730 if (!$job->find(TRUE)) {
1731 $job->scheduled_date
= $params['scheduled_date'];
1735 // Populate the recipients.
1736 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1737 self
::getRecipients($job->id
, $mailing->id
, TRUE, $mailing->dedupe_email
);
1745 * @param CRM_Mailing_DAO_Mailing $mailing
1746 * The mailing which may or may not be sendable.
1748 * List of error messages.
1750 public static function checkSendable($mailing) {
1752 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1753 if (empty($mailing->{$field})) {
1754 $errors[$field] = ts('Field "%1" is required.', array(
1759 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1760 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1763 if (!CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'disable_mandatory_tokens_check')) {
1764 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->header_id
) : NULL;
1765 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->footer_id
) : NULL;
1766 foreach (array('body_html', 'body_text') as $field) {
1767 if (empty($mailing->{$field})) {
1770 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1771 $err = CRM_Utils_Token
::requiredTokens($str);
1772 if ($err !== TRUE) {
1773 foreach ($err as $token => $desc) {
1774 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1775 array(1 => $token, 2 => $desc)
1786 * Replace the list of recipients on a given mailing.
1788 * @param int $mailingId
1789 * @param string $type
1790 * 'include' or 'exclude'.
1791 * @param string $entity
1792 * 'groups' or 'mailings'.
1793 * @param array <int> $entityIds
1794 * @throws CiviCRM_API3_Exception
1796 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1798 foreach ($entityIds as $entityId) {
1799 $values[] = array('entity_id' => $entityId);
1801 civicrm_api3('mailing_group', 'replace', array(
1802 'mailing_id' => $mailingId,
1803 'group_type' => $type,
1804 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1805 'values' => $values,
1810 * Get hash value of the mailing.
1814 * @return null|string
1816 public static function getMailingHash($id) {
1818 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'hash_mailing_url')) {
1819 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1825 * Generate a report. Fetch event count information, mailing data, and job
1829 * The mailing id to report.
1830 * @param bool $skipDetails
1831 * Whether return all detailed report.
1833 * @param bool $isSMS
1836 * Associative array of reporting data
1838 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1839 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1841 $mailing = new CRM_Mailing_BAO_Mailing();
1844 'mailing' => self
::getTableName(),
1845 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1846 'group' => CRM_Contact_BAO_Group
::getTableName(),
1847 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1848 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1849 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1850 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1851 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1852 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1853 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1854 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1855 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1856 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1857 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1858 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1862 $additionalWhereClause = " AND ";
1864 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1867 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1870 /* Get the mailing info */
1873 SELECT {$t['mailing']}.*
1874 FROM {$t['mailing']}
1875 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1879 $report['mailing'] = array();
1880 foreach (array_keys(self
::fields()) as $field) {
1881 $report['mailing'][$field] = $mailing->$field;
1885 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1886 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1887 $report['mailing']['campaign'] = $campaigns[$campaignId];
1890 //mailing report is called by activity
1891 //we dont need all detail report
1896 /* Get the component info */
1900 $components = array(
1901 'header' => ts('Header'),
1902 'footer' => ts('Footer'),
1903 'reply' => ts('Reply'),
1904 'unsubscribe' => ts('Unsubscribe'),
1905 'optout' => ts('Opt-Out'),
1907 foreach (array_keys($components) as $type) {
1908 $query[] = "SELECT {$t['component']}.name as name,
1910 {$t['component']}.id as id
1911 FROM {$t['component']}
1912 INNER JOIN {$t['mailing']}
1913 ON {$t['mailing']}.{$type}_id =
1914 {$t['component']}.id
1915 WHERE {$t['mailing']}.id = $mailing_id";
1917 $q = '(' . implode(') UNION (', $query) . ')';
1918 $mailing->query($q);
1920 $report['component'] = array();
1921 while ($mailing->fetch()) {
1922 $report['component'][] = array(
1923 'type' => $components[$mailing->type
],
1924 'name' => $mailing->name
,
1925 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1926 "reset=1&action=update&id={$mailing->id}"
1931 /* Get the recipient group info */
1934 SELECT {$t['mailing_group']}.group_type as group_type,
1935 {$t['group']}.id as group_id,
1936 {$t['group']}.title as group_title,
1937 {$t['group']}.is_hidden as group_hidden,
1938 {$t['mailing']}.id as mailing_id,
1939 {$t['mailing']}.name as mailing_name
1940 FROM {$t['mailing_group']}
1941 LEFT JOIN {$t['group']}
1942 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1943 AND {$t['mailing_group']}.entity_table =
1945 LEFT JOIN {$t['mailing']}
1946 ON {$t['mailing_group']}.entity_id =
1948 AND {$t['mailing_group']}.entity_table =
1951 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1954 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1955 while ($mailing->fetch()) {
1957 if (isset($mailing->group_id
)) {
1958 $row['id'] = $mailing->group_id
;
1959 $row['name'] = $mailing->group_title
;
1960 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1961 "reset=1&force=1&context=smog&gid={$row['id']}"
1965 $row['id'] = $mailing->mailing_id
;
1966 $row['name'] = $mailing->mailing_name
;
1967 $row['mailing'] = TRUE;
1968 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1973 /* Rename hidden groups */
1975 if ($mailing->group_hidden
== 1) {
1976 $row['name'] = "Search Results";
1979 if ($mailing->group_type
== 'Include') {
1980 $report['group']['include'][] = $row;
1982 elseif ($mailing->group_type
== 'Base') {
1983 $report['group']['base'][] = $row;
1986 $report['group']['exclude'][] = $row;
1990 /* Get the event totals, grouped by job (retries) */
1993 SELECT {$t['job']}.*,
1994 COUNT(DISTINCT {$t['queue']}.id) as queue,
1995 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1996 COUNT(DISTINCT {$t['reply']}.id) as reply,
1997 COUNT(DISTINCT {$t['forward']}.id) as forward,
1998 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1999 COUNT(DISTINCT {$t['urlopen']}.id) as url,
2000 COUNT(DISTINCT {$t['spool']}.id) as spool
2002 LEFT JOIN {$t['queue']}
2003 ON {$t['queue']}.job_id = {$t['job']}.id
2004 LEFT JOIN {$t['reply']}
2005 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
2006 LEFT JOIN {$t['forward']}
2007 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
2008 LEFT JOIN {$t['bounce']}
2009 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
2010 LEFT JOIN {$t['delivered']}
2011 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
2012 AND {$t['bounce']}.id IS null
2013 LEFT JOIN {$t['urlopen']}
2014 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2015 LEFT JOIN {$t['spool']}
2016 ON {$t['spool']}.job_id = {$t['job']}.id
2017 WHERE {$t['job']}.mailing_id = $mailing_id
2018 AND {$t['job']}.is_test = 0
2019 GROUP BY {$t['job']}.id");
2021 $report['jobs'] = array();
2022 $report['event_totals'] = array();
2037 // initialize various counters
2038 foreach ($elements as $field) {
2039 $report['event_totals'][$field] = 0;
2042 while ($mailing->fetch()) {
2044 foreach ($elements as $field) {
2045 if (isset($mailing->$field)) {
2046 $row[$field] = $mailing->$field;
2047 $report['event_totals'][$field] +
= $mailing->$field;
2051 // compute open total separately to discount duplicates
2053 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
2054 $report['event_totals']['opened'] +
= $row['opened'];
2055 $row['total_opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
);
2056 $report['event_totals']['total_opened'] +
= $row['total_opened'];
2058 // compute unsub total separately to discount duplicates
2060 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
2061 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
2063 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
2064 $report['event_totals']['optout'] +
= $row['optout'];
2066 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
2067 $row[$field] = $mailing->$field;
2070 if ($mailing->queue
) {
2071 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2072 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2073 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2074 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2077 $row['delivered_rate'] = 0;
2078 $row['bounce_rate'] = 0;
2079 $row['unsubscribe_rate'] = 0;
2080 $row['optout_rate'] = 0;
2083 $row['links'] = array(
2084 'clicks' => CRM_Utils_System
::url(
2085 'civicrm/mailing/report/event',
2086 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2088 'queue' => CRM_Utils_System
::url(
2089 'civicrm/mailing/report/event',
2090 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2092 'delivered' => CRM_Utils_System
::url(
2093 'civicrm/mailing/report/event',
2094 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2096 'bounce' => CRM_Utils_System
::url(
2097 'civicrm/mailing/report/event',
2098 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2100 'unsubscribe' => CRM_Utils_System
::url(
2101 'civicrm/mailing/report/event',
2102 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2104 'forward' => CRM_Utils_System
::url(
2105 'civicrm/mailing/report/event',
2106 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2108 'reply' => CRM_Utils_System
::url(
2109 'civicrm/mailing/report/event',
2110 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2112 'opened' => CRM_Utils_System
::url(
2113 'civicrm/mailing/report/event',
2114 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2123 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2125 $report['jobs'][] = $row;
2128 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2130 // we need to do this for backward compatibility, since old mailings did not
2131 // use the mailing_recipients table
2132 if ($newTableSize > 0) {
2133 $report['event_totals']['queue'] = $newTableSize;
2136 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id, $mailing_id);
2139 if (!empty($report['event_totals']['queue'])) {
2140 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2141 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2142 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2143 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2146 $report['event_totals']['delivered_rate'] = 0;
2147 $report['event_totals']['bounce_rate'] = 0;
2148 $report['event_totals']['unsubscribe_rate'] = 0;
2149 $report['event_totals']['optout_rate'] = 0;
2152 /* Get the click-through totals, grouped by URL */
2155 SELECT {$t['url']}.url,
2157 COUNT({$t['urlopen']}.id) as clicks,
2158 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2160 LEFT JOIN {$t['urlopen']}
2161 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2162 LEFT JOIN {$t['queue']}
2163 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2164 LEFT JOIN {$t['job']}
2165 ON {$t['queue']}.job_id = {$t['job']}.id
2166 WHERE {$t['url']}.mailing_id = $mailing_id
2167 AND {$t['job']}.is_test = 0
2168 GROUP BY {$t['url']}.id");
2170 $report['click_through'] = array();
2172 while ($mailing->fetch()) {
2173 $report['click_through'][] = array(
2174 'url' => $mailing->url
,
2175 'link' => CRM_Utils_System
::url(
2176 'civicrm/mailing/report/event',
2177 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2179 'link_unique' => CRM_Utils_System
::url(
2180 'civicrm/mailing/report/event',
2181 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2183 'clicks' => $mailing->clicks
,
2184 'unique' => $mailing->unique_clicks
,
2185 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2186 'report' => CRM_Report_Utils_Report
::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2190 $report['event_totals']['links'] = array(
2191 'clicks' => CRM_Utils_System
::url(
2192 'civicrm/mailing/report/event',
2193 "reset=1&event=click&mid=$mailing_id"
2195 'clicks_unique' => CRM_Utils_System
::url(
2196 'civicrm/mailing/report/event',
2197 "reset=1&event=click&mid=$mailing_id&distinct=1"
2199 'queue' => CRM_Utils_System
::url(
2200 'civicrm/mailing/report/event',
2201 "reset=1&event=queue&mid=$mailing_id"
2203 'delivered' => CRM_Utils_System
::url(
2204 'civicrm/mailing/report/event',
2205 "reset=1&event=delivered&mid=$mailing_id"
2207 'bounce' => CRM_Utils_System
::url(
2208 'civicrm/mailing/report/event',
2209 "reset=1&event=bounce&mid=$mailing_id"
2211 'unsubscribe' => CRM_Utils_System
::url(
2212 'civicrm/mailing/report/event',
2213 "reset=1&event=unsubscribe&mid=$mailing_id"
2215 'optout' => CRM_Utils_System
::url(
2216 'civicrm/mailing/report/event',
2217 "reset=1&event=optout&mid=$mailing_id"
2219 'forward' => CRM_Utils_System
::url(
2220 'civicrm/mailing/report/event',
2221 "reset=1&event=forward&mid=$mailing_id"
2223 'reply' => CRM_Utils_System
::url(
2224 'civicrm/mailing/report/event',
2225 "reset=1&event=reply&mid=$mailing_id"
2227 'opened' => CRM_Utils_System
::url(
2228 'civicrm/mailing/report/event',
2229 "reset=1&event=opened&mid=$mailing_id"
2233 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2234 if (CRM_Core_Permission
::check('view all contacts')) {
2235 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2236 'name' => ts('Advanced Search'),
2237 'url' => 'civicrm/contact/search/advanced',
2240 $action = array_sum(array_keys($actionLinks));
2242 $report['event_totals']['actionlinks'] = array();
2255 $url = 'mailing/detail';
2256 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2257 $searchFilter = "force=1&mailing_id=%%mid%%";
2260 $reportFilter .= "&delivery_status_value=successful";
2261 $searchFilter .= "&mailing_delivery_status=Y";
2265 $url = "mailing/bounce";
2266 $searchFilter .= "&mailing_delivery_status=N";
2270 $reportFilter .= "&is_forwarded_value=1";
2271 $searchFilter .= "&mailing_forward=1";
2275 $reportFilter .= "&is_replied_value=1";
2276 $searchFilter .= "&mailing_reply_status=Y";
2280 $reportFilter .= "&is_unsubscribed_value=1";
2281 $searchFilter .= "&mailing_unsubscribe=1";
2285 $reportFilter .= "&is_optout_value=1";
2286 $searchFilter .= "&mailing_optout=1";
2290 $url = "mailing/opened";
2291 $searchFilter .= "&mailing_open_status=Y";
2295 case 'clicks_unique':
2296 $url = "mailing/clicks";
2297 $searchFilter .= "&mailing_click_status=Y";
2300 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2301 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2302 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2304 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2307 array('mid' => $mailing_id),
2310 'mailing.report.action',
2320 * Get the count of mailings.
2327 public function getCount() {
2329 $this->selectAdd('COUNT(id) as count');
2331 $session = CRM_Core_Session
::singleton();
2334 return $this->count
;
2342 public static function checkPermission($id) {
2347 $mailingIDs = self
::mailingACLIDs();
2348 if ($mailingIDs === TRUE) {
2352 if (!in_array($id, $mailingIDs)) {
2353 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2358 * @param null $alias
2362 public static function mailingACL($alias = NULL) {
2363 $mailingACL = " ( 0 ) ";
2365 $mailingIDs = self
::mailingACLIDs();
2366 if ($mailingIDs === TRUE) {
2370 if (!empty($mailingIDs)) {
2371 $mailingIDs = implode(',', $mailingIDs);
2372 $tableName = !$alias ? self
::getTableName() : $alias;
2373 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2379 * Returns all the mailings that this user can access. This is dependent on
2380 * all the groups that the user has access to.
2381 * However since most civi installs dont use ACL's we special case the condition
2382 * where the user has access to ALL groups, and hence ALL mailings and return a
2383 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2385 * @return bool|array
2386 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2388 public static function mailingACLIDs() {
2390 // optimize common case where admin has access
2393 CRM_Core_Permission
::check('view all contacts') ||
2394 CRM_Core_Permission
::check('edit all contacts')
2399 $mailingIDs = array();
2401 // get all the groups that this user can access
2402 // if they dont have universal access
2403 $groupNames = civicrm_api3('Group', 'get', array(
2405 'check_permissions' => TRUE,
2406 'return' => array('title', 'id'),
2407 'options' => array('limit' => 0),
2409 foreach ($groupNames['values'] as $group) {
2410 $groups[$group['id']] = $group['title'];
2412 if (!empty($groups)) {
2413 $groupIDs = implode(',', array_keys($groups));
2414 $domain_id = CRM_Core_Config
::domainID();
2416 // get all the mailings that are in this subset of groups
2418 SELECT DISTINCT( m.id ) as id
2419 FROM civicrm_mailing m
2420 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2421 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2422 OR ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2424 $dao = CRM_Core_DAO
::executeQuery($query);
2426 $mailingIDs = array();
2427 while ($dao->fetch()) {
2428 $mailingIDs[] = $dao->id
;
2436 * Get the rows for a browse operation.
2438 * @param int $offset
2439 * The row number to start from.
2440 * @param int $rowCount
2441 * The nmber of rows to return.
2442 * @param string $sort
2443 * The sql string that describes the sort order.
2445 * @param null $additionalClause
2446 * @param array $additionalParams
2451 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2452 $mailing = self
::getTableName();
2453 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2454 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2455 $session = CRM_Core_Session
::singleton();
2457 $mailingACL = self
::mailingACL();
2459 //get all campaigns.
2460 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2462 // we only care about parent jobs, since that holds all the info on
2468 $mailing.approval_status_id,
2469 MIN($job.scheduled_date) as scheduled_date,
2470 MIN($job.start_date) as start_date,
2471 MAX($job.end_date) as end_date,
2472 createdContact.sort_name as created_by,
2473 scheduledContact.sort_name as scheduled_by,
2474 $mailing.created_id as created_id,
2475 $mailing.scheduled_id as scheduled_id,
2476 $mailing.is_archived as archived,
2477 $mailing.created_date as created_date,
2479 $mailing.sms_provider_id as sms_provider_id
2481 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2482 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2483 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2484 WHERE $mailingACL $additionalClause
2485 GROUP BY $mailing.id ";
2488 $orderBy = trim($sort->orderBy());
2489 if (!empty($orderBy)) {
2490 $query .= " ORDER BY $orderBy";
2495 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2496 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2498 $query .= " LIMIT $offset, $rowCount ";
2501 if (!$additionalParams) {
2502 $additionalParams = array();
2505 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2508 while ($dao->fetch()) {
2511 'name' => $dao->name
,
2512 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2513 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2514 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2515 'scheduled_iso' => $dao->scheduled_date
,
2516 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2517 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2518 'created_by' => $dao->created_by
,
2519 'scheduled_by' => $dao->scheduled_by
,
2520 'created_id' => $dao->created_id
,
2521 'scheduled_id' => $dao->scheduled_id
,
2522 'archived' => $dao->archived
,
2523 'approval_status_id' => $dao->approval_status_id
,
2524 'campaign_id' => $dao->campaign_id
,
2525 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2526 'sms_provider_id' => $dao->sms_provider_id
,
2533 * Show detail Mailing report.
2539 public static function showEmailDetails($id) {
2540 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2544 * Delete Mails and all its associated records.
2547 * Id of the mail to delete.
2551 public static function del($id) {
2553 CRM_Core_Error
::fatal();
2556 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2558 // delete all file attachments
2559 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2563 $dao = new CRM_Mailing_DAO_Mailing();
2567 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2569 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2573 * Delete Jobss and all its associated records
2574 * related to test Mailings
2577 * Id of the Job to delete.
2581 public static function delJob($id) {
2583 CRM_Core_Error
::fatal();
2586 $dao = new CRM_Mailing_BAO_MailingJob();
2594 public function getReturnProperties() {
2595 $tokens = &$this->getTokens();
2597 $properties = array();
2598 if (isset($tokens['html']) &&
2599 isset($tokens['html']['contact'])
2601 $properties = array_merge($properties, $tokens['html']['contact']);
2604 if (isset($tokens['text']) &&
2605 isset($tokens['text']['contact'])
2607 $properties = array_merge($properties, $tokens['text']['contact']);
2610 if (isset($tokens['subject']) &&
2611 isset($tokens['subject']['contact'])
2613 $properties = array_merge($properties, $tokens['subject']['contact']);
2616 $returnProperties = array();
2617 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2619 foreach ($properties as $p) {
2620 $returnProperties[$p] = 1;
2623 return $returnProperties;
2627 * Build the compose mail form.
2629 * @param CRM_Core_Form $form
2633 public static function commonCompose(&$form) {
2637 if (method_exists($form, 'listTokens')) {
2638 $tokens = array_merge($form->listTokens(), $tokens);
2641 //sorted in ascending order tokens by ignoring word case
2642 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2644 $templates = array();
2646 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2647 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2649 $className = CRM_Utils_System
::getClassName($form);
2651 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2652 $className != 'CRM_Contact_Form_Task_SMS'
2654 $form->add('wysiwyg', 'html_message',
2659 'onkeyup' => "return verify(this)",
2663 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2664 unset($modePrefixes['SMS']);
2668 unset($textFields['text_message']);
2669 unset($modePrefixes['Mail']);
2672 //insert message Text by selecting "Select Template option"
2673 foreach ($textFields as $id => $label) {
2675 if ($id == 'sms_text_message') {
2677 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2679 $form->add('textarea', $id, $label,
2683 'onkeyup' => "return verify(this, '{$prefix}')",
2688 foreach ($modePrefixes as $prefix) {
2689 if ($prefix == 'SMS') {
2690 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2693 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2695 if (!empty($templates[$prefix])) {
2696 $form->assign('templates', TRUE);
2698 $form->add('select', "{$prefix}template", ts('Use Template'),
2699 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2700 array('onChange' => "selectValue( this.value, '{$prefix}');")
2703 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2705 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2706 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2708 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2711 // I'm not sure this is ever called.
2712 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2713 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2714 $action == CRM_Core_Action
::VIEW
2716 $form->freeze('html_message');
2721 * Get the search based mailing Ids.
2724 * , searched base mailing ids.
2726 public function searchMailingIDs() {
2727 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2728 $mailing = self
::getTableName();
2731 SELECT $mailing.id as mailing_id
2732 FROM $mailing, $group
2733 WHERE $group.mailing_id = $mailing.id
2734 AND $group.group_type = 'Base'";
2736 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2737 $mailingIDs = array();
2738 while ($searchDAO->fetch()) {
2739 $mailingIDs[] = $searchDAO->mailing_id
;
2746 * Get the content/components of mailing based on mailing Id
2748 * @param array $report
2749 * of mailing report.
2752 * Reference of this.
2754 * @param bool $isSMS
2757 * array content/component.
2759 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2760 $htmlHeader = $textHeader = NULL;
2761 $htmlFooter = $textFooter = NULL;
2764 if ($report['mailing']['header_id']) {
2765 $header = new CRM_Mailing_BAO_Component();
2766 $header->id
= $report['mailing']['header_id'];
2767 $header->find(TRUE);
2768 $htmlHeader = $header->body_html
;
2769 $textHeader = $header->body_text
;
2772 if ($report['mailing']['footer_id']) {
2773 $footer = new CRM_Mailing_BAO_Component();
2774 $footer->id
= $report['mailing']['footer_id'];
2775 $footer->find(TRUE);
2776 $htmlFooter = $footer->body_html
;
2777 $textFooter = $footer->body_text
;
2781 $mailingKey = $form->_mailing_id
;
2783 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2784 $mailingKey = $hash;
2788 if (!empty($report['mailing']['body_text'])) {
2789 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2790 $form->assign('textViewURL', $url);
2794 if (!empty($report['mailing']['body_html'])) {
2795 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2796 $form->assign('htmlViewURL', $url);
2801 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2811 public static function overrideVerp($jobID) {
2812 static $_cache = array();
2814 if (!isset($_cache[$jobID])) {
2816 SELECT override_verp
2817 FROM civicrm_mailing
2818 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2819 WHERE civicrm_mailing_job.id = %1
2821 $params = array(1 => array($jobID, 'Integer'));
2822 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2824 return $_cache[$jobID];
2833 public static function processQueue($mode = NULL) {
2834 $config = CRM_Core_Config
::singleton();
2836 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2837 throw new CRM_Core_Exception(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(
2838 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2839 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/",
2843 // check if we are enforcing number of parallel cron jobs
2845 $gotCronLock = FALSE;
2847 $mailerJobsMax = Civi
::settings()->get('mailerJobsMax');
2848 if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2849 $lockArray = range(1, $mailerJobsMax);
2850 shuffle($lockArray);
2852 // check if we are using global locks
2853 foreach ($lockArray as $lockID) {
2854 $cronLock = Civi
::lockManager()->acquire("worker.mailing.send.{$lockID}");
2855 if ($cronLock->isAcquired()) {
2856 $gotCronLock = TRUE;
2861 // exit here since we have enuf cronjobs running
2862 if (!$gotCronLock) {
2863 CRM_Core_Error
::debug_log_message('Returning early, since max number of cronjobs running');
2867 if (getenv('CIVICRM_CRON_HOLD')) {
2868 // In testing, we may need to simulate some slow activities.
2869 sleep(getenv('CIVICRM_CRON_HOLD'));
2873 // load bootstrap to call hooks
2875 // Split up the parent jobs into multiple child jobs
2876 $mailerJobSize = Civi
::settings()->get('mailerJobSize');
2877 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2878 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2879 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2881 // lets release the global cron lock if we do have one
2883 $cronLock->release();
2890 * @param int $mailingID
2892 private static function addMultipleEmails($mailingID) {
2894 INSERT INTO civicrm_mailing_recipients
2895 (mailing_id, email_id, contact_id)
2896 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2898 AND e.is_bulkmail = 1
2900 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2901 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2903 $params = array(1 => array($mailingID, 'Integer'));
2905 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2909 * @param bool $isSMS
2913 public static function getMailingsList($isSMS = FALSE) {
2914 static $list = array();
2917 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2920 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2925 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2926 FROM civicrm_mailing
2927 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2928 ORDER BY civicrm_mailing.name";
2929 $mailing = CRM_Core_DAO
::executeQuery($query);
2931 while ($mailing->fetch()) {
2932 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2942 * @return null|string
2944 public static function hiddenMailingGroup($mid) {
2947 FROM civicrm_mailing m
2948 INNER JOIN civicrm_mailing_group mg ON mg.mailing_id = m.id
2949 INNER JOIN civicrm_group g ON mg.entity_id = g.id AND mg.entity_table = 'civicrm_group'
2950 WHERE g.is_hidden = 1
2951 AND mg.group_type = 'Include'
2954 $params = array(1 => array($mid, 'Integer'));
2955 return CRM_Core_DAO
::singleValueQuery($sql, $params);
2959 * wrapper for ajax activity selector.
2961 * @param array $params
2962 * Associated array for params record id.
2965 * associated array of contact activities
2967 public static function getContactMailingSelector(&$params) {
2968 // format the params
2969 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2970 $params['rowCount'] = $params['rp'];
2971 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2972 $params['caseId'] = NULL;
2974 // get contact mailings
2975 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2978 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2981 if (!empty($mailings)) {
2982 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2983 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2986 // format params and add links
2987 $contactMailings = array();
2988 foreach ($mailings as $mailingId => $values) {
2990 $mailing['subject'] = $values['subject'];
2991 $mailing['creator_name'] = CRM_Utils_System
::href(
2992 $values['creator_name'],
2993 'civicrm/contact/view',
2994 "reset=1&cid={$values['creator_id']}");
2995 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2996 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2997 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2999 $mailing['openstats'] = "Opens: " .
3000 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
3002 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
3004 $actionLinks = array(
3005 CRM_Core_Action
::VIEW
=> array(
3006 'name' => ts('View'),
3007 'url' => 'civicrm/mailing/view',
3008 'qs' => "reset=1&id=%%mkey%%",
3009 'title' => ts('View Mailing'),
3010 'class' => 'crm-popup',
3012 CRM_Core_Action
::BROWSE
=> array(
3013 'name' => ts('Mailing Report'),
3014 'url' => 'civicrm/mailing/report',
3015 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
3016 'title' => ts('View Mailing Report'),
3020 $mailingKey = $values['mailing_id'];
3021 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
3022 $mailingKey = $hash;
3025 $mailing['links'] = CRM_Core_Action
::formLink(
3029 'mid' => $values['mailing_id'],
3030 'cid' => $params['contact_id'],
3031 'mkey' => $mailingKey,
3035 'mailing.contact.action',
3037 $values['mailing_id']
3040 array_push($contactMailings, $mailing);
3043 $contactMailingsDT = array();
3044 $contactMailingsDT['data'] = $contactMailings;
3045 $contactMailingsDT['recordsTotal'] = $params['total'];
3046 $contactMailingsDT['recordsFiltered'] = $params['total'];
3048 return $contactMailingsDT;
3052 * Retrieve contact mailing.
3054 * @param array $params
3057 * Array of mailings for a contact
3060 static public function getContactMailings(&$params) {
3061 $params['version'] = 3;
3062 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3063 $params['limit'] = $params['rp'];
3064 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3066 $result = civicrm_api('MailingContact', 'get', $params);
3067 return $result['values'];
3071 * Retrieve contact mailing count.
3073 * @param array $params
3076 * count of mailings for a contact
3079 static public function getContactMailingsCount(&$params) {
3080 $params['version'] = 3;
3081 return civicrm_api('MailingContact', 'getcount', $params);
3085 * Get a list of permissions required for CRUD'ing each field
3086 * (when workflow is enabled).
3089 * Array (string $fieldName => string $permName)
3091 public static function getWorkflowFieldPerms() {
3092 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3093 $fieldPerms = array();
3094 foreach ($fieldNames as $fieldName) {
3095 if ($fieldName == 'id') {
3096 $fieldPerms[$fieldName] = array(
3097 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3100 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3101 $fieldPerms[$fieldName] = array(
3102 array('access CiviMail', 'schedule mailings'), // OR
3105 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3106 $fieldPerms[$fieldName] = array(
3107 array('access CiviMail', 'approve mailings'), // OR
3111 $fieldPerms[$fieldName] = array(
3112 array('access CiviMail', 'create mailings'), // OR