3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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();
99 * @param int $mailingID
103 public static function getRecipientsCount($mailingID) {
104 //rebuild the recipients
105 self
::getRecipients($mailingID);
107 return civicrm_api3('MailingRecipients', 'getcount', array('mailing_id' => $mailingID));
111 * This function retrieve recipients of selected mailing groups.
113 * @param int $mailingID
117 public static function getRecipients($mailingID) {
118 // load mailing object
119 $mailingObj = new self();
120 $mailingObj->id
= $mailingID;
121 $mailingObj->find(TRUE);
123 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
124 $contact = CRM_Contact_DAO_Contact
::getTableName();
125 $isSMSmode = (!CRM_Utils_System
::isNull($mailingObj->sms_provider_id
));
127 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
128 $recipientsGroup = $excludeSmartGroupIDs = $includeSmartGroupIDs = $priorMailingIDs = array();
129 $dao = CRM_Utils_SQL_Select
::from('civicrm_mailing_group')
130 ->select('GROUP_CONCAT(entity_id SEPARATOR ",") as group_ids, group_type, entity_table')
131 ->where('mailing_id = #mailing_id AND entity_table RLIKE "^civicrm_(group.*|mailing)$" ')
132 ->groupBy(array('group_type', 'entity_table'))
133 ->param('!groupTableName', CRM_Contact_BAO_Group
::getTableName())
134 ->param('#mailing_id', $mailingID)
136 while ($dao->fetch()) {
137 if ($dao->entity_table
== 'civicrm_mailing') {
138 $priorMailingIDs[$dao->group_type
] = explode(',', $dao->group_ids
);
141 $recipientsGroup[$dao->group_type
] = empty($recipientsGroup[$dao->group_type
]) ?
explode(',', $dao->group_ids
) : array_merge($recipientsGroup[$dao->group_type
], explode(',', $dao->group_ids
));
145 // there is no need to proceed further if no mailing group is selected to include recipients,
146 // but before return clear the mailing recipients populated earlier since as per current params no group is selected
147 if (empty($recipientsGroup['Include']) && empty($priorMailingIDs['Include'])) {
148 CRM_Core_DAO
::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE mailing_id = %1 ", array(1 => array($mailingID, 'Integer')));
152 list($location_filter, $order_by) = self
::getLocationFilterAndOrderBy($mailingObj->email_selection_method
, $mailingObj->location_type_id
);
154 // get all the saved searches AND hierarchical groups
155 // and load them in the cache
156 foreach ($recipientsGroup as $groupType => $groupIDs) {
157 $groupDAO = CRM_Utils_SQL_Select
::from('civicrm_group')
158 ->where('id IN (#groupIDs)')
159 ->where('saved_search_id != 0 OR saved_search_id IS NOT NULL OR children IS NOT NULL')
160 ->param('#groupIDs', $groupIDs)
162 while ($groupDAO->fetch()) {
163 if ($groupDAO->cache_date
== NULL) {
164 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
166 if ($groupType == 'Include') {
167 $includeSmartGroupIDs[] = $groupDAO->id
;
169 elseif ($groupType == 'Exclude') {
170 $excludeSmartGroupIDs[] = $groupDAO->id
;
172 //NOTE: Do nothing for base
176 // Create a temp table for contact exclusion.
177 $excludeTempTablename = "excluded_recipients_temp" . substr(sha1(rand()), 0, 4);
178 $includedTempTablename = "included_recipients_temp" . substr(sha1(rand()), 0, 4);
179 $mailingGroup->query(
180 "CREATE TEMPORARY TABLE $excludeTempTablename
181 (contact_id int primary key)
184 // populate exclude temp-table with recipients to be excluded from the list
185 // on basis of selected recipients groups and/or previous mailing
186 if (!empty($recipientsGroup['Exclude'])) {
187 CRM_Utils_SQL_Select
::from('civicrm_group_contact')
188 ->select('DISTINCT contact_id')
189 ->where('status = "Added" AND group_id IN (#groups)')
190 ->param('#groups', $recipientsGroup['Exclude'])
191 ->insertInto($excludeTempTablename, array('contact_id'))
194 if (count($excludeSmartGroupIDs)) {
195 CRM_Utils_SQL_Select
::from('civicrm_group_contact_cache')
196 ->select('contact_id')
197 ->where('group_id IN (#groups)')
198 ->param('#groups', $excludeSmartGroupIDs)
199 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
203 if (!empty($priorMailingIDs['Exclude'])) {
204 CRM_Utils_SQL_Select
::from('civicrm_mailing_recipients')
205 ->select('DISTINCT contact_id')
206 ->where('mailing_id IN (#mailings)')
207 ->param('#mailings', $priorMailingIDs['Exclude'])
208 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
212 if (!empty($recipientsGroup['Base'])) {
213 CRM_Utils_SQL_Select
::from('civicrm_group_contact')
214 ->select('DISTINCT contact_id')
215 ->where('status = "Removed" AND group_id IN (#groups)')
216 ->param('#groups', $recipientsGroup['Base'])
217 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
221 $entityColumn = $isSMSmode ?
'phone_id' : 'email_id';
222 $entityTable = $isSMSmode ? CRM_Core_DAO_Phone
::getTableName() : CRM_Core_DAO_Email
::getTableName();
223 // Get all the group contacts we want to include.
224 $mailingGroup->query(
225 "CREATE TEMPORARY TABLE $includedTempTablename
226 (contact_id int primary key, $entityColumn int)
232 'is_opt_out' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_opt_out = 0"),
233 'is_deceased' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_deceased <> 1"),
234 'do_not_sms' => CRM_Utils_SQL_Select
::fragment()->where("$contact.do_not_sms = 0"),
235 'location_filter' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone_type_id = " . CRM_Core_PseudoConstant
::getKey('CRM_Core_DAO_Phone', 'phone_type_id', 'Mobile')),
236 'phone_not_null' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone IS NOT NULL"),
237 'phone_not_empty' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone != ''"),
238 'is_primary' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.is_primary = 1"),
239 'mailing_id' => CRM_Utils_SQL_Select
::fragment()->where("mg.mailing_id = #mailingID"),
240 'temp_contact_null' => CRM_Utils_SQL_Select
::fragment()->where('temp.contact_id IS null'),
241 'order_by' => CRM_Utils_SQL_Select
::fragment()->orderBy("$entityTable.is_primary = 1"),
245 // Criterias to filter recipients that need to be included
247 'do_not_email' => CRM_Utils_SQL_Select
::fragment()->where("$contact.do_not_email = 0"),
248 'is_opt_out' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_opt_out = 0"),
249 'is_deceased' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_deceased <> 1"),
250 'location_filter' => CRM_Utils_SQL_Select
::fragment()->where($location_filter),
251 'email_not_null' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.email IS NOT NULL"),
252 'email_not_empty' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.email != ''"),
253 'email_not_on_hold' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.on_hold = 0"),
254 'mailing_id' => CRM_Utils_SQL_Select
::fragment()->where("mg.mailing_id = #mailingID"),
255 'temp_contact_null' => CRM_Utils_SQL_Select
::fragment()->where('temp.contact_id IS NULL'),
256 'order_by' => CRM_Utils_SQL_Select
::fragment()->orderBy($order_by),
260 // Allow user to alter query responsible to fetch mailing recipients before build,
261 // by changing the mail filters identified $params
262 CRM_Utils_Hook
::alterMailingRecipients($mailingObj, $criteria, 'pre');
264 // Get the group contacts, but only those which are not in the
265 // exclusion temp table.
266 if (!empty($recipientsGroup['Include'])) {
267 CRM_Utils_SQL_Select
::from($entityTable)
268 ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
269 ->join($contact, " INNER JOIN $contact ON $entityTable.contact_id = $contact.id ")
270 ->join('gc', " INNER JOIN civicrm_group_contact gc ON gc.contact_id = $contact.id ")
271 ->join('mg', " INNER JOIN civicrm_mailing_group mg ON gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
272 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
273 ->where('gc.group_id IN (#groups) AND gc.status = "Added"')
275 ->groupBy(array("$contact.id", "$entityTable.id"))
276 ->replaceInto($includedTempTablename, array('contact_id', $entityColumn))
277 ->param('#groups', $recipientsGroup['Include'])
278 ->param('#mailingID', $mailingID)
282 // Get recipients selected in prior mailings
283 if (!empty($priorMailingIDs['Include'])) {
284 CRM_Utils_SQL_Select
::from('civicrm_mailing_recipients')
285 ->select("DISTINCT civicrm_mailing_recipients.contact_id, $entityColumn")
286 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON civicrm_mailing_recipients.contact_id = temp.contact_id ")
287 ->where('mailing_id IN (#mailings)')
288 ->where('temp.contact_id IS NULL')
289 ->param('#mailings', $priorMailingIDs['Include'])
290 ->insertIgnoreInto($includedTempTablename, array('contact_id', $entityColumn))
294 if (count($includeSmartGroupIDs)) {
295 $query = CRM_Utils_SQL_Select
::from($contact)
296 ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
297 ->join($entityTable, " INNER JOIN $entityTable ON $entityTable.contact_id = $contact.id ")
298 ->join('gc', " INNER JOIN civicrm_group_contact_cache gc ON $contact.id = gc.contact_id ")
299 ->join('mg', " INNER JOIN civicrm_mailing_group mg ON gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
300 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
301 ->where('gc.group_id IN (#groups)')
303 ->replaceInto($includedTempTablename, array('contact_id', $entityColumn))
304 ->param('#groups', $includeSmartGroupIDs)
305 ->param('#mailingID', $mailingID)
309 // Construct the filtered search queries.
310 $dao = CRM_Utils_SQL_Select
::from('civicrm_mailing_group')
311 ->select('search_id, search_args, entity_id')
312 ->where('search_id IS NOT NULL AND mailing_id = #mailingID')
313 ->param('#mailingID', $mailingID)
315 while ($dao->fetch()) {
316 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
320 $query = "REPLACE INTO {$includedTempTablename} ($entityColumn, contact_id) {$customSQL} ";
321 $mailingGroup->query($query);
324 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
326 // clear all the mailing recipients before populating
327 CRM_Core_DAO
::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE mailing_id = %1 ", array(1 => array($mailingID, 'Integer')));
329 $selectClause = array('#mailingID', 'i.contact_id', "i.$entityColumn");
331 $orderBy = array("i.contact_id", "i.$entityColumn");
333 $query = CRM_Utils_SQL_Select
::from('civicrm_contact contact_a')->join('i', " INNER JOIN {$includedTempTablename} i ON contact_a.id = i.contact_id ");
334 if (!$isSMSmode && $mailingObj->dedupe_email
) {
335 $orderBy = array("MIN(i.contact_id)", "MIN(i.$entityColumn)");
336 $query = $query->join('e', " INNER JOIN civicrm_email e ON e.id = i.email_id ")->groupBy("e.email");
337 if (CRM_Utils_SQL
::supportsFullGroupBy()) {
338 $selectClause = array('#mailingID', 'ANY_VALUE(i.contact_id) contact_id', "ANY_VALUE(i.$entityColumn) $entityColumn", "e.email");
342 $query = $query->select($selectClause)->orderBy($orderBy);
343 if (!CRM_Utils_System
::isNull($aclFrom)) {
344 $query = $query->join('acl', $aclFrom);
346 if (!CRM_Utils_System
::isNull($aclWhere)) {
347 $query = $query->where($aclWhere);
350 // this mean if dedupe_email AND the mysql 5.7 supports ONLY_FULL_GROUP_BY mode then as
351 // SELECT must contain 'email' column as its used in GROUP BY, so in order to resolve This
352 // here the whole SQL code is wrapped up in FROM table i and not selecting email column for INSERT
353 if ($key = array_search('e.email', $selectClause)) {
354 unset($selectClause[$key]);
355 $sql = $query->toSQL();
356 CRM_Utils_SQL_Select
::from("( $sql ) AS i ")
357 ->select($selectClause)
358 ->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
359 ->param('#mailingID', $mailingID)
363 $query->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
364 ->param('#mailingID', $mailingID)
368 // if we need to add all emails marked bulk, do it as a post filter
369 // on the mailing recipients table
370 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
371 self
::addMultipleEmails($mailingID);
374 // Delete the temp table.
375 $mailingGroup->reset();
376 $mailingGroup->query(" DROP TEMPORARY TABLE $excludeTempTablename ");
377 $mailingGroup->query(" DROP TEMPORARY TABLE $includedTempTablename ");
379 CRM_Utils_Hook
::alterMailingRecipients($mailingObj, $criteria, 'post');
383 * Function to retrieve location filter and order by clause later used by SQL query that is used to fetch and include mailing recipients
385 * @param string $email_selection_method
386 * @param int $location_type_id
390 public static function getLocationFilterAndOrderBy($email_selection_method, $location_type_id) {
391 $email = CRM_Core_DAO_Email
::getTableName();
392 // Note: When determining the ORDER that results are returned, it's
393 // the record that comes last that counts. That's because we are
394 // INSERT'ing INTO a table with a primary id so that last record
395 // over writes any previous record.
396 switch ($email_selection_method) {
397 case 'location-exclude':
398 $location_filter = "($email.location_type_id != $location_type_id)";
399 // If there is more than one email that doesn't match the location,
400 // prefer the one marked is_bulkmail, followed by is_primary.
401 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
404 case 'location-only':
405 $location_filter = "($email.location_type_id = $location_type_id)";
406 // If there is more than one email of the desired location, prefer
407 // the one marked is_bulkmail, followed by is_primary.
408 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
411 case 'location-prefer':
412 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
413 // ORDER BY is more complicated because we have to set an arbitrary
414 // order that prefers the location that we want. We do that using
415 // the FIELD function. For more info, see:
416 // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
417 // We assign the location type we want the value "1" by putting it
418 // in the first position after we name the field. All other location
419 // types are left out, so they will be assigned the value 0. That
420 // means, they will all be equally tied for first place, with our
421 // location being last.
422 $orderBy = array("FIELD($email.location_type_id, $location_type_id)", "$email.is_bulkmail", "$email.is_primary");
426 // fall through to default
428 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
429 $orderBy = array("$email.is_bulkmail");
432 return array($location_filter, $orderBy);
436 * @param string $type
440 private function _getMailingGroupIds($type = 'Include') {
441 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
442 $group = CRM_Contact_DAO_Group
::getTableName();
443 if (!isset($this->id
)) {
444 // we're just testing tokens, so return any group
445 $query = "SELECT id AS entity_id
451 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
452 $query = "SELECT entity_id
454 WHERE mailing_id = {$this->id}
455 AND group_type = '$type'
456 AND entity_table = '$group'";
458 $mailingGroup->query($query);
461 while ($mailingGroup->fetch()) {
462 $groupIds[] = $mailingGroup->entity_id
;
469 * Returns the regex patterns that are used for preparing the text and html templates.
471 * @param bool $onlyHrefs
473 * @return array|string
475 private function getPatterns($onlyHrefs = FALSE) {
479 $protos = '(https?|ftp|mailto)';
481 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
483 $any = "{$letters}{$gunk}{$punc}";
485 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
488 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
491 $patterns[] = $pattern;
492 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
493 $patterns[] = '\{\w+\.\w+\}';
495 $patterns = '{' . implode('|', $patterns) . '}imu';
501 * Returns an array that denotes the type of token that we are dealing with
502 * we use the type later on when we are doing a token replacement lookup
504 * @param string $token
505 * The token for which we will be doing adata lookup.
508 * An array that holds the token itself and the type.
509 * the type will tell us which function to use for the data lookup
510 * if we need to do a lookup at all
512 public function &getDataFunc($token) {
513 static $_categories = NULL;
514 static $_categoryString = NULL;
516 $_categories = array(
523 CRM_Utils_Hook
::tokens($_categories);
524 $_categoryString = implode('|', array_keys($_categories));
527 $funcStruct = array('type' => NULL, 'token' => $token);
529 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
530 // it is a url so we need to check to see if there are any tokens embedded
531 // if so then call this function again to get the token dataFunc
532 // and assign the type 'embedded' so that the data retrieving function
533 // will know what how to handle this token.
534 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
535 $funcStruct['type'] = 'embedded_url';
536 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
537 foreach ($matches[1] as $match) {
538 $preg_token = '/' . preg_quote($match, '/') . '/';
539 $list = preg_split($preg_token, $token, 2);
540 $funcStruct['embed_parts'][] = $list[0];
542 $funcStruct['token'][] = $this->getDataFunc($match);
544 // fixed truncated url, CRM-7113
546 $funcStruct['embed_parts'][] = $token;
550 $funcStruct['type'] = 'url';
553 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
554 $funcStruct['type'] = $matches[1];
555 $funcStruct['token'] = $matches[2];
557 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
558 // we are an escaped token
559 // so remove the escape chars
560 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
561 $funcStruct['token'] = '{' . $unescaped_token . '}';
567 * Prepares the text and html templates
568 * for generating the emails and returns a copy of the
572 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
574 private function getPreparedTemplates() {
575 if (!$this->preparedTemplates
) {
576 $patterns['html'] = $this->getPatterns(TRUE);
577 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
578 $templates = $this->getTemplates();
580 $this->preparedTemplates
= array();
587 if (!isset($templates[$key])) {
593 $split_template = array();
595 $email = $templates[$key];
596 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
597 foreach ($matches[0] as $idx => $token) {
598 $preg_token = '/' . preg_quote($token, '/') . '/im';
599 list($split_template[], $email) = preg_split($preg_token, $email, 2);
600 array_push($tokens, $this->getDataFunc($token));
603 $split_template[] = $email;
605 $this->preparedTemplates
[$key]['template'] = $split_template;
606 $this->preparedTemplates
[$key]['tokens'] = $tokens;
609 return ($this->preparedTemplates
);
613 * Retrieve a ref to an array that holds the email and text templates for this email
614 * assembles the complete template including the header and footer
615 * that the user has uploaded or declared (if they have done that)
618 * reference to an assoc array
620 public function getTemplates() {
621 if (!$this->templates
) {
622 $this->getHeaderFooter();
623 $this->templates
= array();
624 if ($this->body_text ||
!empty($this->header
)) {
626 if (!empty($this->header
->body_text
)) {
627 $template[] = $this->header
->body_text
;
629 elseif (!empty($this->header
->body_html
)) {
630 $template[] = CRM_Utils_String
::htmlToText($this->header
->body_html
);
633 if ($this->body_text
) {
634 $template[] = $this->body_text
;
637 $template[] = CRM_Utils_String
::htmlToText($this->body_html
);
640 if (!empty($this->footer
->body_text
)) {
641 $template[] = $this->footer
->body_text
;
643 elseif (!empty($this->footer
->body_html
)) {
644 $template[] = CRM_Utils_String
::htmlToText($this->footer
->body_html
);
647 $this->templates
['text'] = implode("\n", $template);
650 // To check for an html part strip tags
651 if (trim(strip_tags($this->body_html
, '<img>'))) {
655 $template[] = $this->header
->body_html
;
658 $template[] = $this->body_html
;
661 $template[] = $this->footer
->body_html
;
664 $this->templates
['html'] = implode("\n", $template);
666 // this is where we create a text template from the html template if the text template did not exist
667 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
668 // user uploads an html email only
669 if (empty($this->templates
['text'])) {
670 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
674 if ($this->subject
) {
676 $template[] = $this->subject
;
677 $this->templates
['subject'] = implode("\n", $template);
680 CRM_Utils_Hook
::alterMailContent($this->templates
);
682 return $this->templates
;
687 * Retrieve a ref to an array that holds all of the tokens in the email body
688 * where the keys are the type of token and the values are ordinal arrays
689 * that hold the token names (even repeated tokens) in the order in which
690 * they appear in the body of the email.
692 * note: the real work is done in the _getTokens() function
694 * this function needs to have some sort of a body assigned
695 * either text or html for this to have any meaningful impact
698 * reference to an assoc array
700 public function &getTokens() {
701 if (!$this->tokens
) {
703 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
705 if ($this->body_html
) {
706 $this->_getTokens('html');
707 if (!$this->body_text
) {
708 // Since the text template was created from html, use the html tokens.
709 // @see CRM_Mailing_BAO_Mailing::getTemplates()
710 $this->tokens
['text'] = $this->tokens
['html'];
714 if ($this->body_text
) {
715 $this->_getTokens('text');
718 if ($this->subject
) {
719 $this->_getTokens('subject');
723 return $this->tokens
;
727 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
728 * hook in one call and standardizes it across other token workflows
731 * reference to an assoc array
733 public function &getFlattenedTokens() {
734 if (!$this->flattenedTokens
) {
735 $tokens = $this->getTokens();
737 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
740 return $this->flattenedTokens
;
745 * _getTokens parses out all of the tokens that have been
746 * included in the html and text bodies of the email
747 * we get the tokens and then separate them into an
748 * internal structure named tokens that has the same
749 * form as the static tokens property(?) of the CRM_Utils_Token class.
750 * The difference is that there might be repeated token names as we want the
751 * structures to represent the order in which tokens were found from left to right, top to bottom.
754 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
755 * Name of the property that holds the text that we want to scan for tokens (html, text).
759 private function _getTokens($prop) {
760 $templates = $this->getTemplates();
762 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
764 foreach ($newTokens as $type => $names) {
765 if (!isset($this->tokens
[$prop][$type])) {
766 $this->tokens
[$prop][$type] = array();
768 foreach ($names as $key => $name) {
769 $this->tokens
[$prop][$type][] = $name;
775 * Generate an event queue for a test job.
777 * @param array $testParams
778 * Contains form values.
782 public function getTestRecipients($testParams) {
783 if (!empty($testParams['test_group']) && array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
784 $contacts = civicrm_api('contact', 'get', array(
786 'group' => $testParams['test_group'],
789 'limit' => 100000000000,
794 foreach (array_keys($contacts['values']) as $groupContact) {
796 SELECT civicrm_email.id AS email_id,
797 civicrm_email.is_primary as is_primary,
798 civicrm_email.is_bulkmail as is_bulkmail
800 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
801 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
802 AND civicrm_contact.id = {$groupContact}
803 AND civicrm_contact.do_not_email = 0
804 AND civicrm_contact.is_deceased <> 1
805 AND civicrm_email.on_hold = 0
806 AND civicrm_contact.is_opt_out = 0
807 GROUP BY civicrm_email.id
808 ORDER BY civicrm_email.is_bulkmail DESC
810 $dao = CRM_Core_DAO
::executeQuery($query);
813 'job_id' => $testParams['job_id'],
814 'email_id' => $dao->email_id
,
815 'contact_id' => $groupContact,
817 CRM_Mailing_Event_BAO_Queue
::create($params);
824 * Load this->header and this->footer.
826 private function getHeaderFooter() {
827 if (!$this->header
and $this->header_id
) {
828 $this->header
= new CRM_Mailing_BAO_Component();
829 $this->header
->id
= $this->header_id
;
830 $this->header
->find(TRUE);
831 $this->header
->free();
834 if (!$this->footer
and $this->footer_id
) {
835 $this->footer
= new CRM_Mailing_BAO_Component();
836 $this->footer
->id
= $this->footer_id
;
837 $this->footer
->find(TRUE);
838 $this->footer
->free();
843 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
844 * add a Message-ID header if needed.
846 * i.e. if the global includeMessageId is set and there isn't already a
847 * Message-ID in the array.
848 * The message ID is structured the same way as a verp. However no interpretation
849 * is placed on the values received, so they do not need to follow the verp
852 * @param array $headers
853 * Array of message headers to update, in-out.
854 * @param string $prefix
855 * Prefix for the message ID, use same prefixes as verp.
857 * @param string $job_id
858 * Job ID component of the generated message ID.
859 * @param string $event_queue_id
860 * Event Queue ID component of the generated message ID.
861 * @param string $hash
862 * Hash component of the generated message ID.
866 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
867 $config = CRM_Core_Config
::singleton();
868 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
869 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
870 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
872 $fields[] = 'Message-ID';
873 // CRM-17754 check if Resent-Message-id is set also if not add it in when re-laying reply email
874 if ($prefix == 'r') {
875 $fields[] = 'Resent-Message-ID';
877 foreach ($fields as $field) {
878 if ($includeMessageId && (!array_key_exists($field, $headers))) {
879 $headers[$field] = '<' . implode($config->verpSeparator
,
881 $localpart . $prefix,
886 ) . "@{$emailDomain}>";
893 * Static wrapper for getting verp and urls.
896 * ID of the Job associated with this message.
897 * @param int $event_queue_id
898 * ID of the EventQueue.
899 * @param string $hash
900 * Hash of the EventQueue.
901 * @param string $email
902 * Destination address.
905 * (reference) array array ref that hold array refs to the verp info and urls
907 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
908 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
909 $config = CRM_Core_Config
::singleton();
910 $bao = new CRM_Mailing_BAO_Mailing();
911 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
912 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
914 // use $bao's instance method to get verp and urls
915 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
916 return array($verp, $urls);
920 * Get verp, urls and headers
923 * ID of the Job associated with this message.
924 * @param int $event_queue_id
925 * ID of the EventQueue.
926 * @param string $hash
927 * Hash of the EventQueue.
928 * @param string $email
929 * Destination address.
931 * @param bool $isForward
934 * array ref that hold array refs to the verp info, urls, and headers
936 public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
937 $config = CRM_Core_Config
::singleton();
941 * reply: user replied to mailing
942 * bounce: email address bounced
943 * unsubscribe: contact opts out of all target lists for the mailing
944 * resubscribe: contact opts back into all target lists for the mailing
945 * optOut: contact unsubscribes from the domain
951 'unsubscribe' => 'u',
952 'resubscribe' => 'e',
956 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
957 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
958 // 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
959 if (empty($emailDomain)) {
960 CRM_Core_Error
::debug_log_message('Error setting verp parameters, defaultDomain is NULL. Did you configure the bounce processing account for this domain?');
963 foreach ($verpTokens as $key => $value) {
964 $verp[$key] = implode($config->verpSeparator
,
974 //handle should override VERP address.
978 self
::overrideVerp($job_id)
980 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
984 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
985 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
986 TRUE, NULL, TRUE, TRUE
988 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
989 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
990 TRUE, NULL, TRUE, TRUE
992 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
993 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
994 TRUE, NULL, TRUE, TRUE
996 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
997 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
998 TRUE, NULL, TRUE, TRUE
1000 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1002 TRUE, NULL, TRUE, TRUE
1007 'Reply-To' => $verp['reply'],
1008 'Return-Path' => $verp['bounce'],
1009 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1010 'Subject' => $this->subject
,
1011 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1013 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1015 $headers['Subject'] = "[Fwd:{$this->subject}]";
1017 return array(&$verp, &$urls, &$headers);
1021 * Compose a message.
1024 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1025 * @param int $job_id
1026 * ID of the Job associated with this message.
1027 * @param int $event_queue_id
1028 * ID of the EventQueue.
1029 * @param string $hash
1030 * Hash of the EventQueue.
1031 * @param string $contactId
1032 * ID of the Contact.
1033 * @param string $email
1034 * Destination address.
1035 * @param string $recipient
1036 * To: of the recipient.
1038 * Is this mailing a test?.
1039 * @param $contactDetails
1040 * @param $attachments
1041 * @param bool $isForward
1042 * Is this mailing compose for forward?.
1043 * @param string $fromEmail
1044 * Email address of who is forwardinf it.
1046 * @param null $replyToEmail
1048 * @return Mail_mime The mail object
1050 public function compose(
1051 $job_id, $event_queue_id, $hash, $contactId,
1052 $email, &$recipient, $test,
1053 $contactDetails, &$attachments, $isForward = FALSE,
1054 $fromEmail = NULL, $replyToEmail = NULL
1056 $config = CRM_Core_Config
::singleton();
1059 if ($this->_domain
== NULL) {
1060 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1063 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1071 //set from email who is forwarding it and not original one.
1073 unset($headers['From']);
1074 $headers['From'] = "<{$fromEmail}>";
1077 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1078 $headers['Reply-To'] = "{$replyToEmail}";
1081 if ($contactDetails) {
1082 $contact = $contactDetails;
1084 elseif ($contactId === 0) {
1087 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1090 $params = array(array('contact_id', '=', $contactId, 0, 0));
1091 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1094 $contact = reset($contact);
1096 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1097 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1098 array(1 => $contactId)
1100 // setting this because function is called by reference
1101 //@todo test not calling function by reference
1106 // also call the hook to get contact details
1107 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1110 $pTemplates = $this->getPreparedTemplates();
1113 foreach ($pTemplates as $type => $pTemplate) {
1114 $html = ($type == 'html') ?
TRUE : FALSE;
1115 $pEmails[$type] = array();
1116 $pEmail = &$pEmails[$type];
1117 $template = &$pTemplates[$type]['template'];
1118 $tokens = &$pTemplates[$type]['tokens'];
1120 if (!empty($tokens)) {
1121 foreach ($tokens as $idx => $token) {
1122 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1123 array_push($pEmail, $template[$idx]);
1124 array_push($pEmail, $token_data);
1128 array_push($pEmail, $template[$idx]);
1131 if (isset($template[($idx +
1)])) {
1132 array_push($pEmail, $template[($idx +
1)]);
1137 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1138 $html = &$pEmails['html'];
1142 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1143 $text = &$pEmails['text'];
1146 // push the tracking url on to the html email if necessary
1147 if ($this->open_tracking
&& $html) {
1148 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1149 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1153 $message = new Mail_mime("\n");
1155 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1157 $smarty = CRM_Core_Smarty
::singleton();
1158 // also add the contact tokens to the template
1159 $smarty->assign_by_ref('contact', $contact);
1162 $mailParams = $headers;
1163 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1164 $contact['preferred_mail_format'] == 'Both' ||
1165 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1168 $textBody = implode('', $text);
1170 $textBody = $smarty->fetch("string:$textBody");
1172 $mailParams['text'] = $textBody;
1175 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1176 $contact['preferred_mail_format'] == 'Both'
1179 $htmlBody = implode('', $html);
1181 $htmlBody = $smarty->fetch("string:$htmlBody");
1183 $mailParams['html'] = $htmlBody;
1186 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1188 // something went wrong, lets log it and return null (by reference)
1189 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1196 $mailParams['attachments'] = $attachments;
1198 $mailParams['Subject'] = CRM_Utils_Array
::value('subject', $pEmails);
1199 if (is_array($mailParams['Subject'])) {
1200 $mailParams['Subject'] = implode('', $mailParams['Subject']);
1203 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1206 $mailParams['toEmail'] = $email;
1208 // Add job ID to mailParams for external email delivery service to utilise
1209 $mailParams['job_id'] = $job_id;
1211 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1213 // CRM-10699 support custom email headers
1214 if (!empty($mailParams['headers'])) {
1215 $headers = array_merge($headers, $mailParams['headers']);
1217 //cycle through mailParams and set headers array
1218 foreach ($mailParams as $paramKey => $paramValue) {
1219 //exclude values not intended for the header
1220 if (!in_array($paramKey, array(
1228 $headers[$paramKey] = $paramValue;
1232 if (!empty($mailParams['text'])) {
1233 $message->setTxtBody($mailParams['text']);
1236 if (!empty($mailParams['html'])) {
1237 $message->setHTMLBody($mailParams['html']);
1240 if (!empty($mailParams['attachments'])) {
1241 foreach ($mailParams['attachments'] as $fileID => $attach) {
1242 $message->addAttachment($attach['fullPath'],
1243 $attach['mime_type'],
1244 $attach['cleanName']
1249 //pickup both params from mail params.
1250 $toName = trim($mailParams['toName']);
1251 $toEmail = trim($mailParams['toEmail']);
1252 if ($toName == $toEmail ||
1253 strpos($toName, '@') !== FALSE
1258 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1261 $headers['To'] = "$toName <$toEmail>";
1263 $headers['Precedence'] = 'bulk';
1264 // Will test in the mail processor if the X-VERP is set in the bounced email.
1265 // (As an option to replace real VERP for those that can't set it up)
1266 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1269 //token replacement of subject
1270 $headers['Subject'] = $mailParams['Subject'];
1272 CRM_Utils_Mail
::setMimeParams($message);
1273 $headers = $message->headers($headers);
1275 //get formatted recipient
1276 $recipient = $headers['To'];
1278 // make sure we unset a lot of stuff
1291 * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
1294 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1295 * @param CRM_Mailing_BAO_Mailing $mailing
1297 public static function tokenReplace(&$mailing) {
1298 $domain = CRM_Core_BAO_Domain
::getDomain();
1300 foreach (array('text', 'html') as $type) {
1301 $tokens = $mailing->getTokens();
1302 if (isset($mailing->templates
[$type])) {
1303 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1304 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1305 $mailing->templates
[$type],
1307 $type == 'html' ?
TRUE : FALSE,
1310 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1316 * Get data to resolve tokens.
1319 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1321 * @param array $token_a
1323 * Whether to encode the token result for use in HTML email
1324 * @param array $contact
1325 * @param string $verp
1326 * @param array $urls
1327 * @param int $event_queue_id
1329 * @return bool|mixed|null|string
1331 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1332 $type = $token_a['type'];
1333 $token = $token_a['token'];
1336 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1338 if ($type == 'embedded_url') {
1339 $embed_data = array();
1340 foreach ($token as $t) {
1341 $embed_data[] = $this->getTokenData($t, $html, $contact, $verp, $urls, $event_queue_id);
1343 $numSlices = count($embed_data);
1345 for ($i = 0; $i < $numSlices; $i++
) {
1346 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1348 if (isset($token_a['embed_parts'][$numSlices])) {
1349 $url .= $token_a['embed_parts'][$numSlices];
1351 // add trailing quote since we've gobbled it up in a previous regex
1352 // function getPatterns, line 431
1353 if (preg_match("/^href[ ]*=[ ]*'.*[^']$/", $url)) {
1356 elseif (preg_match('/^href[ ]*=[ ]*".*[^"]$/', $url)) {
1360 // CRM-20206 Fix ampersand encoding in plain text emails
1362 $data = CRM_Utils_String
::unstupifyUrl($data);
1365 elseif ($type == 'url') {
1366 if ($this->url_tracking
) {
1367 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1368 if (!empty($html)) {
1369 $data = htmlentities($data, ENT_NOQUOTES
);
1376 elseif ($type == 'contact') {
1377 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1379 elseif ($type == 'action') {
1380 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1382 elseif ($type == 'domain') {
1383 $domain = CRM_Core_BAO_Domain
::getDomain();
1384 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1386 elseif ($type == 'mailing') {
1387 if ($token == 'name') {
1388 $data = $this->name
;
1390 elseif ($token == 'group') {
1391 $groups = $this->getGroupNames();
1392 $data = implode(', ', $groups);
1396 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1402 * Return a list of group names for this mailing. Does not work with
1403 * prior-mailing targets.
1406 * Names of groups receiving this mailing
1408 public function &getGroupNames() {
1409 if (!isset($this->id
)) {
1412 $mg = new CRM_Mailing_DAO_MailingGroup();
1413 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1414 $group = CRM_Contact_BAO_Group
::getTableName();
1416 $mg->query("SELECT $group.title as name FROM $mgtable
1417 INNER JOIN $group ON $mgtable.entity_id = $group.id
1418 WHERE $mgtable.mailing_id = {$this->id}
1419 AND $mgtable.entity_table = '$group'
1420 AND $mgtable.group_type = 'Include'
1421 ORDER BY $group.name");
1424 while ($mg->fetch()) {
1425 $groups[] = $mg->name
;
1434 * @param array $params
1435 * Reference array contains the values submitted by the form.
1437 * Reference array contains the id.
1440 * @return CRM_Mailing_DAO_Mailing
1442 public static function add(&$params, $ids = array()) {
1443 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('mailing_id', $ids));
1445 if (empty($params['id']) && !empty($ids)) {
1446 \Civi
::log('Parameter $ids is no longer used by Mailing::add. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1450 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1453 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1456 $mailing = new static();
1459 $mailing->find(TRUE);
1461 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1463 if (((!$id && empty($params['replyto_email'])) ||
!isset($params['replyto_email'])) &&
1464 isset($params['from_email'])
1466 $params['replyto_email'] = $params['from_email'];
1468 $mailing->copyValues($params);
1470 // CRM-20892 Unset Modifed Date here so that MySQL can correctly set an updated modfied date.
1471 unset($mailing->modified_date
);
1472 $result = $mailing->save();
1474 // CRM-20892 Re find record after saing so we can set the updated modified date in the result.
1475 $mailing->find(TRUE);
1477 if (isset($mailing->modified_date
)) {
1478 $result->modified_date
= $mailing->modified_date
;
1482 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1485 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1492 * Construct a new mailing object, along with job and mailing_group
1493 * objects, from the form values of the create mailing wizard.
1495 * This function is a bit evil. It not only merges $params and saves
1496 * the mailing -- it also schedules the mailing and chooses the recipients.
1497 * Since it merges $params, it's also the only place to correctly trigger
1498 * multi-field validation. It should be broken up.
1500 * In the mean time, use-cases which break under the weight of this
1501 * evil may find reprieve in these extra evil params:
1503 * - _skip_evil_bao_auto_recipients_: bool
1504 * - _skip_evil_bao_auto_schedule_: bool
1505 * - _evil_bao_validator_: string|callable
1507 * </twowrongsmakesaright>
1509 * @params array $params
1512 * @param array $params
1516 * $mailing The new mailing object
1517 * @throws \Exception
1519 public static function create(&$params, $ids = array()) {
1521 if (empty($params['id']) && (array_filter($ids) !== [])) {
1522 $params['id'] = isset($ids['mailing_id']) ?
$ids['mailing_id'] : $ids['id'];
1523 \Civi
::log('Parameter $ids is no longer used by Mailing::create. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1527 // Do the below only for an insert
1528 // for an update, we should not set the defaults
1529 if (!isset($params['id'])) {
1530 // Retrieve domain email and name for default sender
1531 $domain = civicrm_api(
1536 'current_domain' => 1,
1540 if (isset($domain['from_email'])) {
1541 $domain_email = $domain['from_email'];
1542 $domain_name = $domain['from_name'];
1545 $domain_email = 'info@EXAMPLE.ORG';
1546 $domain_name = 'EXAMPLE.ORG';
1548 if (!isset($params['created_id'])) {
1549 $session =& CRM_Core_Session
::singleton();
1550 $params['created_id'] = $session->get('userID');
1553 // load the default config settings for each
1554 // eg reply_id, unsubscribe_id need to use
1555 // correct template IDs here
1556 'override_verp' => TRUE,
1557 'forward_replies' => FALSE,
1558 'open_tracking' => TRUE,
1559 'url_tracking' => TRUE,
1560 'visibility' => 'Public Pages',
1561 'replyto_email' => $domain_email,
1562 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1563 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1564 'from_email' => $domain_email,
1565 'from_name' => $domain_name,
1566 'msg_template_id' => NULL,
1567 'created_id' => $params['created_id'],
1568 'approver_id' => NULL,
1569 'auto_responder' => 0,
1570 'created_date' => date('YmdHis'),
1571 'scheduled_date' => NULL,
1572 'approval_date' => NULL,
1575 // Get the default from email address, if not provided.
1576 if (empty($defaults['from_email'])) {
1577 $defaultAddress = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE, TRUE);
1578 foreach ($defaultAddress as $id => $value) {
1579 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1580 $defaults['from_email'] = $match[2];
1581 $defaults['from_name'] = $match[1];
1586 $params = array_merge($defaults, $params);
1590 * Could check and warn for the following cases:
1592 * - groups OR mailings should be populated.
1593 * - body html OR body text should be populated.
1596 $transaction = new CRM_Core_Transaction();
1598 $mailing = self
::add($params);
1600 if (is_a($mailing, 'CRM_Core_Error')) {
1601 $transaction->rollback();
1604 // update mailings with hash values
1605 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1607 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1609 /* Create the mailing group record */
1610 $mg = new CRM_Mailing_DAO_MailingGroup();
1611 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1612 foreach (array('groups', 'mailings') as $entity) {
1613 foreach (array('include', 'exclude', 'base') as $type) {
1614 if (isset($params[$entity][$type])) {
1615 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1620 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1622 $mg->mailing_id
= $mailing->id
;
1623 $mg->entity_table
= $groupTableName;
1624 $mg->entity_id
= $params['group_id'];
1625 $mg->search_id
= $params['search_id'];
1626 $mg->search_args
= $params['search_args'];
1627 $mg->group_type
= 'Include';
1631 // check and attach and files as needed
1632 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1634 // If we're going to autosend, then check validity before saving.
1635 if (empty($params['is_completed']) && !empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1636 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1637 $errors = call_user_func($cb, $mailing);
1638 if (!empty($errors)) {
1639 $fields = implode(',', array_keys($errors));
1640 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1644 $transaction->commit();
1646 // Create parent job if not yet created.
1647 // Condition on the existence of a scheduled date.
1648 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1649 $job = new CRM_Mailing_BAO_MailingJob();
1650 $job->mailing_id
= $mailing->id
;
1651 // If we are creating a new Completed mailing (e.g. import from another system) set the job to completed.
1652 // Keeping former behaviour when an id is present is precautionary and may warrant reconsideration later.
1653 $job->status
= ((empty($params['is_completed']) ||
!empty($params['id'])) ?
'Scheduled' : 'Complete');
1656 if (!$job->find(TRUE)) {
1657 // Don't schedule job until we populate the recipients.
1658 $job->scheduled_date
= NULL;
1661 // Schedule the job now that it has recipients.
1662 $job->scheduled_date
= $params['scheduled_date'];
1666 // Populate the recipients.
1667 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1668 self
::getRecipients($mailing->id
);
1676 * This is used by CiviMail but will be made redundant by FlexMailer.
1677 * @param CRM_Mailing_DAO_Mailing $mailing
1678 * The mailing which may or may not be sendable.
1680 * List of error messages.
1682 public static function checkSendable($mailing) {
1684 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1685 if (empty($mailing->{$field})) {
1686 $errors[$field] = ts('Field "%1" is required.', array(
1691 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1692 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1695 if (!Civi
::settings()->get('disable_mandatory_tokens_check')) {
1696 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->header_id
) : NULL;
1697 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->footer_id
) : NULL;
1698 foreach (array('body_html', 'body_text') as $field) {
1699 if (empty($mailing->{$field})) {
1702 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1703 $err = CRM_Utils_Token
::requiredTokens($str);
1704 if ($err !== TRUE) {
1705 foreach ($err as $token => $desc) {
1706 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1707 array(1 => $token, 2 => $desc)
1718 * Replace the list of recipients on a given mailing.
1720 * @param int $mailingId
1721 * @param string $type
1722 * 'include' or 'exclude'.
1723 * @param string $entity
1724 * 'groups' or 'mailings'.
1725 * @param array <int> $entityIds
1726 * @throws CiviCRM_API3_Exception
1728 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1730 foreach ($entityIds as $entityId) {
1731 $values[] = array('entity_id' => $entityId);
1733 civicrm_api3('mailing_group', 'replace', array(
1734 'mailing_id' => $mailingId,
1735 'group_type' => $type,
1736 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1737 'values' => $values,
1742 * Get hash value of the mailing.
1746 * @return null|string
1748 public static function getMailingHash($id) {
1750 if (Civi
::settings()->get('hash_mailing_url')) {
1751 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1757 * Generate a report. Fetch event count information, mailing data, and job
1761 * The mailing id to report.
1762 * @param bool $skipDetails
1763 * Whether return all detailed report.
1765 * @param bool $isSMS
1768 * Associative array of reporting data
1770 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1771 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1773 $mailing = new CRM_Mailing_BAO_Mailing();
1776 'mailing' => self
::getTableName(),
1777 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1778 'group' => CRM_Contact_BAO_Group
::getTableName(),
1779 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1780 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1781 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1782 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1783 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1784 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1785 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1786 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1787 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1788 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1789 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1790 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1794 $additionalWhereClause = " AND ";
1796 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1799 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1802 /* Get the mailing info */
1805 SELECT {$t['mailing']}.*
1806 FROM {$t['mailing']}
1807 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1811 $report['mailing'] = array();
1812 foreach (array_keys(self
::fields()) as $field) {
1813 $report['mailing'][$field] = $mailing->$field;
1817 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1818 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1819 $report['mailing']['campaign'] = $campaigns[$campaignId];
1822 //mailing report is called by activity
1823 //we dont need all detail report
1828 /* Get the component info */
1832 $components = array(
1833 'header' => ts('Header'),
1834 'footer' => ts('Footer'),
1835 'reply' => ts('Reply'),
1836 'optout' => ts('Opt-Out'),
1837 'resubscribe' => ts('Resubscribe'),
1838 'unsubscribe' => ts('Unsubscribe'),
1840 foreach (array_keys($components) as $type) {
1841 $query[] = "SELECT {$t['component']}.name as name,
1843 {$t['component']}.id as id
1844 FROM {$t['component']}
1845 INNER JOIN {$t['mailing']}
1846 ON {$t['mailing']}.{$type}_id =
1847 {$t['component']}.id
1848 WHERE {$t['mailing']}.id = $mailing_id";
1850 $q = '(' . implode(') UNION (', $query) . ')';
1851 $mailing->query($q);
1853 $report['component'] = array();
1854 while ($mailing->fetch()) {
1855 $report['component'][] = array(
1856 'type' => $components[$mailing->type
],
1857 'name' => $mailing->name
,
1858 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1859 "reset=1&action=update&id={$mailing->id}"
1864 /* Get the recipient group info */
1867 SELECT {$t['mailing_group']}.group_type as group_type,
1868 {$t['group']}.id as group_id,
1869 {$t['group']}.title as group_title,
1870 {$t['group']}.is_hidden as group_hidden,
1871 {$t['mailing']}.id as mailing_id,
1872 {$t['mailing']}.name as mailing_name
1873 FROM {$t['mailing_group']}
1874 LEFT JOIN {$t['group']}
1875 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1876 AND {$t['mailing_group']}.entity_table =
1878 LEFT JOIN {$t['mailing']}
1879 ON {$t['mailing_group']}.entity_id =
1881 AND {$t['mailing_group']}.entity_table =
1884 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1887 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1888 while ($mailing->fetch()) {
1890 if (isset($mailing->group_id
)) {
1891 $row['id'] = $mailing->group_id
;
1892 $row['name'] = $mailing->group_title
;
1893 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1894 "reset=1&force=1&context=smog&gid={$row['id']}"
1898 $row['id'] = $mailing->mailing_id
;
1899 $row['name'] = $mailing->mailing_name
;
1900 $row['mailing'] = TRUE;
1901 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1906 /* Rename hidden groups */
1908 if ($mailing->group_hidden
== 1) {
1909 $row['name'] = "Search Results";
1912 if ($mailing->group_type
== 'Include') {
1913 $report['group']['include'][] = $row;
1915 elseif ($mailing->group_type
== 'Base') {
1916 $report['group']['base'][] = $row;
1919 $report['group']['exclude'][] = $row;
1923 /* Get the event totals, grouped by job (retries) */
1926 SELECT {$t['job']}.*,
1927 COUNT(DISTINCT {$t['queue']}.id) as queue,
1928 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1929 COUNT(DISTINCT {$t['reply']}.id) as reply,
1930 COUNT(DISTINCT {$t['forward']}.id) as forward,
1931 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1932 COUNT(DISTINCT {$t['urlopen']}.id) as url,
1933 COUNT(DISTINCT {$t['spool']}.id) as spool
1935 LEFT JOIN {$t['queue']}
1936 ON {$t['queue']}.job_id = {$t['job']}.id
1937 LEFT JOIN {$t['reply']}
1938 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
1939 LEFT JOIN {$t['forward']}
1940 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
1941 LEFT JOIN {$t['bounce']}
1942 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
1943 LEFT JOIN {$t['delivered']}
1944 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
1945 AND {$t['bounce']}.id IS null
1946 LEFT JOIN {$t['urlopen']}
1947 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1948 LEFT JOIN {$t['spool']}
1949 ON {$t['spool']}.job_id = {$t['job']}.id
1950 WHERE {$t['job']}.mailing_id = $mailing_id
1951 AND {$t['job']}.is_test = 0
1952 GROUP BY {$t['job']}.id");
1954 $report['jobs'] = array();
1955 $report['event_totals'] = array();
1970 // initialize various counters
1971 foreach ($elements as $field) {
1972 $report['event_totals'][$field] = 0;
1975 while ($mailing->fetch()) {
1977 foreach ($elements as $field) {
1978 if (isset($mailing->$field)) {
1979 $row[$field] = $mailing->$field;
1980 $report['event_totals'][$field] +
= $mailing->$field;
1984 // compute open total separately to discount duplicates
1986 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
1987 $report['event_totals']['opened'] +
= $row['opened'];
1988 $row['total_opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
);
1989 $report['event_totals']['total_opened'] +
= $row['total_opened'];
1991 // compute unsub total separately to discount duplicates
1993 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
1994 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
1996 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
1997 $report['event_totals']['optout'] +
= $row['optout'];
1999 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
2000 $row[$field] = $mailing->$field;
2003 if ($mailing->queue
) {
2004 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2005 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2006 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2007 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2008 $row['opened_rate'] = $mailing->delivered ?
(($row['opened'] / $mailing->delivered
) * 100.0) : 0;
2009 $row['clickthrough_rate'] = $mailing->delivered ?
(($mailing->url
/ $mailing->delivered
) * 100.0) : 0;
2012 $row['delivered_rate'] = 0;
2013 $row['bounce_rate'] = 0;
2014 $row['unsubscribe_rate'] = 0;
2015 $row['optout_rate'] = 0;
2016 $row['opened_rate'] = 0;
2017 $row['clickthrough_rate'] = 0;
2020 $row['links'] = array(
2021 'clicks' => CRM_Utils_System
::url(
2022 'civicrm/mailing/report/event',
2023 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2025 'queue' => CRM_Utils_System
::url(
2026 'civicrm/mailing/report/event',
2027 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2029 'delivered' => CRM_Utils_System
::url(
2030 'civicrm/mailing/report/event',
2031 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2033 'bounce' => CRM_Utils_System
::url(
2034 'civicrm/mailing/report/event',
2035 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2037 'unsubscribe' => CRM_Utils_System
::url(
2038 'civicrm/mailing/report/event',
2039 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2041 'forward' => CRM_Utils_System
::url(
2042 'civicrm/mailing/report/event',
2043 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2045 'reply' => CRM_Utils_System
::url(
2046 'civicrm/mailing/report/event',
2047 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2049 'opened' => CRM_Utils_System
::url(
2050 'civicrm/mailing/report/event',
2051 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2060 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2062 $report['jobs'][] = $row;
2065 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2067 // we need to do this for backward compatibility, since old mailings did not
2068 // use the mailing_recipients table
2069 if ($newTableSize > 0) {
2070 $report['event_totals']['queue'] = $newTableSize;
2073 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id);
2076 if (!empty($report['event_totals']['queue'])) {
2077 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2078 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2079 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2080 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2081 $report['event_totals']['opened_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['opened'] / $report['event_totals']['delivered']) * 100.0) : 0;
2082 $report['event_totals']['clickthrough_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['url'] / $report['event_totals']['delivered']) * 100.0) : 0;
2085 $report['event_totals']['delivered_rate'] = 0;
2086 $report['event_totals']['bounce_rate'] = 0;
2087 $report['event_totals']['unsubscribe_rate'] = 0;
2088 $report['event_totals']['optout_rate'] = 0;
2089 $report['event_totals']['opened_rate'] = 0;
2090 $report['event_totals']['clickthrough_rate'] = 0;
2093 /* Get the click-through totals, grouped by URL */
2096 SELECT {$t['url']}.url,
2098 COUNT({$t['urlopen']}.id) as clicks,
2099 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2101 LEFT JOIN {$t['urlopen']}
2102 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2103 LEFT JOIN {$t['queue']}
2104 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2105 LEFT JOIN {$t['job']}
2106 ON {$t['queue']}.job_id = {$t['job']}.id
2107 WHERE {$t['url']}.mailing_id = $mailing_id
2108 AND {$t['job']}.is_test = 0
2109 GROUP BY {$t['url']}.id
2110 ORDER BY unique_clicks DESC");
2112 $report['click_through'] = array();
2114 while ($mailing->fetch()) {
2115 $report['click_through'][] = array(
2116 'url' => $mailing->url
,
2117 'link' => CRM_Utils_System
::url(
2118 'civicrm/mailing/report/event',
2119 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2121 'link_unique' => CRM_Utils_System
::url(
2122 'civicrm/mailing/report/event',
2123 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2125 'clicks' => $mailing->clicks
,
2126 'unique' => $mailing->unique_clicks
,
2127 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2128 'report' => CRM_Report_Utils_Report
::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2132 $report['event_totals']['links'] = array(
2133 'clicks' => CRM_Utils_System
::url(
2134 'civicrm/mailing/report/event',
2135 "reset=1&event=click&mid=$mailing_id"
2137 'clicks_unique' => CRM_Utils_System
::url(
2138 'civicrm/mailing/report/event',
2139 "reset=1&event=click&mid=$mailing_id&distinct=1"
2141 'queue' => CRM_Utils_System
::url(
2142 'civicrm/mailing/report/event',
2143 "reset=1&event=queue&mid=$mailing_id"
2145 'delivered' => CRM_Utils_System
::url(
2146 'civicrm/mailing/report/event',
2147 "reset=1&event=delivered&mid=$mailing_id"
2149 'bounce' => CRM_Utils_System
::url(
2150 'civicrm/mailing/report/event',
2151 "reset=1&event=bounce&mid=$mailing_id"
2153 'unsubscribe' => CRM_Utils_System
::url(
2154 'civicrm/mailing/report/event',
2155 "reset=1&event=unsubscribe&mid=$mailing_id"
2157 'optout' => CRM_Utils_System
::url(
2158 'civicrm/mailing/report/event',
2159 "reset=1&event=optout&mid=$mailing_id"
2161 'forward' => CRM_Utils_System
::url(
2162 'civicrm/mailing/report/event',
2163 "reset=1&event=forward&mid=$mailing_id"
2165 'reply' => CRM_Utils_System
::url(
2166 'civicrm/mailing/report/event',
2167 "reset=1&event=reply&mid=$mailing_id"
2169 'opened' => CRM_Utils_System
::url(
2170 'civicrm/mailing/report/event',
2171 "reset=1&event=opened&mid=$mailing_id"
2175 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2176 if (CRM_Core_Permission
::check('view all contacts')) {
2177 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2178 'name' => ts('Advanced Search'),
2179 'url' => 'civicrm/contact/search/advanced',
2182 $action = array_sum(array_keys($actionLinks));
2184 $report['event_totals']['actionlinks'] = array();
2197 $url = 'mailing/detail';
2198 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2199 $searchFilter = "force=1&mailing_id=%%mid%%";
2202 $reportFilter .= "&delivery_status_value=successful";
2203 $searchFilter .= "&mailing_delivery_status=Y";
2207 $url = "mailing/bounce";
2208 $searchFilter .= "&mailing_delivery_status=N";
2212 $reportFilter .= "&is_forwarded_value=1";
2213 $searchFilter .= "&mailing_forward=1";
2217 $reportFilter .= "&is_replied_value=1";
2218 $searchFilter .= "&mailing_reply_status=Y";
2222 $reportFilter .= "&is_unsubscribed_value=1";
2223 $searchFilter .= "&mailing_unsubscribe=1";
2227 $reportFilter .= "&is_optout_value=1";
2228 $searchFilter .= "&mailing_optout=1";
2232 $url = "mailing/opened";
2233 $searchFilter .= "&mailing_open_status=Y";
2237 case 'clicks_unique':
2238 $url = "mailing/clicks";
2239 $searchFilter .= "&mailing_click_status=Y";
2242 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2243 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2244 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2246 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2249 array('mid' => $mailing_id),
2252 'mailing.report.action',
2262 * Get the count of mailings.
2269 public function getCount() {
2271 $this->selectAdd('COUNT(id) as count');
2273 $session = CRM_Core_Session
::singleton();
2276 return $this->count
;
2284 public static function checkPermission($id) {
2289 $mailingIDs = self
::mailingACLIDs();
2290 if ($mailingIDs === TRUE) {
2294 if (!in_array($id, $mailingIDs)) {
2295 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2300 * @param null $alias
2304 public static function mailingACL($alias = NULL) {
2305 $mailingACL = " ( 0 ) ";
2307 $mailingIDs = self
::mailingACLIDs();
2308 if ($mailingIDs === TRUE) {
2312 if (!empty($mailingIDs)) {
2313 $mailingIDs = implode(',', $mailingIDs);
2314 $tableName = !$alias ? self
::getTableName() : $alias;
2315 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2321 * Returns all the mailings that this user can access. This is dependent on
2322 * all the groups that the user has access to.
2323 * However since most civi installs dont use ACL's we special case the condition
2324 * where the user has access to ALL groups, and hence ALL mailings and return a
2325 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2327 * @return bool|array
2328 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2330 public static function mailingACLIDs() {
2332 // optimize common case where admin has access
2335 CRM_Core_Permission
::check('view all contacts') ||
2336 CRM_Core_Permission
::check('edit all contacts')
2341 $mailingIDs = array();
2343 // get all the groups that this user can access
2344 // if they dont have universal access
2345 $groupNames = civicrm_api3('Group', 'get', array(
2346 'check_permissions' => TRUE,
2347 'return' => array('title', 'id'),
2348 'options' => array('limit' => 0),
2350 foreach ($groupNames['values'] as $group) {
2351 $groups[$group['id']] = $group['title'];
2353 if (!empty($groups)) {
2354 $groupIDs = implode(',', array_keys($groups));
2355 $domain_id = CRM_Core_Config
::domainID();
2357 // get all the mailings that are in this subset of groups
2359 SELECT DISTINCT( m.id ) as id
2360 FROM civicrm_mailing m
2361 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2362 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2363 OR ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2365 $dao = CRM_Core_DAO
::executeQuery($query);
2367 $mailingIDs = array();
2368 while ($dao->fetch()) {
2369 $mailingIDs[] = $dao->id
;
2371 //CRM-18181 Get all mailings that use the mailings found earlier as receipients
2372 if (!empty($mailingIDs)) {
2373 $mailings = implode(',', $mailingIDs);
2375 SELECT DISTINCT ( m.id ) as id
2376 FROM civicrm_mailing m
2377 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2378 WHERE g.entity_table like 'civicrm_mailing%' AND g.entity_id IN ($mailings)";
2379 $mailingDao = CRM_Core_DAO
::executeQuery($mailingQuery);
2380 while ($mailingDao->fetch()) {
2381 $mailingIDs[] = $mailingDao->id
;
2390 * Get the rows for a browse operation.
2392 * @param int $offset
2393 * The row number to start from.
2394 * @param int $rowCount
2395 * The nmber of rows to return.
2396 * @param string $sort
2397 * The sql string that describes the sort order.
2399 * @param null $additionalClause
2400 * @param array $additionalParams
2405 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2406 $mailing = self
::getTableName();
2407 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2408 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2409 $session = CRM_Core_Session
::singleton();
2411 $mailingACL = self
::mailingACL();
2413 //get all campaigns.
2414 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2416 "$mailing.id", "$mailing.name", "$job.status",
2417 "$mailing.approval_status_id", "createdContact.sort_name as created_by", "scheduledContact.sort_name as scheduled_by",
2418 "$mailing.created_id as created_id", "$mailing.scheduled_id as scheduled_id", "$mailing.is_archived as archived",
2419 "$mailing.created_date as created_date", "campaign_id", "$mailing.sms_provider_id as sms_provider_id",
2420 "$mailing.language",
2423 // we only care about parent jobs, since that holds all the info on
2425 $selectClause = implode(', ', $select);
2426 $groupFromSelect = CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($select, "$mailing.id");
2428 SELECT {$selectClause},
2429 MIN($job.scheduled_date) as scheduled_date,
2430 MIN($job.start_date) as start_date,
2431 MAX($job.end_date) as end_date
2433 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2434 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2435 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2436 WHERE $mailingACL $additionalClause";
2438 if (!empty($groupFromSelect)) {
2439 $query .= $groupFromSelect;
2443 $orderBy = trim($sort->orderBy());
2444 if (!empty($orderBy)) {
2445 $query .= " ORDER BY $orderBy";
2450 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2451 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2453 $query .= " LIMIT $offset, $rowCount ";
2456 if (!$additionalParams) {
2457 $additionalParams = array();
2460 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2463 while ($dao->fetch()) {
2466 'name' => $dao->name
,
2467 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2468 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2469 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2470 'scheduled_iso' => $dao->scheduled_date
,
2471 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2472 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2473 'created_by' => $dao->created_by
,
2474 'scheduled_by' => $dao->scheduled_by
,
2475 'created_id' => $dao->created_id
,
2476 'scheduled_id' => $dao->scheduled_id
,
2477 'archived' => $dao->archived
,
2478 'approval_status_id' => $dao->approval_status_id
,
2479 'campaign_id' => $dao->campaign_id
,
2480 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2481 'sms_provider_id' => $dao->sms_provider_id
,
2482 'language' => $dao->language
,
2489 * Show detail Mailing report.
2495 public static function showEmailDetails($id) {
2496 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2500 * Delete Mails and all its associated records.
2503 * Id of the mail to delete.
2507 public static function del($id) {
2509 CRM_Core_Error
::fatal();
2512 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2514 // delete all file attachments
2515 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2519 $dao = new CRM_Mailing_DAO_Mailing();
2523 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2525 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2530 * Use CRM_Mailing_BAO_MailingJob::del($id)
2533 * Id of the Job to delete.
2537 public static function delJob($id) {
2539 CRM_Core_Error
::fatal();
2542 \Civi
::log('This function is deprecated, use CRM_Mailing_BAO_MailingJob::del instead', ['civi.tag' => 'deprecated']);
2544 CRM_Mailing_BAO_MailingJob
::del($id);
2549 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
2552 public function getReturnProperties() {
2553 $tokens = &$this->getTokens();
2555 $properties = array();
2556 if (isset($tokens['html']) &&
2557 isset($tokens['html']['contact'])
2559 $properties = array_merge($properties, $tokens['html']['contact']);
2562 if (isset($tokens['text']) &&
2563 isset($tokens['text']['contact'])
2565 $properties = array_merge($properties, $tokens['text']['contact']);
2568 if (isset($tokens['subject']) &&
2569 isset($tokens['subject']['contact'])
2571 $properties = array_merge($properties, $tokens['subject']['contact']);
2574 $returnProperties = array();
2575 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2577 foreach ($properties as $p) {
2578 $returnProperties[$p] = 1;
2581 return $returnProperties;
2585 * Build the compose mail form.
2587 * @param CRM_Core_Form $form
2591 public static function commonCompose(&$form) {
2595 if (method_exists($form, 'listTokens')) {
2596 $tokens = array_merge($form->listTokens(), $tokens);
2599 //sorted in ascending order tokens by ignoring word case
2600 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2602 $templates = array();
2604 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2605 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2607 $className = CRM_Utils_System
::getClassName($form);
2609 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2610 $className != 'CRM_Contact_Form_Task_SMS'
2612 $form->add('wysiwyg', 'html_message',
2613 strstr($className, 'PDF') ?
ts('Document Body') : ts('HTML Format'),
2617 'onkeyup' => "return verify(this)",
2621 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2622 unset($modePrefixes['SMS']);
2626 unset($textFields['text_message']);
2627 unset($modePrefixes['Mail']);
2630 //insert message Text by selecting "Select Template option"
2631 foreach ($textFields as $id => $label) {
2633 if ($id == 'sms_text_message') {
2635 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2637 $form->add('textarea', $id, $label,
2641 'onkeyup' => "return verify(this, '{$prefix}')",
2646 foreach ($modePrefixes as $prefix) {
2647 if ($prefix == 'SMS') {
2648 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2651 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2653 if (!empty($templates[$prefix])) {
2654 $form->assign('templates', TRUE);
2656 $form->add('select', "{$prefix}template", ts('Use Template'),
2657 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2658 array('onChange' => "selectValue( this.value, '{$prefix}');")
2661 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2663 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2664 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2666 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2669 // I'm not sure this is ever called.
2670 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2671 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2672 $action == CRM_Core_Action
::VIEW
2674 $form->freeze('html_message');
2679 * Get the search based mailing Ids.
2682 * , searched base mailing ids.
2684 public function searchMailingIDs() {
2685 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2686 $mailing = self
::getTableName();
2689 SELECT $mailing.id as mailing_id
2690 FROM $mailing, $group
2691 WHERE $group.mailing_id = $mailing.id
2692 AND $group.group_type = 'Base'";
2694 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2695 $mailingIDs = array();
2696 while ($searchDAO->fetch()) {
2697 $mailingIDs[] = $searchDAO->mailing_id
;
2704 * Get the content/components of mailing based on mailing Id
2706 * @param array $report
2707 * of mailing report.
2710 * Reference of this.
2712 * @param bool $isSMS
2715 * array content/component.
2717 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2718 $htmlHeader = $textHeader = NULL;
2719 $htmlFooter = $textFooter = NULL;
2722 if ($report['mailing']['header_id']) {
2723 $header = new CRM_Mailing_BAO_Component();
2724 $header->id
= $report['mailing']['header_id'];
2725 $header->find(TRUE);
2726 $htmlHeader = $header->body_html
;
2727 $textHeader = $header->body_text
;
2730 if ($report['mailing']['footer_id']) {
2731 $footer = new CRM_Mailing_BAO_Component();
2732 $footer->id
= $report['mailing']['footer_id'];
2733 $footer->find(TRUE);
2734 $htmlFooter = $footer->body_html
;
2735 $textFooter = $footer->body_text
;
2739 $mailingKey = $form->_mailing_id
;
2741 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2742 $mailingKey = $hash;
2746 if (!empty($report['mailing']['body_text'])) {
2747 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2748 $form->assign('textViewURL', $url);
2752 if (!empty($report['mailing']['body_html'])) {
2753 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2754 $form->assign('htmlViewURL', $url);
2759 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2769 public static function overrideVerp($jobID) {
2770 static $_cache = array();
2772 if (!isset($_cache[$jobID])) {
2774 SELECT override_verp
2775 FROM civicrm_mailing
2776 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2777 WHERE civicrm_mailing_job.id = %1
2779 $params = array(1 => array($jobID, 'Integer'));
2780 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2782 return $_cache[$jobID];
2791 public static function processQueue($mode = NULL) {
2792 $config = CRM_Core_Config
::singleton();
2794 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2795 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 system administrator guide</a>', array(
2796 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2797 2 => "https://docs.civicrm.org/sysadmin/en/latest/setup/civimail/",
2801 // check if we are enforcing number of parallel cron jobs
2803 $gotCronLock = FALSE;
2805 $mailerJobsMax = Civi
::settings()->get('mailerJobsMax');
2806 if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2807 $lockArray = range(1, $mailerJobsMax);
2809 // Shuffle the array to improve chances of quickly finding an open thread
2810 shuffle($lockArray);
2812 // Check if we are using global locks
2813 foreach ($lockArray as $lockID) {
2814 $cronLock = Civi
::lockManager()->acquire("worker.mailing.send.{$lockID}");
2815 if ($cronLock->isAcquired()) {
2816 $gotCronLock = TRUE;
2821 // Exit here since we have enough mailing processes running
2822 if (!$gotCronLock) {
2823 CRM_Core_Error
::debug_log_message('Returning early, since the maximum number of mailing processes are running');
2827 if (getenv('CIVICRM_CRON_HOLD')) {
2828 // In testing, we may need to simulate some slow activities.
2829 sleep(getenv('CIVICRM_CRON_HOLD'));
2833 // Split up the parent jobs into multiple child jobs
2834 $mailerJobSize = Civi
::settings()->get('mailerJobSize');
2835 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2836 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2837 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2839 // Release the global lock if we do have one
2841 $cronLock->release();
2848 * @param int $mailingID
2850 private static function addMultipleEmails($mailingID) {
2852 INSERT INTO civicrm_mailing_recipients
2853 (mailing_id, email_id, contact_id)
2854 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2856 AND e.is_bulkmail = 1
2858 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2859 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2861 $params = array(1 => array($mailingID, 'Integer'));
2863 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2867 * @param bool $isSMS
2871 public static function getMailingsList($isSMS = FALSE) {
2872 static $list = array();
2875 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2878 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2883 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2884 FROM civicrm_mailing
2885 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2886 ORDER BY civicrm_mailing.name";
2887 $mailing = CRM_Core_DAO
::executeQuery($query);
2889 while ($mailing->fetch()) {
2890 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2898 * wrapper for ajax activity selector.
2900 * @param array $params
2901 * Associated array for params record id.
2904 * associated array of contact activities
2906 public static function getContactMailingSelector(&$params) {
2907 // format the params
2908 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2909 $params['rowCount'] = $params['rp'];
2910 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2911 $params['caseId'] = NULL;
2913 // get contact mailings
2914 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2917 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2920 if (!empty($mailings)) {
2921 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2922 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2925 // format params and add links
2926 $contactMailings = array();
2927 foreach ($mailings as $mailingId => $values) {
2929 $mailing['subject'] = $values['subject'];
2930 $mailing['creator_name'] = CRM_Utils_System
::href(
2931 $values['creator_name'],
2932 'civicrm/contact/view',
2933 "reset=1&cid={$values['creator_id']}");
2934 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2935 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2936 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2938 $mailing['openstats'] = "Opens: " .
2939 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
2941 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
2943 $actionLinks = array(
2944 CRM_Core_Action
::VIEW
=> array(
2945 'name' => ts('View'),
2946 'url' => 'civicrm/mailing/view',
2947 'qs' => "reset=1&id=%%mkey%%",
2948 'title' => ts('View Mailing'),
2949 'class' => 'crm-popup',
2951 CRM_Core_Action
::BROWSE
=> array(
2952 'name' => ts('Mailing Report'),
2953 'url' => 'civicrm/mailing/report',
2954 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
2955 'title' => ts('View Mailing Report'),
2959 $mailingKey = $values['mailing_id'];
2960 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2961 $mailingKey = $hash;
2964 $mailing['links'] = CRM_Core_Action
::formLink(
2968 'mid' => $values['mailing_id'],
2969 'cid' => $params['contact_id'],
2970 'mkey' => $mailingKey,
2974 'mailing.contact.action',
2976 $values['mailing_id']
2979 array_push($contactMailings, $mailing);
2982 $contactMailingsDT = array();
2983 $contactMailingsDT['data'] = $contactMailings;
2984 $contactMailingsDT['recordsTotal'] = $params['total'];
2985 $contactMailingsDT['recordsFiltered'] = $params['total'];
2987 return $contactMailingsDT;
2991 * Retrieve contact mailing.
2993 * @param array $params
2996 * Array of mailings for a contact
2999 static public function getContactMailings(&$params) {
3000 $params['version'] = 3;
3001 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3002 $params['limit'] = $params['rp'];
3003 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3005 $result = civicrm_api('MailingContact', 'get', $params);
3006 return $result['values'];
3010 * Retrieve contact mailing count.
3012 * @param array $params
3015 * count of mailings for a contact
3018 static public function getContactMailingsCount(&$params) {
3019 $params['version'] = 3;
3020 return civicrm_api('MailingContact', 'getcount', $params);
3024 * Get a list of permissions required for CRUD'ing each field
3025 * (when workflow is enabled).
3028 * Array (string $fieldName => string $permName)
3030 public static function getWorkflowFieldPerms() {
3031 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3032 $fieldPerms = array();
3033 foreach ($fieldNames as $fieldName) {
3034 if ($fieldName == 'id') {
3035 $fieldPerms[$fieldName] = array(
3036 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3039 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3040 $fieldPerms[$fieldName] = array(
3041 array('access CiviMail', 'schedule mailings'), // OR
3044 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3045 $fieldPerms[$fieldName] = array(
3046 array('access CiviMail', 'approve mailings'), // OR
3050 $fieldPerms[$fieldName] = array(
3051 array('access CiviMail', 'create mailings'), // OR
3059 * White-list of possible values for the entity_table field.
3063 public static function mailingGroupEntityTables() {
3065 CRM_Contact_BAO_Group
::getTableName() => 'Group',
3066 CRM_Mailing_BAO_Mailing
::getTableName() => 'Mailing',
3071 * Get the public view url.
3074 * @param bool $absolute
3078 public static function getPublicViewUrl($id, $absolute = TRUE) {
3079 if ((civicrm_api3('Mailing', 'getvalue', array('id' => $id, 'return' => 'visibility'))) === 'Public Pages') {
3080 return CRM_Utils_System
::url('civicrm/mailing/view', array('id' => $id), $absolute, NULL, TRUE, TRUE);
3085 * Get a list of template types which can be used as `civicrm_mailing.template_type`.
3088 * A list of template-types, keyed numerically. Each defines:
3089 * - name: string, a short symbolic name
3090 * - editorUrl: string, Angular template name
3092 * Ex: $templateTypes[0] === array('name' => 'mosaico', 'editorUrl' => '~/crmMosaico/editor.html').
3094 public static function getTemplateTypes() {
3095 if (!isset(Civi
::$statics[__CLASS__
]['templateTypes'])) {
3098 'name' => 'traditional',
3099 'editorUrl' => CRM_Mailing_Info
::workflowEnabled() ?
'~/crmMailing/EditMailingCtrl/workflow.html' : '~/crmMailing/EditMailingCtrl/2step.html',
3103 CRM_Utils_Hook
::mailingTemplateTypes($types);
3105 $defaults = array('weight' => 0);
3106 foreach (array_keys($types) as $typeName) {
3107 $types[$typeName] = array_merge($defaults, $types[$typeName]);
3109 usort($types, function ($a, $b) {
3110 if ($a['weight'] === $b['weight']) {
3113 return $a['weight'] < $b['weight'] ?
-1 : 1;
3116 Civi
::$statics[__CLASS__
]['templateTypes'] = $types;
3119 return Civi
::$statics[__CLASS__
]['templateTypes'];
3123 * Get a list of template types.
3126 * Array(string $name => string $label).
3128 public static function getTemplateTypeNames() {
3130 foreach (self
::getTemplateTypes() as $type) {
3131 $r[$type['name']] = $type['name'];