3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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 $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
315 GROUP BY $email.id, $contact.id
318 if ($mode == 'sms') {
319 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
320 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
322 SELECT DISTINCT $phone.id as phone_id,
323 $contact.id as contact_id
326 ON $phone.contact_id = $contact.id
327 INNER JOIN $g2contact
328 ON $contact.id = $g2contact.contact_id
330 ON $g2contact.group_id = $mg.entity_id
331 AND $mg.entity_table = '$group'
333 ON $contact.id = X_$job_id.contact_id
335 ($mg.group_type = 'Include')
336 AND $mg.search_id IS NULL
337 AND $g2contact.status = 'Added'
338 AND $contact.do_not_sms = 0
339 AND $contact.is_opt_out = 0
340 AND $contact.is_deceased <> 1
341 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
342 AND $phone.phone IS NOT NULL
343 AND $phone.phone != ''
344 AND $mg.mailing_id = {$mailing_id}
345 AND X_$job_id.contact_id IS null";
347 $mailingGroup->query($query);
349 // Query prior mailings.
351 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
352 SELECT $email.id as email_id,
353 $contact.id as contact_id
356 ON $email.contact_id = $contact.id
358 ON $eq.contact_id = $contact.id
360 ON $eq.job_id = $job.id
362 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
364 ON $contact.id = X_$job_id.contact_id
366 ($mg.group_type = 'Include')
367 AND $contact.do_not_email = 0
368 AND $contact.is_opt_out = 0
369 AND $contact.is_deceased <> 1
371 AND $email.on_hold = 0
372 AND $mg.mailing_id = {$mailing_id}
373 AND X_$job_id.contact_id IS null
374 GROUP BY $email.id, $contact.id
377 if ($mode == 'sms') {
378 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
379 SELECT DISTINCT $phone.id as phone_id,
380 $contact.id as contact_id
383 ON $phone.contact_id = $contact.id
385 ON $eq.contact_id = $contact.id
387 ON $eq.job_id = $job.id
389 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
391 ON $contact.id = X_$job_id.contact_id
393 ($mg.group_type = 'Include')
394 AND $contact.do_not_sms = 0
395 AND $contact.is_opt_out = 0
396 AND $contact.is_deceased <> 1
397 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
398 AND $mg.mailing_id = {$mailing_id}
399 AND X_$job_id.contact_id IS null";
401 $mailingGroup->query($query);
404 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
406 INNER JOIN $mg ON $mg.entity_id = $group.id
407 WHERE $mg.entity_table = '$group'
408 AND $mg.group_type = 'Include'
409 AND $mg.search_id IS NULL
410 AND $mg.mailing_id = {$mailing_id}
411 AND ( saved_search_id != 0
412 OR saved_search_id IS NOT NULL
413 OR children IS NOT NULL )
416 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
417 while ($groupDAO->fetch()) {
418 if ($groupDAO->cache_date
== NULL) {
419 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
422 $smartGroupInclude = "
423 REPLACE INTO I_$job_id (email_id, contact_id)
424 SELECT civicrm_email.id as email_id, c.id as contact_id
425 FROM civicrm_contact c
426 INNER JOIN civicrm_email ON civicrm_email.contact_id = c.id
427 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
428 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
429 WHERE gc.group_id = {$groupDAO->id}
430 AND c.do_not_email = 0
432 AND c.is_deceased <> 1
434 AND civicrm_email.on_hold = 0
435 AND X_$job_id.contact_id IS null
438 if ($mode == 'sms') {
439 $smartGroupInclude = "
440 REPLACE INTO I_$job_id (phone_id, contact_id)
441 SELECT p.id as phone_id, c.id as contact_id
442 FROM civicrm_contact c
443 INNER JOIN civicrm_phone p ON p.contact_id = c.id
444 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
445 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
446 WHERE gc.group_id = {$groupDAO->id}
449 AND c.is_deceased <> 1
450 AND p.phone_type_id = {$phoneTypes['Mobile']}
451 AND X_$job_id.contact_id IS null";
453 $mailingGroup->query($smartGroupInclude);
456 // Construct the filtered search queries.
458 SELECT search_id, search_args, entity_id
460 WHERE $mg.search_id IS NOT NULL
461 AND $mg.mailing_id = {$mailing_id}
463 $dao = CRM_Core_DAO
::executeQuery($query);
464 while ($dao->fetch()) {
465 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
469 $query = "REPLACE INTO I_$job_id ({$tempColumn}, contact_id)
471 $mailingGroup->query($query);
474 // Get the emails with only location override.
476 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
477 SELECT $email.id as local_email_id,
478 $contact.id as contact_id
481 ON $email.contact_id = $contact.id
482 INNER JOIN $g2contact
483 ON $contact.id = $g2contact.contact_id
485 ON $g2contact.group_id = $mg.entity_id
487 ON $contact.id = X_$job_id.contact_id
489 $mg.entity_table = '$group'
490 AND $mg.group_type = 'Include'
491 AND $g2contact.status = 'Added'
492 AND $contact.do_not_email = 0
493 AND $contact.is_opt_out = 0
494 AND $contact.is_deceased <> 1
496 AND $email.on_hold = 0
497 AND $mg.mailing_id = {$mailing_id}
498 AND X_$job_id.contact_id IS null
499 GROUP BY $email.id, $contact.id
501 if ($mode == "sms") {
502 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
503 SELECT DISTINCT $phone.id as phone_id,
504 $contact.id as contact_id
507 ON $phone.contact_id = $contact.id
508 INNER JOIN $g2contact
509 ON $contact.id = $g2contact.contact_id
511 ON $g2contact.group_id = $mg.entity_id
513 ON $contact.id = X_$job_id.contact_id
515 $mg.entity_table = '$group'
516 AND $mg.group_type = 'Include'
517 AND $g2contact.status = 'Added'
518 AND $contact.do_not_sms = 0
519 AND $contact.is_opt_out = 0
520 AND $contact.is_deceased <> 1
521 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
522 AND $mg.mailing_id = {$mailing_id}
523 AND X_$job_id.contact_id IS null";
525 $mailingGroup->query($query);
527 $eq = new CRM_Mailing_Event_BAO_Queue();
529 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
530 $aclWhere = $aclWhere ?
"WHERE {$aclWhere}" : '';
532 if ($storeRecipients && $mailing_id) {
535 FROM civicrm_mailing_recipients
536 WHERE mailing_id = %1
538 $params = array(1 => array($mailing_id, 'Integer'));
539 CRM_Core_DAO
::executeQuery($sql, $params);
541 $selectClause = array('%1', 'i.contact_id', "i.{$tempColumn}");
542 $select = "SELECT " . implode(', ', $selectClause);
544 $groupBy = $groupJoin = '';
545 $orderBy = "i.contact_id, i.{$tempColumn}";
547 $orderBy = "MIN(i.contact_id), MIN(i.{$tempColumn})";
548 $groupJoin = " INNER JOIN civicrm_email e ON e.id = i.email_id";
549 $groupBy = " GROUP BY e.email ";
550 $select = CRM_Contact_BAO_Query
::appendAnyValueToSelect($selectClause, 'e.email');
554 INSERT INTO civicrm_mailing_recipients ( mailing_id, contact_id, {$tempColumn} )
556 FROM civicrm_contact contact_a
557 INNER JOIN I_$job_id i ON contact_a.id = i.contact_id
565 CRM_Core_DAO
::executeQuery($sql, $params);
567 // if we need to add all emails marked bulk, do it as a post filter
568 // on the mailing recipients table
569 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
570 self
::addMultipleEmails($mailing_id);
574 // Delete the temp table.
576 $mailingGroup->reset();
577 $mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
578 $mailingGroup->query("DROP TEMPORARY TABLE I_$job_id");
584 * @param string $type
588 private function _getMailingGroupIds($type = 'Include') {
589 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
590 $group = CRM_Contact_DAO_Group
::getTableName();
591 if (!isset($this->id
)) {
592 // we're just testing tokens, so return any group
593 $query = "SELECT id AS entity_id
599 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
600 $query = "SELECT entity_id
602 WHERE mailing_id = {$this->id}
603 AND group_type = '$type'
604 AND entity_table = '$group'";
606 $mailingGroup->query($query);
609 while ($mailingGroup->fetch()) {
610 $groupIds[] = $mailingGroup->entity_id
;
617 * Returns the regex patterns that are used for preparing the text and html templates.
619 * @param bool $onlyHrefs
621 * @return array|string
623 private function getPatterns($onlyHrefs = FALSE) {
627 $protos = '(https?|ftp|mailto)';
629 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
631 $any = "{$letters}{$gunk}{$punc}";
633 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
636 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
639 $patterns[] = $pattern;
640 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
641 $patterns[] = '\{\w+\.\w+\}';
643 $patterns = '{' . implode('|', $patterns) . '}imu';
649 * Returns an array that denotes the type of token that we are dealing with
650 * we use the type later on when we are doing a token replacement lookup
652 * @param string $token
653 * The token for which we will be doing adata lookup.
656 * An array that holds the token itself and the type.
657 * the type will tell us which function to use for the data lookup
658 * if we need to do a lookup at all
660 public function &getDataFunc($token) {
661 static $_categories = NULL;
662 static $_categoryString = NULL;
664 $_categories = array(
671 CRM_Utils_Hook
::tokens($_categories);
672 $_categoryString = implode('|', array_keys($_categories));
675 $funcStruct = array('type' => NULL, 'token' => $token);
677 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
678 // it is a url so we need to check to see if there are any tokens embedded
679 // if so then call this function again to get the token dataFunc
680 // and assign the type 'embedded' so that the data retrieving function
681 // will know what how to handle this token.
682 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
683 $funcStruct['type'] = 'embedded_url';
684 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
685 foreach ($matches[1] as $match) {
686 $preg_token = '/' . preg_quote($match, '/') . '/';
687 $list = preg_split($preg_token, $token, 2);
688 $funcStruct['embed_parts'][] = $list[0];
690 $funcStruct['token'][] = $this->getDataFunc($match);
692 // fixed truncated url, CRM-7113
694 $funcStruct['embed_parts'][] = $token;
698 $funcStruct['type'] = 'url';
701 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
702 $funcStruct['type'] = $matches[1];
703 $funcStruct['token'] = $matches[2];
705 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
706 // we are an escaped token
707 // so remove the escape chars
708 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
709 $funcStruct['token'] = '{' . $unescaped_token . '}';
716 * Prepares the text and html templates
717 * for generating the emails and returns a copy of the
720 private function getPreparedTemplates() {
721 if (!$this->preparedTemplates
) {
722 $patterns['html'] = $this->getPatterns(TRUE);
723 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
724 $templates = $this->getTemplates();
726 $this->preparedTemplates
= array();
733 if (!isset($templates[$key])) {
739 $split_template = array();
741 $email = $templates[$key];
742 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
743 foreach ($matches[0] as $idx => $token) {
744 $preg_token = '/' . preg_quote($token, '/') . '/im';
745 list($split_template[], $email) = preg_split($preg_token, $email, 2);
746 array_push($tokens, $this->getDataFunc($token));
749 $split_template[] = $email;
751 $this->preparedTemplates
[$key]['template'] = $split_template;
752 $this->preparedTemplates
[$key]['tokens'] = $tokens;
755 return ($this->preparedTemplates
);
759 * Retrieve a ref to an array that holds the email and text templates for this email
760 * assembles the complete template including the header and footer
761 * that the user has uploaded or declared (if they have done that)
764 * reference to an assoc array
766 public function getTemplates() {
767 if (!$this->templates
) {
768 $this->getHeaderFooter();
769 $this->templates
= array();
770 if ($this->body_text ||
!empty($this->header
)) {
772 if (!empty($this->header
->body_text
)) {
773 $template[] = $this->header
->body_text
;
775 elseif (!empty($this->header
->body_html
)) {
776 $template[] = CRM_Utils_String
::htmlToText($this->header
->body_html
);
779 if ($this->body_text
) {
780 $template[] = $this->body_text
;
783 $template[] = CRM_Utils_String
::htmlToText($this->body_html
);
786 if (!empty($this->footer
->body_text
)) {
787 $template[] = $this->footer
->body_text
;
789 elseif (!empty($this->footer
->body_html
)) {
790 $template[] = CRM_Utils_String
::htmlToText($this->footer
->body_html
);
793 $this->templates
['text'] = implode("\n", $template);
796 // To check for an html part strip tags
797 if (trim(strip_tags($this->body_html
))) {
801 $template[] = $this->header
->body_html
;
804 $template[] = $this->body_html
;
807 $template[] = $this->footer
->body_html
;
810 $this->templates
['html'] = implode("\n", $template);
812 // this is where we create a text template from the html template if the text template did not exist
813 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
814 // user uploads an html email only
815 if (empty($this->templates
['text'])) {
816 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
820 if ($this->subject
) {
822 $template[] = $this->subject
;
823 $this->templates
['subject'] = implode("\n", $template);
826 CRM_Utils_Hook
::alterMailContent($this->templates
);
828 return $this->templates
;
833 * Retrieve a ref to an array that holds all of the tokens in the email body
834 * where the keys are the type of token and the values are ordinal arrays
835 * that hold the token names (even repeated tokens) in the order in which
836 * they appear in the body of the email.
838 * note: the real work is done in the _getTokens() function
840 * this function needs to have some sort of a body assigned
841 * either text or html for this to have any meaningful impact
844 * reference to an assoc array
846 public function &getTokens() {
847 if (!$this->tokens
) {
849 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
851 if ($this->body_html
) {
852 $this->_getTokens('html');
853 if (!$this->body_text
) {
854 // Since the text template was created from html, use the html tokens.
855 // @see CRM_Mailing_BAO_Mailing::getTemplates()
856 $this->tokens
['text'] = $this->tokens
['html'];
860 if ($this->body_text
) {
861 $this->_getTokens('text');
864 if ($this->subject
) {
865 $this->_getTokens('subject');
869 return $this->tokens
;
873 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
874 * hook in one call and standardizes it across other token workflows
877 * reference to an assoc array
879 public function &getFlattenedTokens() {
880 if (!$this->flattenedTokens
) {
881 $tokens = $this->getTokens();
883 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
886 return $this->flattenedTokens
;
891 * _getTokens parses out all of the tokens that have been
892 * included in the html and text bodies of the email
893 * we get the tokens and then separate them into an
894 * internal structure named tokens that has the same
895 * form as the static tokens property(?) of the CRM_Utils_Token class.
896 * The difference is that there might be repeated token names as we want the
897 * structures to represent the order in which tokens were found from left to right, top to bottom.
900 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
901 * Name of the property that holds the text that we want to scan for tokens (html, text).
905 private function _getTokens($prop) {
906 $templates = $this->getTemplates();
908 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
910 foreach ($newTokens as $type => $names) {
911 if (!isset($this->tokens
[$prop][$type])) {
912 $this->tokens
[$prop][$type] = array();
914 foreach ($names as $key => $name) {
915 $this->tokens
[$prop][$type][] = $name;
921 * Generate an event queue for a test job.
923 * @param array $testParams
924 * Contains form values.
928 public function getTestRecipients($testParams) {
929 if (!empty($testParams['test_group']) && array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
930 $contacts = civicrm_api('contact', 'get', array(
932 'group' => $testParams['test_group'],
935 'limit' => 100000000000,
940 foreach (array_keys($contacts['values']) as $groupContact) {
942 SELECT civicrm_email.id AS email_id,
943 civicrm_email.is_primary as is_primary,
944 civicrm_email.is_bulkmail as is_bulkmail
946 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
947 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
948 AND civicrm_contact.id = {$groupContact}
949 AND civicrm_contact.do_not_email = 0
950 AND civicrm_contact.is_deceased <> 1
951 AND civicrm_email.on_hold = 0
952 AND civicrm_contact.is_opt_out = 0
953 GROUP BY civicrm_email.id
954 ORDER BY civicrm_email.is_bulkmail DESC
956 $dao = CRM_Core_DAO
::executeQuery($query);
959 'job_id' => $testParams['job_id'],
960 'email_id' => $dao->email_id
,
961 'contact_id' => $groupContact,
963 CRM_Mailing_Event_BAO_Queue
::create($params);
970 * Load this->header and this->footer.
972 private function getHeaderFooter() {
973 if (!$this->header
and $this->header_id
) {
974 $this->header
= new CRM_Mailing_BAO_Component();
975 $this->header
->id
= $this->header_id
;
976 $this->header
->find(TRUE);
977 $this->header
->free();
980 if (!$this->footer
and $this->footer_id
) {
981 $this->footer
= new CRM_Mailing_BAO_Component();
982 $this->footer
->id
= $this->footer_id
;
983 $this->footer
->find(TRUE);
984 $this->footer
->free();
989 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
990 * add a Message-ID header if needed.
992 * i.e. if the global includeMessageId is set and there isn't already a
993 * Message-ID in the array.
994 * The message ID is structured the same way as a verp. However no interpretation
995 * is placed on the values received, so they do not need to follow the verp
998 * @param array $headers
999 * Array of message headers to update, in-out.
1000 * @param string $prefix
1001 * Prefix for the message ID, use same prefixes as verp.
1003 * @param string $job_id
1004 * Job ID component of the generated message ID.
1005 * @param string $event_queue_id
1006 * Event Queue ID component of the generated message ID.
1007 * @param string $hash
1008 * Hash component of the generated message ID.
1012 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
1013 $config = CRM_Core_Config
::singleton();
1014 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1015 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1016 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
1018 if ($includeMessageId && (!array_key_exists('Message-ID', $headers))) {
1019 $headers['Message-ID'] = '<' . implode($config->verpSeparator
,
1021 $localpart . $prefix,
1026 ) . "@{$emailDomain}>";
1031 * Static wrapper for getting verp and urls.
1033 * @param int $job_id
1034 * ID of the Job associated with this message.
1035 * @param int $event_queue_id
1036 * ID of the EventQueue.
1037 * @param string $hash
1038 * Hash of the EventQueue.
1039 * @param string $email
1040 * Destination address.
1043 * (reference) array array ref that hold array refs to the verp info and urls
1045 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
1046 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
1047 $config = CRM_Core_Config
::singleton();
1048 $bao = new CRM_Mailing_BAO_Mailing();
1049 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
1050 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
1052 // use $bao's instance method to get verp and urls
1053 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
1054 return array($verp, $urls);
1058 * Get verp, urls and headers
1060 * @param int $job_id
1061 * ID of the Job associated with this message.
1062 * @param int $event_queue_id
1063 * ID of the EventQueue.
1064 * @param string $hash
1065 * Hash of the EventQueue.
1066 * @param string $email
1067 * Destination address.
1069 * @param bool $isForward
1072 * array ref that hold array refs to the verp info, urls, and headers
1074 public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
1075 $config = CRM_Core_Config
::singleton();
1078 * Inbound VERP keys:
1079 * reply: user replied to mailing
1080 * bounce: email address bounced
1081 * unsubscribe: contact opts out of all target lists for the mailing
1082 * resubscribe: contact opts back into all target lists for the mailing
1083 * optOut: contact unsubscribes from the domain
1086 $verpTokens = array(
1089 'unsubscribe' => 'u',
1090 'resubscribe' => 'e',
1094 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1095 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1096 // Make sure the user configured the site correctly, otherwise you just get "Could not identify any recipients. Perhaps the group is empty?" from the mailing UI
1097 if (empty($emailDomain)) {
1098 CRM_Core_Error
::debug_log_message('Error setting verp parameters, defaultDomain is NULL. Did you configure the bounce processing account for this domain?');
1101 foreach ($verpTokens as $key => $value) {
1102 $verp[$key] = implode($config->verpSeparator
,
1104 $localpart . $value,
1109 ) . "@$emailDomain";
1112 //handle should override VERP address.
1113 $skipEncode = FALSE;
1116 self
::overrideVerp($job_id)
1118 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
1122 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
1123 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1124 TRUE, NULL, TRUE, TRUE
1126 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
1127 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1128 TRUE, NULL, TRUE, TRUE
1130 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
1131 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1132 TRUE, NULL, TRUE, TRUE
1134 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1135 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1136 TRUE, NULL, TRUE, TRUE
1138 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1140 TRUE, NULL, TRUE, TRUE
1145 'Reply-To' => $verp['reply'],
1146 'Return-Path' => $verp['bounce'],
1147 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1148 'Subject' => $this->subject
,
1149 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1151 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1153 $headers['Subject'] = "[Fwd:{$this->subject}]";
1155 return array(&$verp, &$urls, &$headers);
1159 * Compose a message.
1161 * @param int $job_id
1162 * ID of the Job associated with this message.
1163 * @param int $event_queue_id
1164 * ID of the EventQueue.
1165 * @param string $hash
1166 * Hash of the EventQueue.
1167 * @param string $contactId
1168 * ID of the Contact.
1169 * @param string $email
1170 * Destination address.
1171 * @param string $recipient
1172 * To: of the recipient.
1174 * Is this mailing a test?.
1175 * @param $contactDetails
1176 * @param $attachments
1177 * @param bool $isForward
1178 * Is this mailing compose for forward?.
1179 * @param string $fromEmail
1180 * Email address of who is forwardinf it.
1182 * @param null $replyToEmail
1184 * @return Mail_mime The mail object
1186 public function compose(
1187 $job_id, $event_queue_id, $hash, $contactId,
1188 $email, &$recipient, $test,
1189 $contactDetails, &$attachments, $isForward = FALSE,
1190 $fromEmail = NULL, $replyToEmail = NULL
1192 $config = CRM_Core_Config
::singleton();
1195 if ($this->_domain
== NULL) {
1196 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1199 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1207 //set from email who is forwarding it and not original one.
1209 unset($headers['From']);
1210 $headers['From'] = "<{$fromEmail}>";
1213 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1214 $headers['Reply-To'] = "{$replyToEmail}";
1217 if ($contactDetails) {
1218 $contact = $contactDetails;
1220 elseif ($contactId === 0) {
1223 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1226 $params = array(array('contact_id', '=', $contactId, 0, 0));
1227 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1230 $contact = reset($contact);
1232 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1233 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1234 array(1 => $contactId)
1236 // setting this because function is called by reference
1237 //@todo test not calling function by reference
1242 // also call the hook to get contact details
1243 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1246 $pTemplates = $this->getPreparedTemplates();
1249 foreach ($pTemplates as $type => $pTemplate) {
1250 $html = ($type == 'html') ?
TRUE : FALSE;
1251 $pEmails[$type] = array();
1252 $pEmail = &$pEmails[$type];
1253 $template = &$pTemplates[$type]['template'];
1254 $tokens = &$pTemplates[$type]['tokens'];
1256 if (!empty($tokens)) {
1257 foreach ($tokens as $idx => $token) {
1258 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1259 array_push($pEmail, $template[$idx]);
1260 array_push($pEmail, $token_data);
1264 array_push($pEmail, $template[$idx]);
1267 if (isset($template[($idx +
1)])) {
1268 array_push($pEmail, $template[($idx +
1)]);
1273 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1274 $html = &$pEmails['html'];
1278 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1279 $text = &$pEmails['text'];
1282 // push the tracking url on to the html email if necessary
1283 if ($this->open_tracking
&& $html) {
1284 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1285 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1289 $message = new Mail_mime("\n");
1291 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1293 $smarty = CRM_Core_Smarty
::singleton();
1294 // also add the contact tokens to the template
1295 $smarty->assign_by_ref('contact', $contact);
1298 $mailParams = $headers;
1299 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1300 $contact['preferred_mail_format'] == 'Both' ||
1301 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1304 $textBody = implode('', $text);
1306 $textBody = $smarty->fetch("string:$textBody");
1308 $mailParams['text'] = $textBody;
1311 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1312 $contact['preferred_mail_format'] == 'Both'
1315 $htmlBody = implode('', $html);
1317 $htmlBody = $smarty->fetch("string:$htmlBody");
1319 $mailParams['html'] = $htmlBody;
1322 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1324 // something went wrong, lets log it and return null (by reference)
1325 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1332 $mailParams['attachments'] = $attachments;
1334 $mailingSubject = CRM_Utils_Array
::value('subject', $pEmails);
1335 if (is_array($mailingSubject)) {
1336 $mailingSubject = implode('', $mailingSubject);
1338 $mailParams['Subject'] = $mailingSubject;
1340 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1343 $mailParams['toEmail'] = $email;
1345 // Add job ID to mailParams for external email delivery service to utilise
1346 $mailParams['job_id'] = $job_id;
1348 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1350 // CRM-10699 support custom email headers
1351 if (!empty($mailParams['headers'])) {
1352 $headers = array_merge($headers, $mailParams['headers']);
1354 //cycle through mailParams and set headers array
1355 foreach ($mailParams as $paramKey => $paramValue) {
1356 //exclude values not intended for the header
1357 if (!in_array($paramKey, array(
1365 $headers[$paramKey] = $paramValue;
1369 if (!empty($mailParams['text'])) {
1370 $message->setTxtBody($mailParams['text']);
1373 if (!empty($mailParams['html'])) {
1374 $message->setHTMLBody($mailParams['html']);
1377 if (!empty($mailParams['attachments'])) {
1378 foreach ($mailParams['attachments'] as $fileID => $attach) {
1379 $message->addAttachment($attach['fullPath'],
1380 $attach['mime_type'],
1381 $attach['cleanName']
1386 //pickup both params from mail params.
1387 $toName = trim($mailParams['toName']);
1388 $toEmail = trim($mailParams['toEmail']);
1389 if ($toName == $toEmail ||
1390 strpos($toName, '@') !== FALSE
1395 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1398 $headers['To'] = "$toName <$toEmail>";
1400 $headers['Precedence'] = 'bulk';
1401 // Will test in the mail processor if the X-VERP is set in the bounced email.
1402 // (As an option to replace real VERP for those that can't set it up)
1403 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1406 //token replacement of subject
1407 $headers['Subject'] = $mailingSubject;
1409 CRM_Utils_Mail
::setMimeParams($message);
1410 $headers = $message->headers($headers);
1412 //get formatted recipient
1413 $recipient = $headers['To'];
1415 // make sure we unset a lot of stuff
1428 * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
1430 * @param CRM_Mailing_BAO_Mailing $mailing
1432 public static function tokenReplace(&$mailing) {
1433 $domain = CRM_Core_BAO_Domain
::getDomain();
1435 foreach (array('text', 'html') as $type) {
1436 $tokens = $mailing->getTokens();
1437 if (isset($mailing->templates
[$type])) {
1438 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1439 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1440 $mailing->templates
[$type],
1442 $type == 'html' ?
TRUE : FALSE,
1445 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1451 * Get data to resolve tokens.
1453 * @param array $token_a
1455 * @param array $contact
1456 * @param string $verp
1457 * @param array $urls
1458 * @param int $event_queue_id
1460 * @return bool|mixed|null|string
1462 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1463 $type = $token_a['type'];
1464 $token = $token_a['token'];
1467 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1469 if ($type == 'embedded_url') {
1470 $embed_data = array();
1471 foreach ($token as $t) {
1472 $embed_data[] = $this->getTokenData($t, $html = FALSE, $contact, $verp, $urls, $event_queue_id);
1474 $numSlices = count($embed_data);
1476 for ($i = 0; $i < $numSlices; $i++
) {
1477 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1479 if (isset($token_a['embed_parts'][$numSlices])) {
1480 $url .= $token_a['embed_parts'][$numSlices];
1482 // add trailing quote since we've gobbled it up in a previous regex
1483 // function getPatterns, line 431
1484 if (preg_match('/^href[ ]*=[ ]*\'/', $url)) {
1487 elseif (preg_match('/^href[ ]*=[ ]*\"/', $url)) {
1492 elseif ($type == 'url') {
1493 if ($this->url_tracking
) {
1494 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1495 if (!empty($html)) {
1496 $data = htmlentities($data, ENT_NOQUOTES
);
1503 elseif ($type == 'contact') {
1504 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1506 elseif ($type == 'action') {
1507 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1509 elseif ($type == 'domain') {
1510 $domain = CRM_Core_BAO_Domain
::getDomain();
1511 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1513 elseif ($type == 'mailing') {
1514 if ($token == 'name') {
1515 $data = $this->name
;
1517 elseif ($token == 'group') {
1518 $groups = $this->getGroupNames();
1519 $data = implode(', ', $groups);
1523 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1529 * Return a list of group names for this mailing. Does not work with
1530 * prior-mailing targets.
1533 * Names of groups receiving this mailing
1535 public function &getGroupNames() {
1536 if (!isset($this->id
)) {
1539 $mg = new CRM_Mailing_DAO_MailingGroup();
1540 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1541 $group = CRM_Contact_BAO_Group
::getTableName();
1543 $mg->query("SELECT $group.title as name FROM $mgtable
1544 INNER JOIN $group ON $mgtable.entity_id = $group.id
1545 WHERE $mgtable.mailing_id = {$this->id}
1546 AND $mgtable.entity_table = '$group'
1547 AND $mgtable.group_type = 'Include'
1548 ORDER BY $group.name");
1551 while ($mg->fetch()) {
1552 $groups[] = $mg->name
;
1561 * @param array $params
1562 * Reference array contains the values submitted by the form.
1564 * Reference array contains the id.
1567 * @return CRM_Mailing_DAO_Mailing
1569 public static function add(&$params, $ids = array()) {
1570 $id = CRM_Utils_Array
::value('mailing_id', $ids, CRM_Utils_Array
::value('id', $params));
1573 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1576 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1579 $mailing = new static();
1582 $mailing->find(TRUE);
1584 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1586 if (!isset($params['replyto_email']) &&
1587 isset($params['from_email'])
1589 $params['replyto_email'] = $params['from_email'];
1592 $mailing->copyValues($params);
1594 $result = $mailing->save();
1596 if (!empty($ids['mailing'])) {
1597 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1600 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1607 * Construct a new mailing object, along with job and mailing_group
1608 * objects, from the form values of the create mailing wizard.
1610 * This function is a bit evil. It not only merges $params and saves
1611 * the mailing -- it also schedules the mailing and chooses the recipients.
1612 * Since it merges $params, it's also the only place to correctly trigger
1613 * multi-field validation. It should be broken up.
1615 * In the mean time, use-cases which break under the weight of this
1616 * evil may find reprieve in these extra evil params:
1618 * - _skip_evil_bao_auto_recipients_: bool
1619 * - _skip_evil_bao_auto_schedule_: bool
1620 * - _evil_bao_validator_: string|callable
1622 * </twowrongsmakesaright>
1624 * @params array $params
1627 * @param array $params
1631 * $mailing The new mailing object
1632 * @throws \Exception
1634 public static function create(&$params, $ids = array()) {
1636 if (empty($ids) && isset($params['id'])) {
1637 $ids['mailing_id'] = $ids['id'] = $params['id'];
1641 // Do the below only for an insert
1642 // for an update, we should not set the defaults
1643 if (!isset($ids['id']) && !isset($ids['mailing_id'])) {
1644 // Retrieve domain email and name for default sender
1645 $domain = civicrm_api(
1650 'current_domain' => 1,
1654 if (isset($domain['from_email'])) {
1655 $domain_email = $domain['from_email'];
1656 $domain_name = $domain['from_name'];
1659 $domain_email = 'info@EXAMPLE.ORG';
1660 $domain_name = 'EXAMPLE.ORG';
1662 if (!isset($params['created_id'])) {
1663 $session =& CRM_Core_Session
::singleton();
1664 $params['created_id'] = $session->get('userID');
1667 // load the default config settings for each
1668 // eg reply_id, unsubscribe_id need to use
1669 // correct template IDs here
1670 'override_verp' => TRUE,
1671 'forward_replies' => FALSE,
1672 'open_tracking' => TRUE,
1673 'url_tracking' => TRUE,
1674 'visibility' => 'Public Pages',
1675 'replyto_email' => $domain_email,
1676 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1677 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1678 'from_email' => $domain_email,
1679 'from_name' => $domain_name,
1680 'msg_template_id' => NULL,
1681 'created_id' => $params['created_id'],
1682 'approver_id' => NULL,
1683 'auto_responder' => 0,
1684 'created_date' => date('YmdHis'),
1685 'scheduled_date' => NULL,
1686 'approval_date' => NULL,
1689 // Get the default from email address, if not provided.
1690 if (empty($defaults['from_email'])) {
1691 $defaultAddress = CRM_Core_OptionGroup
::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
1692 foreach ($defaultAddress as $id => $value) {
1693 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1694 $defaults['from_email'] = $match[2];
1695 $defaults['from_name'] = $match[1];
1700 $params = array_merge($defaults, $params);
1704 * Could check and warn for the following cases:
1706 * - groups OR mailings should be populated.
1707 * - body html OR body text should be populated.
1710 $transaction = new CRM_Core_Transaction();
1712 $mailing = self
::add($params, $ids);
1714 if (is_a($mailing, 'CRM_Core_Error')) {
1715 $transaction->rollback();
1718 // update mailings with hash values
1719 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1721 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1722 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
1724 /* Create the mailing group record */
1725 $mg = new CRM_Mailing_DAO_MailingGroup();
1726 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1727 foreach (array('groups', 'mailings') as $entity) {
1728 foreach (array('include', 'exclude', 'base') as $type) {
1729 if (isset($params[$entity][$type])) {
1730 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1735 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1737 $mg->mailing_id
= $mailing->id
;
1738 $mg->entity_table
= $groupTableName;
1739 $mg->entity_id
= $params['group_id'];
1740 $mg->search_id
= $params['search_id'];
1741 $mg->search_args
= $params['search_args'];
1742 $mg->group_type
= 'Include';
1746 // check and attach and files as needed
1747 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1749 // If we're going to autosend, then check validity before saving.
1750 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1751 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1752 $errors = call_user_func($cb, $mailing);
1753 if (!empty($errors)) {
1754 $fields = implode(',', array_keys($errors));
1755 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1759 $transaction->commit();
1761 // Create parent job if not yet created.
1762 // Condition on the existence of a scheduled date.
1763 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1764 $job = new CRM_Mailing_BAO_MailingJob();
1765 $job->mailing_id
= $mailing->id
;
1766 $job->status
= 'Scheduled';
1769 if (!$job->find(TRUE)) {
1770 // Don't schedule job until we populate the recipients.
1771 $job->scheduled_date
= NULL;
1775 // Populate the recipients.
1776 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1777 // check if it's sms
1778 $mode = $mailing->sms_provider_id ?
'sms' : NULL;
1779 self
::getRecipients($job->id
, $mailing->id
, TRUE, $mailing->dedupe_email
, $mode);
1781 // Schedule the job now that it has recipients.
1782 $job->scheduled_date
= $params['scheduled_date'];
1790 * @param CRM_Mailing_DAO_Mailing $mailing
1791 * The mailing which may or may not be sendable.
1793 * List of error messages.
1795 public static function checkSendable($mailing) {
1797 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1798 if (empty($mailing->{$field})) {
1799 $errors[$field] = ts('Field "%1" is required.', array(
1804 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1805 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1808 if (!Civi
::settings()->get('disable_mandatory_tokens_check')) {
1809 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->header_id
) : NULL;
1810 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->footer_id
) : NULL;
1811 foreach (array('body_html', 'body_text') as $field) {
1812 if (empty($mailing->{$field})) {
1815 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1816 $err = CRM_Utils_Token
::requiredTokens($str);
1817 if ($err !== TRUE) {
1818 foreach ($err as $token => $desc) {
1819 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1820 array(1 => $token, 2 => $desc)
1831 * Replace the list of recipients on a given mailing.
1833 * @param int $mailingId
1834 * @param string $type
1835 * 'include' or 'exclude'.
1836 * @param string $entity
1837 * 'groups' or 'mailings'.
1838 * @param array <int> $entityIds
1839 * @throws CiviCRM_API3_Exception
1841 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1843 foreach ($entityIds as $entityId) {
1844 $values[] = array('entity_id' => $entityId);
1846 civicrm_api3('mailing_group', 'replace', array(
1847 'mailing_id' => $mailingId,
1848 'group_type' => $type,
1849 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1850 'values' => $values,
1855 * Get hash value of the mailing.
1859 * @return null|string
1861 public static function getMailingHash($id) {
1863 if (Civi
::settings()->get('hash_mailing_url')) {
1864 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1870 * Generate a report. Fetch event count information, mailing data, and job
1874 * The mailing id to report.
1875 * @param bool $skipDetails
1876 * Whether return all detailed report.
1878 * @param bool $isSMS
1881 * Associative array of reporting data
1883 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1884 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1886 $mailing = new CRM_Mailing_BAO_Mailing();
1889 'mailing' => self
::getTableName(),
1890 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1891 'group' => CRM_Contact_BAO_Group
::getTableName(),
1892 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1893 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1894 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1895 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1896 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1897 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1898 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1899 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1900 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1901 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1902 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1903 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1907 $additionalWhereClause = " AND ";
1909 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1912 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1915 /* Get the mailing info */
1918 SELECT {$t['mailing']}.*
1919 FROM {$t['mailing']}
1920 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1924 $report['mailing'] = array();
1925 foreach (array_keys(self
::fields()) as $field) {
1926 $report['mailing'][$field] = $mailing->$field;
1930 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1931 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1932 $report['mailing']['campaign'] = $campaigns[$campaignId];
1935 //mailing report is called by activity
1936 //we dont need all detail report
1941 /* Get the component info */
1945 $components = array(
1946 'header' => ts('Header'),
1947 'footer' => ts('Footer'),
1948 'reply' => ts('Reply'),
1949 'unsubscribe' => ts('Unsubscribe'),
1950 'optout' => ts('Opt-Out'),
1952 foreach (array_keys($components) as $type) {
1953 $query[] = "SELECT {$t['component']}.name as name,
1955 {$t['component']}.id as id
1956 FROM {$t['component']}
1957 INNER JOIN {$t['mailing']}
1958 ON {$t['mailing']}.{$type}_id =
1959 {$t['component']}.id
1960 WHERE {$t['mailing']}.id = $mailing_id";
1962 $q = '(' . implode(') UNION (', $query) . ')';
1963 $mailing->query($q);
1965 $report['component'] = array();
1966 while ($mailing->fetch()) {
1967 $report['component'][] = array(
1968 'type' => $components[$mailing->type
],
1969 'name' => $mailing->name
,
1970 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1971 "reset=1&action=update&id={$mailing->id}"
1976 /* Get the recipient group info */
1979 SELECT {$t['mailing_group']}.group_type as group_type,
1980 {$t['group']}.id as group_id,
1981 {$t['group']}.title as group_title,
1982 {$t['group']}.is_hidden as group_hidden,
1983 {$t['mailing']}.id as mailing_id,
1984 {$t['mailing']}.name as mailing_name
1985 FROM {$t['mailing_group']}
1986 LEFT JOIN {$t['group']}
1987 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1988 AND {$t['mailing_group']}.entity_table =
1990 LEFT JOIN {$t['mailing']}
1991 ON {$t['mailing_group']}.entity_id =
1993 AND {$t['mailing_group']}.entity_table =
1996 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1999 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
2000 while ($mailing->fetch()) {
2002 if (isset($mailing->group_id
)) {
2003 $row['id'] = $mailing->group_id
;
2004 $row['name'] = $mailing->group_title
;
2005 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
2006 "reset=1&force=1&context=smog&gid={$row['id']}"
2010 $row['id'] = $mailing->mailing_id
;
2011 $row['name'] = $mailing->mailing_name
;
2012 $row['mailing'] = TRUE;
2013 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
2018 /* Rename hidden groups */
2020 if ($mailing->group_hidden
== 1) {
2021 $row['name'] = "Search Results";
2024 if ($mailing->group_type
== 'Include') {
2025 $report['group']['include'][] = $row;
2027 elseif ($mailing->group_type
== 'Base') {
2028 $report['group']['base'][] = $row;
2031 $report['group']['exclude'][] = $row;
2035 /* Get the event totals, grouped by job (retries) */
2038 SELECT {$t['job']}.*,
2039 COUNT(DISTINCT {$t['queue']}.id) as queue,
2040 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
2041 COUNT(DISTINCT {$t['reply']}.id) as reply,
2042 COUNT(DISTINCT {$t['forward']}.id) as forward,
2043 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
2044 COUNT(DISTINCT {$t['urlopen']}.id) as url,
2045 COUNT(DISTINCT {$t['spool']}.id) as spool
2047 LEFT JOIN {$t['queue']}
2048 ON {$t['queue']}.job_id = {$t['job']}.id
2049 LEFT JOIN {$t['reply']}
2050 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
2051 LEFT JOIN {$t['forward']}
2052 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
2053 LEFT JOIN {$t['bounce']}
2054 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
2055 LEFT JOIN {$t['delivered']}
2056 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
2057 AND {$t['bounce']}.id IS null
2058 LEFT JOIN {$t['urlopen']}
2059 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2060 LEFT JOIN {$t['spool']}
2061 ON {$t['spool']}.job_id = {$t['job']}.id
2062 WHERE {$t['job']}.mailing_id = $mailing_id
2063 AND {$t['job']}.is_test = 0
2064 GROUP BY {$t['job']}.id");
2066 $report['jobs'] = array();
2067 $report['event_totals'] = array();
2082 // initialize various counters
2083 foreach ($elements as $field) {
2084 $report['event_totals'][$field] = 0;
2087 while ($mailing->fetch()) {
2089 foreach ($elements as $field) {
2090 if (isset($mailing->$field)) {
2091 $row[$field] = $mailing->$field;
2092 $report['event_totals'][$field] +
= $mailing->$field;
2096 // compute open total separately to discount duplicates
2098 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
2099 $report['event_totals']['opened'] +
= $row['opened'];
2100 $row['total_opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
);
2101 $report['event_totals']['total_opened'] +
= $row['total_opened'];
2103 // compute unsub total separately to discount duplicates
2105 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
2106 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
2108 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
2109 $report['event_totals']['optout'] +
= $row['optout'];
2111 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
2112 $row[$field] = $mailing->$field;
2115 if ($mailing->queue
) {
2116 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2117 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2118 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2119 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2122 $row['delivered_rate'] = 0;
2123 $row['bounce_rate'] = 0;
2124 $row['unsubscribe_rate'] = 0;
2125 $row['optout_rate'] = 0;
2128 $row['links'] = array(
2129 'clicks' => CRM_Utils_System
::url(
2130 'civicrm/mailing/report/event',
2131 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2133 'queue' => CRM_Utils_System
::url(
2134 'civicrm/mailing/report/event',
2135 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2137 'delivered' => CRM_Utils_System
::url(
2138 'civicrm/mailing/report/event',
2139 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2141 'bounce' => CRM_Utils_System
::url(
2142 'civicrm/mailing/report/event',
2143 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2145 'unsubscribe' => CRM_Utils_System
::url(
2146 'civicrm/mailing/report/event',
2147 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2149 'forward' => CRM_Utils_System
::url(
2150 'civicrm/mailing/report/event',
2151 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2153 'reply' => CRM_Utils_System
::url(
2154 'civicrm/mailing/report/event',
2155 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2157 'opened' => CRM_Utils_System
::url(
2158 'civicrm/mailing/report/event',
2159 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2168 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2170 $report['jobs'][] = $row;
2173 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2175 // we need to do this for backward compatibility, since old mailings did not
2176 // use the mailing_recipients table
2177 if ($newTableSize > 0) {
2178 $report['event_totals']['queue'] = $newTableSize;
2181 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id, $mailing_id);
2184 if (!empty($report['event_totals']['queue'])) {
2185 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2186 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2187 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2188 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2191 $report['event_totals']['delivered_rate'] = 0;
2192 $report['event_totals']['bounce_rate'] = 0;
2193 $report['event_totals']['unsubscribe_rate'] = 0;
2194 $report['event_totals']['optout_rate'] = 0;
2197 /* Get the click-through totals, grouped by URL */
2200 SELECT {$t['url']}.url,
2202 COUNT({$t['urlopen']}.id) as clicks,
2203 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2205 LEFT JOIN {$t['urlopen']}
2206 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2207 LEFT JOIN {$t['queue']}
2208 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2209 LEFT JOIN {$t['job']}
2210 ON {$t['queue']}.job_id = {$t['job']}.id
2211 WHERE {$t['url']}.mailing_id = $mailing_id
2212 AND {$t['job']}.is_test = 0
2213 GROUP BY {$t['url']}.id");
2215 $report['click_through'] = array();
2217 while ($mailing->fetch()) {
2218 $report['click_through'][] = array(
2219 'url' => $mailing->url
,
2220 'link' => CRM_Utils_System
::url(
2221 'civicrm/mailing/report/event',
2222 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2224 'link_unique' => CRM_Utils_System
::url(
2225 'civicrm/mailing/report/event',
2226 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2228 'clicks' => $mailing->clicks
,
2229 'unique' => $mailing->unique_clicks
,
2230 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2231 'report' => CRM_Report_Utils_Report
::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2235 $report['event_totals']['links'] = array(
2236 'clicks' => CRM_Utils_System
::url(
2237 'civicrm/mailing/report/event',
2238 "reset=1&event=click&mid=$mailing_id"
2240 'clicks_unique' => CRM_Utils_System
::url(
2241 'civicrm/mailing/report/event',
2242 "reset=1&event=click&mid=$mailing_id&distinct=1"
2244 'queue' => CRM_Utils_System
::url(
2245 'civicrm/mailing/report/event',
2246 "reset=1&event=queue&mid=$mailing_id"
2248 'delivered' => CRM_Utils_System
::url(
2249 'civicrm/mailing/report/event',
2250 "reset=1&event=delivered&mid=$mailing_id"
2252 'bounce' => CRM_Utils_System
::url(
2253 'civicrm/mailing/report/event',
2254 "reset=1&event=bounce&mid=$mailing_id"
2256 'unsubscribe' => CRM_Utils_System
::url(
2257 'civicrm/mailing/report/event',
2258 "reset=1&event=unsubscribe&mid=$mailing_id"
2260 'optout' => CRM_Utils_System
::url(
2261 'civicrm/mailing/report/event',
2262 "reset=1&event=optout&mid=$mailing_id"
2264 'forward' => CRM_Utils_System
::url(
2265 'civicrm/mailing/report/event',
2266 "reset=1&event=forward&mid=$mailing_id"
2268 'reply' => CRM_Utils_System
::url(
2269 'civicrm/mailing/report/event',
2270 "reset=1&event=reply&mid=$mailing_id"
2272 'opened' => CRM_Utils_System
::url(
2273 'civicrm/mailing/report/event',
2274 "reset=1&event=opened&mid=$mailing_id"
2278 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2279 if (CRM_Core_Permission
::check('view all contacts')) {
2280 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2281 'name' => ts('Advanced Search'),
2282 'url' => 'civicrm/contact/search/advanced',
2285 $action = array_sum(array_keys($actionLinks));
2287 $report['event_totals']['actionlinks'] = array();
2300 $url = 'mailing/detail';
2301 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2302 $searchFilter = "force=1&mailing_id=%%mid%%";
2305 $reportFilter .= "&delivery_status_value=successful";
2306 $searchFilter .= "&mailing_delivery_status=Y";
2310 $url = "mailing/bounce";
2311 $searchFilter .= "&mailing_delivery_status=N";
2315 $reportFilter .= "&is_forwarded_value=1";
2316 $searchFilter .= "&mailing_forward=1";
2320 $reportFilter .= "&is_replied_value=1";
2321 $searchFilter .= "&mailing_reply_status=Y";
2325 $reportFilter .= "&is_unsubscribed_value=1";
2326 $searchFilter .= "&mailing_unsubscribe=1";
2330 $reportFilter .= "&is_optout_value=1";
2331 $searchFilter .= "&mailing_optout=1";
2335 $url = "mailing/opened";
2336 $searchFilter .= "&mailing_open_status=Y";
2340 case 'clicks_unique':
2341 $url = "mailing/clicks";
2342 $searchFilter .= "&mailing_click_status=Y";
2345 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2346 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2347 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2349 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2352 array('mid' => $mailing_id),
2355 'mailing.report.action',
2365 * Get the count of mailings.
2372 public function getCount() {
2374 $this->selectAdd('COUNT(id) as count');
2376 $session = CRM_Core_Session
::singleton();
2379 return $this->count
;
2387 public static function checkPermission($id) {
2392 $mailingIDs = self
::mailingACLIDs();
2393 if ($mailingIDs === TRUE) {
2397 if (!in_array($id, $mailingIDs)) {
2398 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2403 * @param null $alias
2407 public static function mailingACL($alias = NULL) {
2408 $mailingACL = " ( 0 ) ";
2410 $mailingIDs = self
::mailingACLIDs();
2411 if ($mailingIDs === TRUE) {
2415 if (!empty($mailingIDs)) {
2416 $mailingIDs = implode(',', $mailingIDs);
2417 $tableName = !$alias ? self
::getTableName() : $alias;
2418 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2424 * Returns all the mailings that this user can access. This is dependent on
2425 * all the groups that the user has access to.
2426 * However since most civi installs dont use ACL's we special case the condition
2427 * where the user has access to ALL groups, and hence ALL mailings and return a
2428 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2430 * @return bool|array
2431 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2433 public static function mailingACLIDs() {
2435 // optimize common case where admin has access
2438 CRM_Core_Permission
::check('view all contacts') ||
2439 CRM_Core_Permission
::check('edit all contacts')
2444 $mailingIDs = array();
2446 // get all the groups that this user can access
2447 // if they dont have universal access
2448 $groupNames = civicrm_api3('Group', 'get', array(
2450 'check_permissions' => TRUE,
2451 'return' => array('title', 'id'),
2452 'options' => array('limit' => 0),
2454 foreach ($groupNames['values'] as $group) {
2455 $groups[$group['id']] = $group['title'];
2457 if (!empty($groups)) {
2458 $groupIDs = implode(',', array_keys($groups));
2459 $domain_id = CRM_Core_Config
::domainID();
2461 // get all the mailings that are in this subset of groups
2463 SELECT DISTINCT( m.id ) as id
2464 FROM civicrm_mailing m
2465 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2466 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2467 OR ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2469 $dao = CRM_Core_DAO
::executeQuery($query);
2471 $mailingIDs = array();
2472 while ($dao->fetch()) {
2473 $mailingIDs[] = $dao->id
;
2475 //CRM-18181 Get all mailings that use the mailings found earlier as receipients
2476 if (!empty($mailingIDs)) {
2477 $mailings = implode(',', $mailingIDs);
2479 SELECT DISTINCT ( m.id ) as id
2480 FROM civicrm_mailing m
2481 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2482 WHERE g.entity_table like 'civicrm_mailing%' AND g.entity_id IN ($mailings)";
2483 $mailingDao = CRM_Core_DAO
::executeQuery($mailingQuery);
2484 while ($mailingDao->fetch()) {
2485 $mailingIDs[] = $mailingDao->id
;
2494 * Get the rows for a browse operation.
2496 * @param int $offset
2497 * The row number to start from.
2498 * @param int $rowCount
2499 * The nmber of rows to return.
2500 * @param string $sort
2501 * The sql string that describes the sort order.
2503 * @param null $additionalClause
2504 * @param array $additionalParams
2509 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2510 $mailing = self
::getTableName();
2511 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2512 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2513 $session = CRM_Core_Session
::singleton();
2515 $mailingACL = self
::mailingACL();
2517 //get all campaigns.
2518 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2520 "$mailing.id", "$mailing.name", "$job.status",
2521 "$mailing.approval_status_id", "createdContact.sort_name as created_by", "scheduledContact.sort_name as scheduled_by",
2522 "$mailing.created_id as created_id", "$mailing.scheduled_id as scheduled_id", "$mailing.is_archived as archived",
2523 "$mailing.created_date as created_date", "campaign_id", "$mailing.sms_provider_id as sms_provider_id",
2524 "$mailing.language",
2527 // we only care about parent jobs, since that holds all the info on
2529 $selectClause = implode(', ', $select);
2530 $groupFromSelect = CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($select, "$mailing.id");
2532 SELECT {$selectClause},
2533 MIN($job.scheduled_date) as scheduled_date,
2534 MIN($job.start_date) as start_date,
2535 MAX($job.end_date) as end_date
2537 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2538 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2539 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2540 WHERE $mailingACL $additionalClause";
2542 if (!empty($groupFromSelect)) {
2543 $query .= $groupFromSelect;
2547 $orderBy = trim($sort->orderBy());
2548 if (!empty($orderBy)) {
2549 $query .= " ORDER BY $orderBy";
2554 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2555 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2557 $query .= " LIMIT $offset, $rowCount ";
2560 if (!$additionalParams) {
2561 $additionalParams = array();
2564 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2567 while ($dao->fetch()) {
2570 'name' => $dao->name
,
2571 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2572 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2573 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2574 'scheduled_iso' => $dao->scheduled_date
,
2575 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2576 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2577 'created_by' => $dao->created_by
,
2578 'scheduled_by' => $dao->scheduled_by
,
2579 'created_id' => $dao->created_id
,
2580 'scheduled_id' => $dao->scheduled_id
,
2581 'archived' => $dao->archived
,
2582 'approval_status_id' => $dao->approval_status_id
,
2583 'campaign_id' => $dao->campaign_id
,
2584 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2585 'sms_provider_id' => $dao->sms_provider_id
,
2586 'language' => $dao->language
,
2593 * Show detail Mailing report.
2599 public static function showEmailDetails($id) {
2600 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2604 * Delete Mails and all its associated records.
2607 * Id of the mail to delete.
2611 public static function del($id) {
2613 CRM_Core_Error
::fatal();
2616 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2618 // delete all file attachments
2619 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2623 $dao = new CRM_Mailing_DAO_Mailing();
2627 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2629 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2633 * Delete Jobss and all its associated records
2634 * related to test Mailings
2637 * Id of the Job to delete.
2641 public static function delJob($id) {
2643 CRM_Core_Error
::fatal();
2646 $dao = new CRM_Mailing_BAO_MailingJob();
2654 public function getReturnProperties() {
2655 $tokens = &$this->getTokens();
2657 $properties = array();
2658 if (isset($tokens['html']) &&
2659 isset($tokens['html']['contact'])
2661 $properties = array_merge($properties, $tokens['html']['contact']);
2664 if (isset($tokens['text']) &&
2665 isset($tokens['text']['contact'])
2667 $properties = array_merge($properties, $tokens['text']['contact']);
2670 if (isset($tokens['subject']) &&
2671 isset($tokens['subject']['contact'])
2673 $properties = array_merge($properties, $tokens['subject']['contact']);
2676 $returnProperties = array();
2677 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2679 foreach ($properties as $p) {
2680 $returnProperties[$p] = 1;
2683 return $returnProperties;
2687 * Build the compose mail form.
2689 * @param CRM_Core_Form $form
2693 public static function commonCompose(&$form) {
2697 if (method_exists($form, 'listTokens')) {
2698 $tokens = array_merge($form->listTokens(), $tokens);
2701 //sorted in ascending order tokens by ignoring word case
2702 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2704 $templates = array();
2706 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2707 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2709 $className = CRM_Utils_System
::getClassName($form);
2711 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2712 $className != 'CRM_Contact_Form_Task_SMS'
2714 $form->add('wysiwyg', 'html_message',
2715 strstr($className, 'PDF') ?
ts('Document Body') : ts('HTML Format'),
2719 'onkeyup' => "return verify(this)",
2723 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2724 unset($modePrefixes['SMS']);
2728 unset($textFields['text_message']);
2729 unset($modePrefixes['Mail']);
2732 //insert message Text by selecting "Select Template option"
2733 foreach ($textFields as $id => $label) {
2735 if ($id == 'sms_text_message') {
2737 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2739 $form->add('textarea', $id, $label,
2743 'onkeyup' => "return verify(this, '{$prefix}')",
2748 foreach ($modePrefixes as $prefix) {
2749 if ($prefix == 'SMS') {
2750 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2753 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2755 if (!empty($templates[$prefix])) {
2756 $form->assign('templates', TRUE);
2758 $form->add('select', "{$prefix}template", ts('Use Template'),
2759 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2760 array('onChange' => "selectValue( this.value, '{$prefix}');")
2763 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2765 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2766 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2768 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2771 // I'm not sure this is ever called.
2772 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2773 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2774 $action == CRM_Core_Action
::VIEW
2776 $form->freeze('html_message');
2781 * Get the search based mailing Ids.
2784 * , searched base mailing ids.
2786 public function searchMailingIDs() {
2787 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2788 $mailing = self
::getTableName();
2791 SELECT $mailing.id as mailing_id
2792 FROM $mailing, $group
2793 WHERE $group.mailing_id = $mailing.id
2794 AND $group.group_type = 'Base'";
2796 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2797 $mailingIDs = array();
2798 while ($searchDAO->fetch()) {
2799 $mailingIDs[] = $searchDAO->mailing_id
;
2806 * Get the content/components of mailing based on mailing Id
2808 * @param array $report
2809 * of mailing report.
2812 * Reference of this.
2814 * @param bool $isSMS
2817 * array content/component.
2819 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2820 $htmlHeader = $textHeader = NULL;
2821 $htmlFooter = $textFooter = NULL;
2824 if ($report['mailing']['header_id']) {
2825 $header = new CRM_Mailing_BAO_Component();
2826 $header->id
= $report['mailing']['header_id'];
2827 $header->find(TRUE);
2828 $htmlHeader = $header->body_html
;
2829 $textHeader = $header->body_text
;
2832 if ($report['mailing']['footer_id']) {
2833 $footer = new CRM_Mailing_BAO_Component();
2834 $footer->id
= $report['mailing']['footer_id'];
2835 $footer->find(TRUE);
2836 $htmlFooter = $footer->body_html
;
2837 $textFooter = $footer->body_text
;
2841 $mailingKey = $form->_mailing_id
;
2843 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2844 $mailingKey = $hash;
2848 if (!empty($report['mailing']['body_text'])) {
2849 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2850 $form->assign('textViewURL', $url);
2854 if (!empty($report['mailing']['body_html'])) {
2855 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2856 $form->assign('htmlViewURL', $url);
2861 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2871 public static function overrideVerp($jobID) {
2872 static $_cache = array();
2874 if (!isset($_cache[$jobID])) {
2876 SELECT override_verp
2877 FROM civicrm_mailing
2878 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2879 WHERE civicrm_mailing_job.id = %1
2881 $params = array(1 => array($jobID, 'Integer'));
2882 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2884 return $_cache[$jobID];
2893 public static function processQueue($mode = NULL) {
2894 $config = CRM_Core_Config
::singleton();
2896 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2897 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(
2898 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2899 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/",
2903 // check if we are enforcing number of parallel cron jobs
2905 $gotCronLock = FALSE;
2907 $mailerJobsMax = Civi
::settings()->get('mailerJobsMax');
2908 if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2909 $lockArray = range(1, $mailerJobsMax);
2911 // Shuffle the array to improve chances of quickly finding an open thread
2912 shuffle($lockArray);
2914 // Check if we are using global locks
2915 foreach ($lockArray as $lockID) {
2916 $cronLock = Civi
::lockManager()->acquire("worker.mailing.send.{$lockID}");
2917 if ($cronLock->isAcquired()) {
2918 $gotCronLock = TRUE;
2923 // Exit here since we have enough mailing processes running
2924 if (!$gotCronLock) {
2925 CRM_Core_Error
::debug_log_message('Returning early, since the maximum number of mailing processes are running');
2929 if (getenv('CIVICRM_CRON_HOLD')) {
2930 // In testing, we may need to simulate some slow activities.
2931 sleep(getenv('CIVICRM_CRON_HOLD'));
2935 // Split up the parent jobs into multiple child jobs
2936 $mailerJobSize = Civi
::settings()->get('mailerJobSize');
2937 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2938 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2939 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2941 // Release the global lock if we do have one
2943 $cronLock->release();
2950 * @param int $mailingID
2952 private static function addMultipleEmails($mailingID) {
2954 INSERT INTO civicrm_mailing_recipients
2955 (mailing_id, email_id, contact_id)
2956 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2958 AND e.is_bulkmail = 1
2960 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2961 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2963 $params = array(1 => array($mailingID, 'Integer'));
2965 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2969 * @param bool $isSMS
2973 public static function getMailingsList($isSMS = FALSE) {
2974 static $list = array();
2977 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2980 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2985 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2986 FROM civicrm_mailing
2987 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2988 ORDER BY civicrm_mailing.name";
2989 $mailing = CRM_Core_DAO
::executeQuery($query);
2991 while ($mailing->fetch()) {
2992 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
3002 * @return null|string
3004 public static function hiddenMailingGroup($mid) {
3007 FROM civicrm_mailing m
3008 INNER JOIN civicrm_mailing_group mg ON mg.mailing_id = m.id
3009 INNER JOIN civicrm_group g ON mg.entity_id = g.id AND mg.entity_table = 'civicrm_group'
3010 WHERE g.is_hidden = 1
3011 AND mg.group_type = 'Include'
3014 $params = array(1 => array($mid, 'Integer'));
3015 return CRM_Core_DAO
::singleValueQuery($sql, $params);
3019 * wrapper for ajax activity selector.
3021 * @param array $params
3022 * Associated array for params record id.
3025 * associated array of contact activities
3027 public static function getContactMailingSelector(&$params) {
3028 // format the params
3029 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3030 $params['rowCount'] = $params['rp'];
3031 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3032 $params['caseId'] = NULL;
3034 // get contact mailings
3035 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
3038 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
3041 if (!empty($mailings)) {
3042 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
3043 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
3046 // format params and add links
3047 $contactMailings = array();
3048 foreach ($mailings as $mailingId => $values) {
3050 $mailing['subject'] = $values['subject'];
3051 $mailing['creator_name'] = CRM_Utils_System
::href(
3052 $values['creator_name'],
3053 'civicrm/contact/view',
3054 "reset=1&cid={$values['creator_id']}");
3055 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
3056 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
3057 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
3059 $mailing['openstats'] = "Opens: " .
3060 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
3062 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
3064 $actionLinks = array(
3065 CRM_Core_Action
::VIEW
=> array(
3066 'name' => ts('View'),
3067 'url' => 'civicrm/mailing/view',
3068 'qs' => "reset=1&id=%%mkey%%",
3069 'title' => ts('View Mailing'),
3070 'class' => 'crm-popup',
3072 CRM_Core_Action
::BROWSE
=> array(
3073 'name' => ts('Mailing Report'),
3074 'url' => 'civicrm/mailing/report',
3075 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
3076 'title' => ts('View Mailing Report'),
3080 $mailingKey = $values['mailing_id'];
3081 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
3082 $mailingKey = $hash;
3085 $mailing['links'] = CRM_Core_Action
::formLink(
3089 'mid' => $values['mailing_id'],
3090 'cid' => $params['contact_id'],
3091 'mkey' => $mailingKey,
3095 'mailing.contact.action',
3097 $values['mailing_id']
3100 array_push($contactMailings, $mailing);
3103 $contactMailingsDT = array();
3104 $contactMailingsDT['data'] = $contactMailings;
3105 $contactMailingsDT['recordsTotal'] = $params['total'];
3106 $contactMailingsDT['recordsFiltered'] = $params['total'];
3108 return $contactMailingsDT;
3112 * Retrieve contact mailing.
3114 * @param array $params
3117 * Array of mailings for a contact
3120 static public function getContactMailings(&$params) {
3121 $params['version'] = 3;
3122 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3123 $params['limit'] = $params['rp'];
3124 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3126 $result = civicrm_api('MailingContact', 'get', $params);
3127 return $result['values'];
3131 * Retrieve contact mailing count.
3133 * @param array $params
3136 * count of mailings for a contact
3139 static public function getContactMailingsCount(&$params) {
3140 $params['version'] = 3;
3141 return civicrm_api('MailingContact', 'getcount', $params);
3145 * Get a list of permissions required for CRUD'ing each field
3146 * (when workflow is enabled).
3149 * Array (string $fieldName => string $permName)
3151 public static function getWorkflowFieldPerms() {
3152 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3153 $fieldPerms = array();
3154 foreach ($fieldNames as $fieldName) {
3155 if ($fieldName == 'id') {
3156 $fieldPerms[$fieldName] = array(
3157 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3160 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3161 $fieldPerms[$fieldName] = array(
3162 array('access CiviMail', 'schedule mailings'), // OR
3165 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3166 $fieldPerms[$fieldName] = array(
3167 array('access CiviMail', 'approve mailings'), // OR
3171 $fieldPerms[$fieldName] = array(
3172 array('access CiviMail', 'create mailings'), // OR
3180 * White-list of possible values for the entity_table field.
3184 public static function mailingGroupEntityTables() {
3186 CRM_Contact_BAO_Group
::getTableName() => 'Group',
3187 CRM_Mailing_BAO_Mailing
::getTableName() => 'Mailing',
3192 * Get the public view url.
3195 * @param bool $absolute
3199 public static function getPublicViewUrl($id, $absolute = TRUE) {
3200 if ((civicrm_api3('Mailing', 'getvalue', array('id' => $id, 'return' => 'visibility'))) === 'Public Pages') {
3201 return CRM_Utils_System
::url('civicrm/mailing/view', array('id' => $id), $absolute, NULL, TRUE, TRUE);
3206 * Get a list of template types which can be used as `civicrm_mailing.template_type`.
3209 * A list of template-types, keyed numerically. Each defines:
3210 * - name: string, a short symbolic name
3211 * - editorUrl: string, Angular template name
3213 * Ex: $templateTypes[0] === array('name' => 'mosaico', 'editorUrl' => '~/crmMosaico/editor.html').
3215 public static function getTemplateTypes() {
3216 if (!isset(Civi
::$statics[__CLASS__
]['templateTypes'])) {
3219 'name' => 'traditional',
3220 'editorUrl' => CRM_Mailing_Info
::workflowEnabled() ?
'~/crmMailing/EditMailingCtrl/workflow.html' : '~/crmMailing/EditMailingCtrl/2step.html',
3224 CRM_Utils_Hook
::mailingTemplateTypes($types);
3226 $defaults = array('weight' => 0);
3227 foreach (array_keys($types) as $typeName) {
3228 $types[$typeName] = array_merge($defaults, $types[$typeName]);
3230 usort($types, function ($a, $b) {
3231 if ($a['weight'] === $b['weight']) {
3234 return $a['weight'] < $b['weight'] ?
-1 : 1;
3237 Civi
::$statics[__CLASS__
]['templateTypes'] = $types;
3240 return Civi
::$statics[__CLASS__
]['templateTypes'];
3244 * Get a list of template types.
3247 * Array(string $name => string $label).
3249 public static function getTemplateTypeNames() {
3251 foreach (self
::getTemplateTypes() as $type) {
3252 $r[$type['name']] = $type['name'];