3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
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 // hidden smart groups always have a cache date and there is no other way
164 // we can rebuilt the contact list from UI so consider such smart group
165 if ($groupDAO->cache_date
== NULL ||
$groupDAO->is_hidden
) {
166 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
168 if ($groupType == 'Include') {
169 $includeSmartGroupIDs[] = $groupDAO->id
;
171 elseif ($groupType == 'Exclude') {
172 $excludeSmartGroupIDs[] = $groupDAO->id
;
174 //NOTE: Do nothing for base
178 // Create a temp table for contact exclusion.
179 $excludeTempTablename = "excluded_recipients_temp" . substr(sha1(rand()), 0, 4);
180 $includedTempTablename = "included_recipients_temp" . substr(sha1(rand()), 0, 4);
181 $mailingGroup->query(
182 "CREATE TEMPORARY TABLE $excludeTempTablename
183 (contact_id int primary key)
186 // populate exclude temp-table with recipients to be excluded from the list
187 // on basis of selected recipients groups and/or previous mailing
188 if (!empty($recipientsGroup['Exclude'])) {
189 CRM_Utils_SQL_Select
::from('civicrm_group_contact')
190 ->select('DISTINCT contact_id')
191 ->where('status = "Added" AND group_id IN (#groups)')
192 ->param('#groups', $recipientsGroup['Exclude'])
193 ->insertInto($excludeTempTablename, array('contact_id'))
196 if (count($excludeSmartGroupIDs)) {
197 CRM_Utils_SQL_Select
::from('civicrm_group_contact_cache')
198 ->select('contact_id')
199 ->where('group_id IN (#groups)')
200 ->param('#groups', $excludeSmartGroupIDs)
201 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
205 if (!empty($priorMailingIDs['Exclude'])) {
206 CRM_Utils_SQL_Select
::from('civicrm_mailing_recipients')
207 ->select('DISTINCT contact_id')
208 ->where('mailing_id IN (#mailings)')
209 ->param('#mailings', $priorMailingIDs['Exclude'])
210 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
214 if (!empty($recipientsGroup['Base'])) {
215 CRM_Utils_SQL_Select
::from('civicrm_group_contact')
216 ->select('DISTINCT contact_id')
217 ->where('status = "Removed" AND group_id IN (#groups)')
218 ->param('#groups', $recipientsGroup['Base'])
219 ->insertIgnoreInto($excludeTempTablename, array('contact_id'))
223 $entityColumn = $isSMSmode ?
'phone_id' : 'email_id';
224 $entityTable = $isSMSmode ? CRM_Core_DAO_Phone
::getTableName() : CRM_Core_DAO_Email
::getTableName();
225 // Get all the group contacts we want to include.
226 $mailingGroup->query(
227 "CREATE TEMPORARY TABLE $includedTempTablename
228 (contact_id int primary key, $entityColumn int)
234 'is_opt_out' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_opt_out = 0"),
235 'is_deceased' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_deceased <> 1"),
236 'do_not_sms' => CRM_Utils_SQL_Select
::fragment()->where("$contact.do_not_sms = 0"),
237 'location_filter' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone_type_id = " . CRM_Core_PseudoConstant
::getKey('CRM_Core_DAO_Phone', 'phone_type_id', 'Mobile')),
238 'phone_not_null' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone IS NOT NULL"),
239 'phone_not_empty' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.phone != ''"),
240 'mailing_id' => CRM_Utils_SQL_Select
::fragment()->where("mg.mailing_id = #mailingID"),
241 'temp_contact_null' => CRM_Utils_SQL_Select
::fragment()->where('temp.contact_id IS null'),
242 'order_by' => CRM_Utils_SQL_Select
::fragment()->orderBy("$entityTable.is_primary"),
246 // Criterias to filter recipients that need to be included
248 'do_not_email' => CRM_Utils_SQL_Select
::fragment()->where("$contact.do_not_email = 0"),
249 'is_opt_out' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_opt_out = 0"),
250 'is_deceased' => CRM_Utils_SQL_Select
::fragment()->where("$contact.is_deceased <> 1"),
251 'location_filter' => CRM_Utils_SQL_Select
::fragment()->where($location_filter),
252 'email_not_null' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.email IS NOT NULL"),
253 'email_not_empty' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.email != ''"),
254 'email_not_on_hold' => CRM_Utils_SQL_Select
::fragment()->where("$entityTable.on_hold = 0"),
255 'mailing_id' => CRM_Utils_SQL_Select
::fragment()->where("mg.mailing_id = #mailingID"),
256 'temp_contact_null' => CRM_Utils_SQL_Select
::fragment()->where('temp.contact_id IS NULL'),
257 'order_by' => CRM_Utils_SQL_Select
::fragment()->orderBy($order_by),
261 // Allow user to alter query responsible to fetch mailing recipients before build,
262 // by changing the mail filters identified $params
263 CRM_Utils_Hook
::alterMailingRecipients($mailingObj, $criteria, 'pre');
265 // Get the group contacts, but only those which are not in the
266 // exclusion temp table.
267 if (!empty($recipientsGroup['Include'])) {
268 CRM_Utils_SQL_Select
::from($entityTable)
269 ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
270 ->join($contact, " INNER JOIN $contact ON $entityTable.contact_id = $contact.id ")
271 ->join('gc', " INNER JOIN civicrm_group_contact gc ON gc.contact_id = $contact.id ")
272 ->join('mg', " INNER JOIN civicrm_mailing_group mg ON gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
273 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
274 ->where('gc.group_id IN (#groups) AND gc.status = "Added"')
276 ->groupBy(array("$contact.id", "$entityTable.id"))
277 ->replaceInto($includedTempTablename, array('contact_id', $entityColumn))
278 ->param('#groups', $recipientsGroup['Include'])
279 ->param('#mailingID', $mailingID)
283 // Get recipients selected in prior mailings
284 if (!empty($priorMailingIDs['Include'])) {
285 CRM_Utils_SQL_Select
::from('civicrm_mailing_recipients')
286 ->select("DISTINCT civicrm_mailing_recipients.contact_id, $entityColumn")
287 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON civicrm_mailing_recipients.contact_id = temp.contact_id ")
288 ->where('mailing_id IN (#mailings)')
289 ->where('temp.contact_id IS NULL')
290 ->param('#mailings', $priorMailingIDs['Include'])
291 ->insertIgnoreInto($includedTempTablename, array('contact_id', $entityColumn))
295 if (count($includeSmartGroupIDs)) {
296 $query = CRM_Utils_SQL_Select
::from($contact)
297 ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
298 ->join($entityTable, " INNER JOIN $entityTable ON $entityTable.contact_id = $contact.id ")
299 ->join('gc', " INNER JOIN civicrm_group_contact_cache gc ON $contact.id = gc.contact_id ")
300 ->join('gcr', " LEFT JOIN civicrm_group_contact gcr ON gc.group_id = gcr.group_id AND gc.contact_id = gcr.contact_id")
301 ->join('mg', " INNER JOIN civicrm_mailing_group mg ON gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
302 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
303 ->where('gc.group_id IN (#groups)')
304 ->where('gcr.status IS NULL OR gcr.status != "Removed"')
306 ->replaceInto($includedTempTablename, array('contact_id', $entityColumn))
307 ->param('#groups', $includeSmartGroupIDs)
308 ->param('#mailingID', $mailingID)
312 // Construct the filtered search queries.
313 $dao = CRM_Utils_SQL_Select
::from('civicrm_mailing_group')
314 ->select('search_id, search_args, entity_id')
315 ->where('search_id IS NOT NULL AND mailing_id = #mailingID')
316 ->param('#mailingID', $mailingID)
318 while ($dao->fetch()) {
319 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
323 $query = "REPLACE INTO {$includedTempTablename} ($entityColumn, contact_id) {$customSQL} ";
324 $mailingGroup->query($query);
327 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
329 // clear all the mailing recipients before populating
330 CRM_Core_DAO
::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE mailing_id = %1 ", array(1 => array($mailingID, 'Integer')));
332 $selectClause = array('#mailingID', 'i.contact_id', "i.$entityColumn");
334 $orderBy = array("i.contact_id", "i.$entityColumn");
336 $query = CRM_Utils_SQL_Select
::from('civicrm_contact contact_a')->join('i', " INNER JOIN {$includedTempTablename} i ON contact_a.id = i.contact_id ");
337 if (!$isSMSmode && $mailingObj->dedupe_email
) {
338 $orderBy = array("MIN(i.contact_id)", "MIN(i.$entityColumn)");
339 $query = $query->join('e', " INNER JOIN civicrm_email e ON e.id = i.email_id ")->groupBy("e.email");
340 if (CRM_Utils_SQL
::supportsFullGroupBy()) {
341 $selectClause = array('#mailingID', 'ANY_VALUE(i.contact_id) contact_id', "ANY_VALUE(i.$entityColumn) $entityColumn", "e.email");
345 $query = $query->select($selectClause)->orderBy($orderBy);
346 if (!CRM_Utils_System
::isNull($aclFrom)) {
347 $query = $query->join('acl', $aclFrom);
349 if (!CRM_Utils_System
::isNull($aclWhere)) {
350 $query = $query->where($aclWhere);
353 // this mean if dedupe_email AND the mysql 5.7 supports ONLY_FULL_GROUP_BY mode then as
354 // SELECT must contain 'email' column as its used in GROUP BY, so in order to resolve This
355 // here the whole SQL code is wrapped up in FROM table i and not selecting email column for INSERT
356 if ($key = array_search('e.email', $selectClause)) {
357 unset($selectClause[$key]);
358 $sql = $query->toSQL();
359 CRM_Utils_SQL_Select
::from("( $sql ) AS i ")
360 ->select($selectClause)
361 ->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
362 ->param('#mailingID', $mailingID)
366 $query->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
367 ->param('#mailingID', $mailingID)
371 // if we need to add all emails marked bulk, do it as a post filter
372 // on the mailing recipients table
373 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
374 self
::addMultipleEmails($mailingID);
377 // Delete the temp table.
378 $mailingGroup->reset();
379 $mailingGroup->query(" DROP TEMPORARY TABLE $excludeTempTablename ");
380 $mailingGroup->query(" DROP TEMPORARY TABLE $includedTempTablename ");
382 CRM_Utils_Hook
::alterMailingRecipients($mailingObj, $criteria, 'post');
386 * Function to retrieve location filter and order by clause later used by SQL query that is used to fetch and include mailing recipients
388 * @param string $email_selection_method
389 * @param int $location_type_id
393 public static function getLocationFilterAndOrderBy($email_selection_method, $location_type_id) {
394 $email = CRM_Core_DAO_Email
::getTableName();
395 // Note: When determining the ORDER that results are returned, it's
396 // the record that comes last that counts. That's because we are
397 // INSERT'ing INTO a table with a primary id so that last record
398 // over writes any previous record.
399 switch ($email_selection_method) {
400 case 'location-exclude':
401 $location_filter = "($email.location_type_id != $location_type_id)";
402 // If there is more than one email that doesn't match the location,
403 // prefer the one marked is_bulkmail, followed by is_primary.
404 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
407 case 'location-only':
408 $location_filter = "($email.location_type_id = $location_type_id)";
409 // If there is more than one email of the desired location, prefer
410 // the one marked is_bulkmail, followed by is_primary.
411 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
414 case 'location-prefer':
415 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
416 // ORDER BY is more complicated because we have to set an arbitrary
417 // order that prefers the location that we want. We do that using
418 // the FIELD function. For more info, see:
419 // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
420 // We assign the location type we want the value "1" by putting it
421 // in the first position after we name the field. All other location
422 // types are left out, so they will be assigned the value 0. That
423 // means, they will all be equally tied for first place, with our
424 // location being last.
425 $orderBy = array("FIELD($email.location_type_id, $location_type_id)", "$email.is_bulkmail", "$email.is_primary");
429 // fall through to default
431 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
432 $orderBy = array("$email.is_bulkmail");
435 return array($location_filter, $orderBy);
439 * @param string $type
443 private function _getMailingGroupIds($type = 'Include') {
444 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
445 $group = CRM_Contact_DAO_Group
::getTableName();
446 if (!isset($this->id
)) {
447 // we're just testing tokens, so return any group
448 $query = "SELECT id AS entity_id
454 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
455 $query = "SELECT entity_id
457 WHERE mailing_id = {$this->id}
458 AND group_type = '$type'
459 AND entity_table = '$group'";
461 $mailingGroup->query($query);
464 while ($mailingGroup->fetch()) {
465 $groupIds[] = $mailingGroup->entity_id
;
472 * Returns the regex patterns that are used for preparing the text and html templates.
474 * @param bool $onlyHrefs
476 * @return array|string
478 private function getPatterns($onlyHrefs = FALSE) {
482 $protos = '(https?|ftp|mailto)';
484 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
486 $any = "{$letters}{$gunk}{$punc}";
488 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
491 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
494 $patterns[] = $pattern;
495 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
496 $patterns[] = '\{\w+\.\w+\}';
498 $patterns = '{' . implode('|', $patterns) . '}imu';
504 * Returns an array that denotes the type of token that we are dealing with
505 * we use the type later on when we are doing a token replacement lookup
507 * @param string $token
508 * The token for which we will be doing adata lookup.
511 * An array that holds the token itself and the type.
512 * the type will tell us which function to use for the data lookup
513 * if we need to do a lookup at all
515 public function &getDataFunc($token) {
516 static $_categories = NULL;
517 static $_categoryString = NULL;
519 $_categories = array(
526 CRM_Utils_Hook
::tokens($_categories);
527 $_categoryString = implode('|', array_keys($_categories));
530 $funcStruct = array('type' => NULL, 'token' => $token);
532 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
533 // it is a url so we need to check to see if there are any tokens embedded
534 // if so then call this function again to get the token dataFunc
535 // and assign the type 'embedded' so that the data retrieving function
536 // will know what how to handle this token.
537 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
538 $funcStruct['type'] = 'embedded_url';
539 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
540 foreach ($matches[1] as $match) {
541 $preg_token = '/' . preg_quote($match, '/') . '/';
542 $list = preg_split($preg_token, $token, 2);
543 $funcStruct['embed_parts'][] = $list[0];
545 $funcStruct['token'][] = $this->getDataFunc($match);
547 // fixed truncated url, CRM-7113
549 $funcStruct['embed_parts'][] = $token;
553 $funcStruct['type'] = 'url';
556 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
557 $funcStruct['type'] = $matches[1];
558 $funcStruct['token'] = $matches[2];
560 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
561 // we are an escaped token
562 // so remove the escape chars
563 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
564 $funcStruct['token'] = '{' . $unescaped_token . '}';
570 * Prepares the text and html templates
571 * for generating the emails and returns a copy of the
575 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
577 private function getPreparedTemplates() {
578 if (!$this->preparedTemplates
) {
579 $patterns['html'] = $this->getPatterns(TRUE);
580 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
581 $templates = $this->getTemplates();
583 $this->preparedTemplates
= array();
590 if (!isset($templates[$key])) {
596 $split_template = array();
598 $email = $templates[$key];
599 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
600 foreach ($matches[0] as $idx => $token) {
601 $preg_token = '/' . preg_quote($token, '/') . '/im';
602 list($split_template[], $email) = preg_split($preg_token, $email, 2);
603 array_push($tokens, $this->getDataFunc($token));
606 $split_template[] = $email;
608 $this->preparedTemplates
[$key]['template'] = $split_template;
609 $this->preparedTemplates
[$key]['tokens'] = $tokens;
612 return ($this->preparedTemplates
);
616 * Retrieve a ref to an array that holds the email and text templates for this email
617 * assembles the complete template including the header and footer
618 * that the user has uploaded or declared (if they have done that)
621 * reference to an assoc array
623 public function getTemplates() {
624 if (!$this->templates
) {
625 $this->getHeaderFooter();
626 $this->templates
= array();
627 if ($this->body_text ||
!empty($this->header
)) {
629 if (!empty($this->header
->body_text
)) {
630 $template[] = $this->header
->body_text
;
632 elseif (!empty($this->header
->body_html
)) {
633 $template[] = CRM_Utils_String
::htmlToText($this->header
->body_html
);
636 if ($this->body_text
) {
637 $template[] = $this->body_text
;
640 $template[] = CRM_Utils_String
::htmlToText($this->body_html
);
643 if (!empty($this->footer
->body_text
)) {
644 $template[] = $this->footer
->body_text
;
646 elseif (!empty($this->footer
->body_html
)) {
647 $template[] = CRM_Utils_String
::htmlToText($this->footer
->body_html
);
650 $this->templates
['text'] = implode("\n", $template);
653 // To check for an html part strip tags
654 if (trim(strip_tags($this->body_html
, '<img>'))) {
658 $template[] = $this->header
->body_html
;
661 $template[] = $this->body_html
;
664 $template[] = $this->footer
->body_html
;
667 $this->templates
['html'] = implode("\n", $template);
669 // this is where we create a text template from the html template if the text template did not exist
670 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
671 // user uploads an html email only
672 if (empty($this->templates
['text'])) {
673 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
677 if ($this->subject
) {
679 $template[] = $this->subject
;
680 $this->templates
['subject'] = implode("\n", $template);
683 CRM_Utils_Hook
::alterMailContent($this->templates
);
685 return $this->templates
;
690 * Retrieve a ref to an array that holds all of the tokens in the email body
691 * where the keys are the type of token and the values are ordinal arrays
692 * that hold the token names (even repeated tokens) in the order in which
693 * they appear in the body of the email.
695 * note: the real work is done in the _getTokens() function
697 * this function needs to have some sort of a body assigned
698 * either text or html for this to have any meaningful impact
701 * reference to an assoc array
703 public function &getTokens() {
704 if (!$this->tokens
) {
706 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
708 if ($this->body_html
) {
709 $this->_getTokens('html');
710 if (!$this->body_text
) {
711 // Since the text template was created from html, use the html tokens.
712 // @see CRM_Mailing_BAO_Mailing::getTemplates()
713 $this->tokens
['text'] = $this->tokens
['html'];
717 if ($this->body_text
) {
718 $this->_getTokens('text');
721 if ($this->subject
) {
722 $this->_getTokens('subject');
726 return $this->tokens
;
730 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
731 * hook in one call and standardizes it across other token workflows
734 * reference to an assoc array
736 public function &getFlattenedTokens() {
737 if (!$this->flattenedTokens
) {
738 $tokens = $this->getTokens();
740 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
743 return $this->flattenedTokens
;
748 * _getTokens parses out all of the tokens that have been
749 * included in the html and text bodies of the email
750 * we get the tokens and then separate them into an
751 * internal structure named tokens that has the same
752 * form as the static tokens property(?) of the CRM_Utils_Token class.
753 * The difference is that there might be repeated token names as we want the
754 * structures to represent the order in which tokens were found from left to right, top to bottom.
757 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
758 * Name of the property that holds the text that we want to scan for tokens (html, text).
762 private function _getTokens($prop) {
763 $templates = $this->getTemplates();
765 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
767 foreach ($newTokens as $type => $names) {
768 if (!isset($this->tokens
[$prop][$type])) {
769 $this->tokens
[$prop][$type] = array();
771 foreach ($names as $key => $name) {
772 $this->tokens
[$prop][$type][] = $name;
778 * Generate an event queue for a test job.
780 * @param array $testParams
781 * Contains form values.
785 public function getTestRecipients($testParams) {
786 if (!empty($testParams['test_group']) && array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
787 $contacts = civicrm_api('contact', 'get', array(
789 'group' => $testParams['test_group'],
792 'limit' => 100000000000,
797 foreach (array_keys($contacts['values']) as $groupContact) {
799 SELECT civicrm_email.id AS email_id,
800 civicrm_email.is_primary as is_primary,
801 civicrm_email.is_bulkmail as is_bulkmail
803 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
804 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
805 AND civicrm_contact.id = {$groupContact}
806 AND civicrm_contact.do_not_email = 0
807 AND civicrm_contact.is_deceased <> 1
808 AND civicrm_email.on_hold = 0
809 AND civicrm_contact.is_opt_out = 0
810 GROUP BY civicrm_email.id
811 ORDER BY civicrm_email.is_bulkmail DESC
813 $dao = CRM_Core_DAO
::executeQuery($query);
816 'job_id' => $testParams['job_id'],
817 'email_id' => $dao->email_id
,
818 'contact_id' => $groupContact,
820 CRM_Mailing_Event_BAO_Queue
::create($params);
827 * Load this->header and this->footer.
829 private function getHeaderFooter() {
830 if (!$this->header
and $this->header_id
) {
831 $this->header
= new CRM_Mailing_BAO_MailingComponent();
832 $this->header
->id
= $this->header_id
;
833 $this->header
->find(TRUE);
834 $this->header
->free();
837 if (!$this->footer
and $this->footer_id
) {
838 $this->footer
= new CRM_Mailing_BAO_MailingComponent();
839 $this->footer
->id
= $this->footer_id
;
840 $this->footer
->find(TRUE);
841 $this->footer
->free();
846 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
847 * add a Message-ID header if needed.
849 * i.e. if the global includeMessageId is set and there isn't already a
850 * Message-ID in the array.
851 * The message ID is structured the same way as a verp. However no interpretation
852 * is placed on the values received, so they do not need to follow the verp
855 * @param array $headers
856 * Array of message headers to update, in-out.
857 * @param string $prefix
858 * Prefix for the message ID, use same prefixes as verp.
860 * @param string $job_id
861 * Job ID component of the generated message ID.
862 * @param string $event_queue_id
863 * Event Queue ID component of the generated message ID.
864 * @param string $hash
865 * Hash component of the generated message ID.
869 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
870 $config = CRM_Core_Config
::singleton();
871 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
872 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
873 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
875 $fields[] = 'Message-ID';
876 // CRM-17754 check if Resent-Message-id is set also if not add it in when re-laying reply email
877 if ($prefix == 'r') {
878 $fields[] = 'Resent-Message-ID';
880 foreach ($fields as $field) {
881 if ($includeMessageId && (!array_key_exists($field, $headers))) {
882 $headers[$field] = '<' . implode($config->verpSeparator
,
884 $localpart . $prefix,
889 ) . "@{$emailDomain}>";
896 * Static wrapper for getting verp and urls.
899 * ID of the Job associated with this message.
900 * @param int $event_queue_id
901 * ID of the EventQueue.
902 * @param string $hash
903 * Hash of the EventQueue.
904 * @param string $email
905 * Destination address.
908 * (reference) array array ref that hold array refs to the verp info and urls
910 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
911 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
912 $config = CRM_Core_Config
::singleton();
913 $bao = new CRM_Mailing_BAO_Mailing();
914 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
915 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
917 // use $bao's instance method to get verp and urls
918 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
919 return array($verp, $urls);
923 * Get verp, urls and headers
926 * ID of the Job associated with this message.
927 * @param int $event_queue_id
928 * ID of the EventQueue.
929 * @param string $hash
930 * Hash of the EventQueue.
931 * @param string $email
932 * Destination address.
934 * @param bool $isForward
937 * array ref that hold array refs to the verp info, urls, and headers
939 public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
940 $config = CRM_Core_Config
::singleton();
944 * reply: user replied to mailing
945 * bounce: email address bounced
946 * unsubscribe: contact opts out of all target lists for the mailing
947 * resubscribe: contact opts back into all target lists for the mailing
948 * optOut: contact unsubscribes from the domain
954 'unsubscribe' => 'u',
955 'resubscribe' => 'e',
959 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
960 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
961 // 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
962 if (empty($emailDomain)) {
963 CRM_Core_Error
::debug_log_message('Error setting verp parameters, defaultDomain is NULL. Did you configure the bounce processing account for this domain?');
966 foreach ($verpTokens as $key => $value) {
967 $verp[$key] = implode($config->verpSeparator
,
977 //handle should override VERP address.
981 self
::overrideVerp($job_id)
983 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
987 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
988 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
989 TRUE, NULL, TRUE, TRUE
991 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
992 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
993 TRUE, NULL, TRUE, TRUE
995 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
996 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
997 TRUE, NULL, TRUE, TRUE
999 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1000 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1001 TRUE, NULL, TRUE, TRUE
1003 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1005 TRUE, NULL, TRUE, TRUE
1010 'Reply-To' => $verp['reply'],
1011 'Return-Path' => $verp['bounce'],
1012 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1013 'Subject' => $this->subject
,
1014 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1016 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1018 $headers['Subject'] = "[Fwd:{$this->subject}]";
1020 return array(&$verp, &$urls, &$headers);
1024 * Compose a message.
1027 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1028 * @param int $job_id
1029 * ID of the Job associated with this message.
1030 * @param int $event_queue_id
1031 * ID of the EventQueue.
1032 * @param string $hash
1033 * Hash of the EventQueue.
1034 * @param string $contactId
1035 * ID of the Contact.
1036 * @param string $email
1037 * Destination address.
1038 * @param string $recipient
1039 * To: of the recipient.
1041 * Is this mailing a test?.
1042 * @param $contactDetails
1043 * @param $attachments
1044 * @param bool $isForward
1045 * Is this mailing compose for forward?.
1046 * @param string $fromEmail
1047 * Email address of who is forwardinf it.
1049 * @param null $replyToEmail
1051 * @return Mail_mime The mail object
1053 public function compose(
1054 $job_id, $event_queue_id, $hash, $contactId,
1055 $email, &$recipient, $test,
1056 $contactDetails, &$attachments, $isForward = FALSE,
1057 $fromEmail = NULL, $replyToEmail = NULL
1059 $config = CRM_Core_Config
::singleton();
1062 if ($this->_domain
== NULL) {
1063 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1066 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1074 //set from email who is forwarding it and not original one.
1076 unset($headers['From']);
1077 $headers['From'] = "<{$fromEmail}>";
1080 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1081 $headers['Reply-To'] = "{$replyToEmail}";
1084 if ($contactDetails) {
1085 $contact = $contactDetails;
1087 elseif ($contactId === 0) {
1090 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1093 $params = array(array('contact_id', '=', $contactId, 0, 0));
1094 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1097 $contact = reset($contact);
1099 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1100 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1101 array(1 => $contactId)
1103 // setting this because function is called by reference
1104 //@todo test not calling function by reference
1109 // also call the hook to get contact details
1110 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1113 $pTemplates = $this->getPreparedTemplates();
1116 foreach ($pTemplates as $type => $pTemplate) {
1117 $html = ($type == 'html') ?
TRUE : FALSE;
1118 $pEmails[$type] = array();
1119 $pEmail = &$pEmails[$type];
1120 $template = &$pTemplates[$type]['template'];
1121 $tokens = &$pTemplates[$type]['tokens'];
1123 if (!empty($tokens)) {
1124 foreach ($tokens as $idx => $token) {
1125 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1126 array_push($pEmail, $template[$idx]);
1127 array_push($pEmail, $token_data);
1131 array_push($pEmail, $template[$idx]);
1134 if (isset($template[($idx +
1)])) {
1135 array_push($pEmail, $template[($idx +
1)]);
1140 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1141 $html = &$pEmails['html'];
1145 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1146 $text = &$pEmails['text'];
1149 // push the tracking url on to the html email if necessary
1150 if ($this->open_tracking
&& $html) {
1151 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1152 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1156 $message = new Mail_mime("\n");
1158 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1160 $smarty = CRM_Core_Smarty
::singleton();
1161 // also add the contact tokens to the template
1162 $smarty->assign_by_ref('contact', $contact);
1165 $mailParams = $headers;
1166 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1167 $contact['preferred_mail_format'] == 'Both' ||
1168 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1171 $textBody = implode('', $text);
1173 $textBody = $smarty->fetch("string:$textBody");
1175 $mailParams['text'] = $textBody;
1178 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1179 $contact['preferred_mail_format'] == 'Both'
1182 $htmlBody = implode('', $html);
1184 $htmlBody = $smarty->fetch("string:$htmlBody");
1186 $mailParams['html'] = $htmlBody;
1189 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1191 // something went wrong, lets log it and return null (by reference)
1192 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1199 $mailParams['attachments'] = $attachments;
1201 $mailParams['Subject'] = CRM_Utils_Array
::value('subject', $pEmails);
1202 if (is_array($mailParams['Subject'])) {
1203 $mailParams['Subject'] = implode('', $mailParams['Subject']);
1206 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1209 $mailParams['toEmail'] = $email;
1211 // Add job ID to mailParams for external email delivery service to utilise
1212 $mailParams['job_id'] = $job_id;
1214 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1216 // CRM-10699 support custom email headers
1217 if (!empty($mailParams['headers'])) {
1218 $headers = array_merge($headers, $mailParams['headers']);
1220 //cycle through mailParams and set headers array
1221 foreach ($mailParams as $paramKey => $paramValue) {
1222 //exclude values not intended for the header
1223 if (!in_array($paramKey, array(
1231 $headers[$paramKey] = $paramValue;
1235 if (!empty($mailParams['text'])) {
1236 $message->setTxtBody($mailParams['text']);
1239 if (!empty($mailParams['html'])) {
1240 $message->setHTMLBody($mailParams['html']);
1243 if (!empty($mailParams['attachments'])) {
1244 foreach ($mailParams['attachments'] as $fileID => $attach) {
1245 $message->addAttachment($attach['fullPath'],
1246 $attach['mime_type'],
1247 $attach['cleanName']
1252 //pickup both params from mail params.
1253 $toName = trim($mailParams['toName']);
1254 $toEmail = trim($mailParams['toEmail']);
1255 if ($toName == $toEmail ||
1256 strpos($toName, '@') !== FALSE
1261 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1264 $headers['To'] = "$toName <$toEmail>";
1266 $headers['Precedence'] = 'bulk';
1267 // Will test in the mail processor if the X-VERP is set in the bounced email.
1268 // (As an option to replace real VERP for those that can't set it up)
1269 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1272 //token replacement of subject
1273 $headers['Subject'] = $mailParams['Subject'];
1275 CRM_Utils_Mail
::setMimeParams($message);
1276 $headers = $message->headers($headers);
1278 //get formatted recipient
1279 $recipient = $headers['To'];
1281 // make sure we unset a lot of stuff
1294 * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
1297 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1298 * @param CRM_Mailing_BAO_Mailing $mailing
1300 public static function tokenReplace(&$mailing) {
1301 $domain = CRM_Core_BAO_Domain
::getDomain();
1303 foreach (array('text', 'html') as $type) {
1304 $tokens = $mailing->getTokens();
1305 if (isset($mailing->templates
[$type])) {
1306 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1307 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1308 $mailing->templates
[$type],
1310 $type == 'html' ?
TRUE : FALSE,
1313 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1319 * Get data to resolve tokens.
1322 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1324 * @param array $token_a
1326 * Whether to encode the token result for use in HTML email
1327 * @param array $contact
1328 * @param string $verp
1329 * @param array $urls
1330 * @param int $event_queue_id
1332 * @return bool|mixed|null|string
1334 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1335 $type = $token_a['type'];
1336 $token = $token_a['token'];
1339 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1341 if ($type == 'embedded_url') {
1342 $embed_data = array();
1343 foreach ($token as $t) {
1344 $embed_data[] = $this->getTokenData($t, $html, $contact, $verp, $urls, $event_queue_id);
1346 $numSlices = count($embed_data);
1348 for ($i = 0; $i < $numSlices; $i++
) {
1349 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1351 if (isset($token_a['embed_parts'][$numSlices])) {
1352 $url .= $token_a['embed_parts'][$numSlices];
1354 // add trailing quote since we've gobbled it up in a previous regex
1355 // function getPatterns, line 431
1356 if (preg_match("/^href[ ]*=[ ]*'.*[^']$/", $url)) {
1359 elseif (preg_match('/^href[ ]*=[ ]*".*[^"]$/', $url)) {
1363 // CRM-20206 Fix ampersand encoding in plain text emails
1365 $data = CRM_Utils_String
::unstupifyUrl($data);
1368 elseif ($type == 'url') {
1369 if ($this->url_tracking
) {
1370 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1371 if (!empty($html)) {
1372 $data = htmlentities($data, ENT_NOQUOTES
);
1379 elseif ($type == 'contact') {
1380 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1382 elseif ($type == 'action') {
1383 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1385 elseif ($type == 'domain') {
1386 $domain = CRM_Core_BAO_Domain
::getDomain();
1387 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1389 elseif ($type == 'mailing') {
1390 if ($token == 'name') {
1391 $data = $this->name
;
1393 elseif ($token == 'group') {
1394 $groups = $this->getGroupNames();
1395 $data = implode(', ', $groups);
1399 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1405 * Return a list of group names for this mailing. Does not work with
1406 * prior-mailing targets.
1409 * Names of groups receiving this mailing
1411 public function &getGroupNames() {
1412 if (!isset($this->id
)) {
1415 $mg = new CRM_Mailing_DAO_MailingGroup();
1416 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1417 $group = CRM_Contact_BAO_Group
::getTableName();
1419 $mg->query("SELECT $group.title as name FROM $mgtable
1420 INNER JOIN $group ON $mgtable.entity_id = $group.id
1421 WHERE $mgtable.mailing_id = {$this->id}
1422 AND $mgtable.entity_table = '$group'
1423 AND $mgtable.group_type = 'Include'
1424 ORDER BY $group.name");
1427 while ($mg->fetch()) {
1428 $groups[] = $mg->name
;
1437 * @param array $params
1438 * Reference array contains the values submitted by the form.
1440 * Reference array contains the id.
1443 * @return CRM_Mailing_DAO_Mailing
1445 public static function add(&$params, $ids = array()) {
1446 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('mailing_id', $ids));
1448 if (empty($params['id']) && !empty($ids)) {
1449 \Civi
::log('Parameter $ids is no longer used by Mailing::add. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1453 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1456 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1459 $mailing = new static();
1462 $mailing->find(TRUE);
1464 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1466 if (((!$id && empty($params['replyto_email'])) ||
!isset($params['replyto_email'])) &&
1467 isset($params['from_email'])
1469 $params['replyto_email'] = $params['from_email'];
1471 $mailing->copyValues($params);
1473 // CRM-20892 Unset Modifed Date here so that MySQL can correctly set an updated modfied date.
1474 unset($mailing->modified_date
);
1475 $result = $mailing->save();
1477 // CRM-20892 Re find record after saing so we can set the updated modified date in the result.
1478 $mailing->find(TRUE);
1480 if (isset($mailing->modified_date
)) {
1481 $result->modified_date
= $mailing->modified_date
;
1485 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1488 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1495 * Construct a new mailing object, along with job and mailing_group
1496 * objects, from the form values of the create mailing wizard.
1498 * This function is a bit evil. It not only merges $params and saves
1499 * the mailing -- it also schedules the mailing and chooses the recipients.
1500 * Since it merges $params, it's also the only place to correctly trigger
1501 * multi-field validation. It should be broken up.
1503 * In the mean time, use-cases which break under the weight of this
1504 * evil may find reprieve in these extra evil params:
1506 * - _skip_evil_bao_auto_recipients_: bool
1507 * - _skip_evil_bao_auto_schedule_: bool
1508 * - _evil_bao_validator_: string|callable
1510 * </twowrongsmakesaright>
1512 * @params array $params
1515 * @param array $params
1519 * $mailing The new mailing object
1520 * @throws \Exception
1522 public static function create(&$params, $ids = array()) {
1524 if (empty($params['id']) && (array_filter($ids) !== [])) {
1525 $params['id'] = isset($ids['mailing_id']) ?
$ids['mailing_id'] : $ids['id'];
1526 \Civi
::log('Parameter $ids is no longer used by Mailing::create. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1530 // Do the below only for an insert
1531 // for an update, we should not set the defaults
1532 if (!isset($params['id'])) {
1533 // Retrieve domain email and name for default sender
1534 $domain = civicrm_api(
1539 'current_domain' => 1,
1543 if (isset($domain['from_email'])) {
1544 $domain_email = $domain['from_email'];
1545 $domain_name = $domain['from_name'];
1548 $domain_email = 'info@EXAMPLE.ORG';
1549 $domain_name = 'EXAMPLE.ORG';
1551 if (!isset($params['created_id'])) {
1552 $session =& CRM_Core_Session
::singleton();
1553 $params['created_id'] = $session->get('userID');
1556 // load the default config settings for each
1557 // eg reply_id, unsubscribe_id need to use
1558 // correct template IDs here
1559 'override_verp' => TRUE,
1560 'forward_replies' => FALSE,
1561 'open_tracking' => TRUE,
1562 'url_tracking' => TRUE,
1563 'visibility' => 'Public Pages',
1564 'replyto_email' => $domain_email,
1565 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1566 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1567 'from_email' => $domain_email,
1568 'from_name' => $domain_name,
1569 'msg_template_id' => NULL,
1570 'created_id' => $params['created_id'],
1571 'approver_id' => NULL,
1572 'auto_responder' => 0,
1573 'created_date' => date('YmdHis'),
1574 'scheduled_date' => NULL,
1575 'approval_date' => NULL,
1578 // Get the default from email address, if not provided.
1579 if (empty($defaults['from_email'])) {
1580 $defaultAddress = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE, TRUE);
1581 foreach ($defaultAddress as $id => $value) {
1582 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1583 $defaults['from_email'] = $match[2];
1584 $defaults['from_name'] = $match[1];
1589 $params = array_merge($defaults, $params);
1593 * Could check and warn for the following cases:
1595 * - groups OR mailings should be populated.
1596 * - body html OR body text should be populated.
1599 $transaction = new CRM_Core_Transaction();
1601 $mailing = self
::add($params);
1603 if (is_a($mailing, 'CRM_Core_Error')) {
1604 $transaction->rollback();
1607 // update mailings with hash values
1608 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1610 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1612 /* Create the mailing group record */
1613 $mg = new CRM_Mailing_DAO_MailingGroup();
1614 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1615 foreach (array('groups', 'mailings') as $entity) {
1616 foreach (array('include', 'exclude', 'base') as $type) {
1617 if (isset($params[$entity][$type])) {
1618 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1623 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1625 $mg->mailing_id
= $mailing->id
;
1626 $mg->entity_table
= $groupTableName;
1627 $mg->entity_id
= $params['group_id'];
1628 $mg->search_id
= $params['search_id'];
1629 $mg->search_args
= $params['search_args'];
1630 $mg->group_type
= 'Include';
1634 // check and attach and files as needed
1635 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1637 // If we're going to autosend, then check validity before saving.
1638 if (empty($params['is_completed']) && !empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1639 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1640 $errors = call_user_func($cb, $mailing);
1641 if (!empty($errors)) {
1642 $fields = implode(',', array_keys($errors));
1643 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1647 $transaction->commit();
1649 // Create parent job if not yet created.
1650 // Condition on the existence of a scheduled date.
1651 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1652 $job = new CRM_Mailing_BAO_MailingJob();
1653 $job->mailing_id
= $mailing->id
;
1654 // If we are creating a new Completed mailing (e.g. import from another system) set the job to completed.
1655 // Keeping former behaviour when an id is present is precautionary and may warrant reconsideration later.
1656 $job->status
= ((empty($params['is_completed']) ||
!empty($params['id'])) ?
'Scheduled' : 'Complete');
1659 if (!$job->find(TRUE)) {
1660 // Don't schedule job until we populate the recipients.
1661 $job->scheduled_date
= NULL;
1664 // Schedule the job now that it has recipients.
1665 $job->scheduled_date
= $params['scheduled_date'];
1669 // Populate the recipients.
1670 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1671 self
::getRecipients($mailing->id
);
1679 * This is used by CiviMail but will be made redundant by FlexMailer.
1680 * @param CRM_Mailing_DAO_Mailing $mailing
1681 * The mailing which may or may not be sendable.
1683 * List of error messages.
1685 public static function checkSendable($mailing) {
1687 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1688 if (empty($mailing->{$field})) {
1689 $errors[$field] = ts('Field "%1" is required.', array(
1694 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1695 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1698 if (!Civi
::settings()->get('disable_mandatory_tokens_check')) {
1699 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_MailingComponent
::findById($mailing->header_id
) : NULL;
1700 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_MailingComponent
::findById($mailing->footer_id
) : NULL;
1701 foreach (array('body_html', 'body_text') as $field) {
1702 if (empty($mailing->{$field})) {
1705 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1706 $err = CRM_Utils_Token
::requiredTokens($str);
1707 if ($err !== TRUE) {
1708 foreach ($err as $token => $desc) {
1709 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1710 array(1 => $token, 2 => $desc)
1721 * Replace the list of recipients on a given mailing.
1723 * @param int $mailingId
1724 * @param string $type
1725 * 'include' or 'exclude'.
1726 * @param string $entity
1727 * 'groups' or 'mailings'.
1728 * @param array <int> $entityIds
1729 * @throws CiviCRM_API3_Exception
1731 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1733 foreach ($entityIds as $entityId) {
1734 $values[] = array('entity_id' => $entityId);
1736 civicrm_api3('mailing_group', 'replace', array(
1737 'mailing_id' => $mailingId,
1738 'group_type' => $type,
1739 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1740 'values' => $values,
1745 * Get hash value of the mailing.
1749 * @return null|string
1751 public static function getMailingHash($id) {
1753 if (Civi
::settings()->get('hash_mailing_url')) {
1754 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1760 * Generate a report. Fetch event count information, mailing data, and job
1764 * The mailing id to report.
1765 * @param bool $skipDetails
1766 * Whether return all detailed report.
1768 * @param bool $isSMS
1771 * Associative array of reporting data
1773 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1774 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1776 $mailing = new CRM_Mailing_BAO_Mailing();
1779 'mailing' => self
::getTableName(),
1780 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1781 'group' => CRM_Contact_BAO_Group
::getTableName(),
1782 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1783 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1784 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1785 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1786 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1787 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1788 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1789 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1790 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1791 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1792 'component' => CRM_Mailing_BAO_MailingComponent
::getTableName(),
1793 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1797 $additionalWhereClause = " AND ";
1799 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1802 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1805 /* Get the mailing info */
1808 SELECT {$t['mailing']}.*
1809 FROM {$t['mailing']}
1810 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1814 $report['mailing'] = array();
1815 foreach (array_keys(self
::fields()) as $field) {
1816 if ($field == 'mailing_modified_date') {
1817 $field = 'modified_date';
1819 $report['mailing'][$field] = $mailing->$field;
1823 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1824 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1825 $report['mailing']['campaign'] = $campaigns[$campaignId];
1828 //mailing report is called by activity
1829 //we dont need all detail report
1834 /* Get the component info */
1838 $components = array(
1839 'header' => ts('Header'),
1840 'footer' => ts('Footer'),
1841 'reply' => ts('Reply'),
1842 'optout' => ts('Opt-Out'),
1843 'resubscribe' => ts('Resubscribe'),
1844 'unsubscribe' => ts('Unsubscribe'),
1846 foreach (array_keys($components) as $type) {
1847 $query[] = "SELECT {$t['component']}.name as name,
1849 {$t['component']}.id as id
1850 FROM {$t['component']}
1851 INNER JOIN {$t['mailing']}
1852 ON {$t['mailing']}.{$type}_id =
1853 {$t['component']}.id
1854 WHERE {$t['mailing']}.id = $mailing_id";
1856 $q = '(' . implode(') UNION (', $query) . ')';
1857 $mailing->query($q);
1859 $report['component'] = array();
1860 while ($mailing->fetch()) {
1861 $report['component'][] = array(
1862 'type' => $components[$mailing->type
],
1863 'name' => $mailing->name
,
1864 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1865 "reset=1&action=update&id={$mailing->id}"
1870 /* Get the recipient group info */
1873 SELECT {$t['mailing_group']}.group_type as group_type,
1874 {$t['group']}.id as group_id,
1875 {$t['group']}.title as group_title,
1876 {$t['group']}.is_hidden as group_hidden,
1877 {$t['mailing']}.id as mailing_id,
1878 {$t['mailing']}.name as mailing_name
1879 FROM {$t['mailing_group']}
1880 LEFT JOIN {$t['group']}
1881 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1882 AND {$t['mailing_group']}.entity_table =
1884 LEFT JOIN {$t['mailing']}
1885 ON {$t['mailing_group']}.entity_id =
1887 AND {$t['mailing_group']}.entity_table =
1890 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1893 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1894 while ($mailing->fetch()) {
1896 if (isset($mailing->group_id
)) {
1897 $row['id'] = $mailing->group_id
;
1898 $row['name'] = $mailing->group_title
;
1899 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1900 "reset=1&force=1&context=smog&gid={$row['id']}"
1904 $row['id'] = $mailing->mailing_id
;
1905 $row['name'] = $mailing->mailing_name
;
1906 $row['mailing'] = TRUE;
1907 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1912 /* Rename hidden groups */
1914 if ($mailing->group_hidden
== 1) {
1915 $row['name'] = "Search Results";
1918 if ($mailing->group_type
== 'Include') {
1919 $report['group']['include'][] = $row;
1921 elseif ($mailing->group_type
== 'Base') {
1922 $report['group']['base'][] = $row;
1925 $report['group']['exclude'][] = $row;
1929 /* Get the event totals, grouped by job (retries) */
1932 SELECT {$t['job']}.*,
1933 COUNT(DISTINCT {$t['queue']}.id) as queue,
1934 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1935 COUNT(DISTINCT {$t['reply']}.id) as reply,
1936 COUNT(DISTINCT {$t['forward']}.id) as forward,
1937 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1938 COUNT(DISTINCT {$t['urlopen']}.id) as url,
1939 COUNT(DISTINCT {$t['spool']}.id) as spool
1941 LEFT JOIN {$t['queue']}
1942 ON {$t['queue']}.job_id = {$t['job']}.id
1943 LEFT JOIN {$t['reply']}
1944 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
1945 LEFT JOIN {$t['forward']}
1946 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
1947 LEFT JOIN {$t['bounce']}
1948 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
1949 LEFT JOIN {$t['delivered']}
1950 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
1951 AND {$t['bounce']}.id IS null
1952 LEFT JOIN {$t['urlopen']}
1953 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1954 LEFT JOIN {$t['spool']}
1955 ON {$t['spool']}.job_id = {$t['job']}.id
1956 WHERE {$t['job']}.mailing_id = $mailing_id
1957 AND {$t['job']}.is_test = 0
1958 GROUP BY {$t['job']}.id");
1960 $report['jobs'] = array();
1961 $report['event_totals'] = array();
1976 // initialize various counters
1977 foreach ($elements as $field) {
1978 $report['event_totals'][$field] = 0;
1981 while ($mailing->fetch()) {
1983 foreach ($elements as $field) {
1984 if (isset($mailing->$field)) {
1985 $row[$field] = $mailing->$field;
1986 $report['event_totals'][$field] +
= $mailing->$field;
1990 // compute open total separately to discount duplicates
1992 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
1993 $report['event_totals']['opened'] +
= $row['opened'];
1994 $row['total_opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
);
1995 $report['event_totals']['total_opened'] +
= $row['total_opened'];
1997 // compute unsub total separately to discount duplicates
1999 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
2000 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
2002 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
2003 $report['event_totals']['optout'] +
= $row['optout'];
2005 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
2006 $row[$field] = $mailing->$field;
2009 if ($mailing->queue
) {
2010 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2011 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2012 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2013 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2014 $row['opened_rate'] = $mailing->delivered ?
(($row['opened'] / $mailing->delivered
) * 100.0) : 0;
2015 $row['clickthrough_rate'] = $mailing->delivered ?
(($mailing->url
/ $mailing->delivered
) * 100.0) : 0;
2018 $row['delivered_rate'] = 0;
2019 $row['bounce_rate'] = 0;
2020 $row['unsubscribe_rate'] = 0;
2021 $row['optout_rate'] = 0;
2022 $row['opened_rate'] = 0;
2023 $row['clickthrough_rate'] = 0;
2026 $row['links'] = array(
2027 'clicks' => CRM_Utils_System
::url(
2028 'civicrm/mailing/report/event',
2029 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2031 'queue' => CRM_Utils_System
::url(
2032 'civicrm/mailing/report/event',
2033 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2035 'delivered' => CRM_Utils_System
::url(
2036 'civicrm/mailing/report/event',
2037 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2039 'bounce' => CRM_Utils_System
::url(
2040 'civicrm/mailing/report/event',
2041 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2043 'unsubscribe' => CRM_Utils_System
::url(
2044 'civicrm/mailing/report/event',
2045 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2047 'forward' => CRM_Utils_System
::url(
2048 'civicrm/mailing/report/event',
2049 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2051 'reply' => CRM_Utils_System
::url(
2052 'civicrm/mailing/report/event',
2053 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2055 'opened' => CRM_Utils_System
::url(
2056 'civicrm/mailing/report/event',
2057 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2066 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2068 $report['jobs'][] = $row;
2071 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2073 // we need to do this for backward compatibility, since old mailings did not
2074 // use the mailing_recipients table
2075 if ($newTableSize > 0) {
2076 $report['event_totals']['queue'] = $newTableSize;
2079 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id);
2082 if (!empty($report['event_totals']['queue'])) {
2083 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2084 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2085 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2086 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2087 $report['event_totals']['opened_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['opened'] / $report['event_totals']['delivered']) * 100.0) : 0;
2088 $report['event_totals']['clickthrough_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['url'] / $report['event_totals']['delivered']) * 100.0) : 0;
2091 $report['event_totals']['delivered_rate'] = 0;
2092 $report['event_totals']['bounce_rate'] = 0;
2093 $report['event_totals']['unsubscribe_rate'] = 0;
2094 $report['event_totals']['optout_rate'] = 0;
2095 $report['event_totals']['opened_rate'] = 0;
2096 $report['event_totals']['clickthrough_rate'] = 0;
2099 /* Get the click-through totals, grouped by URL */
2102 SELECT {$t['url']}.url,
2104 COUNT({$t['urlopen']}.id) as clicks,
2105 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2107 LEFT JOIN {$t['urlopen']}
2108 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2109 LEFT JOIN {$t['queue']}
2110 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2111 LEFT JOIN {$t['job']}
2112 ON {$t['queue']}.job_id = {$t['job']}.id
2113 WHERE {$t['url']}.mailing_id = $mailing_id
2114 AND {$t['job']}.is_test = 0
2115 GROUP BY {$t['url']}.id
2116 ORDER BY unique_clicks DESC");
2118 $report['click_through'] = array();
2120 while ($mailing->fetch()) {
2121 $report['click_through'][] = array(
2122 'url' => $mailing->url
,
2123 'link' => CRM_Utils_System
::url(
2124 'civicrm/mailing/report/event',
2125 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2127 'link_unique' => CRM_Utils_System
::url(
2128 'civicrm/mailing/report/event',
2129 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2131 'clicks' => $mailing->clicks
,
2132 'unique' => $mailing->unique_clicks
,
2133 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2134 'report' => CRM_Report_Utils_Report
::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2138 $report['event_totals']['links'] = array(
2139 'clicks' => CRM_Utils_System
::url(
2140 'civicrm/mailing/report/event',
2141 "reset=1&event=click&mid=$mailing_id"
2143 'clicks_unique' => CRM_Utils_System
::url(
2144 'civicrm/mailing/report/event',
2145 "reset=1&event=click&mid=$mailing_id&distinct=1"
2147 'queue' => CRM_Utils_System
::url(
2148 'civicrm/mailing/report/event',
2149 "reset=1&event=queue&mid=$mailing_id"
2151 'delivered' => CRM_Utils_System
::url(
2152 'civicrm/mailing/report/event',
2153 "reset=1&event=delivered&mid=$mailing_id"
2155 'bounce' => CRM_Utils_System
::url(
2156 'civicrm/mailing/report/event',
2157 "reset=1&event=bounce&mid=$mailing_id"
2159 'unsubscribe' => CRM_Utils_System
::url(
2160 'civicrm/mailing/report/event',
2161 "reset=1&event=unsubscribe&mid=$mailing_id"
2163 'optout' => CRM_Utils_System
::url(
2164 'civicrm/mailing/report/event',
2165 "reset=1&event=optout&mid=$mailing_id"
2167 'forward' => CRM_Utils_System
::url(
2168 'civicrm/mailing/report/event',
2169 "reset=1&event=forward&mid=$mailing_id"
2171 'reply' => CRM_Utils_System
::url(
2172 'civicrm/mailing/report/event',
2173 "reset=1&event=reply&mid=$mailing_id"
2175 'opened' => CRM_Utils_System
::url(
2176 'civicrm/mailing/report/event',
2177 "reset=1&event=opened&mid=$mailing_id"
2181 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2182 if (CRM_Core_Permission
::check('view all contacts')) {
2183 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2184 'name' => ts('Advanced Search'),
2185 'url' => 'civicrm/contact/search/advanced',
2188 $action = array_sum(array_keys($actionLinks));
2190 $report['event_totals']['actionlinks'] = array();
2203 $url = 'mailing/detail';
2204 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2205 $searchFilter = "force=1&mailing_id=%%mid%%";
2208 $reportFilter .= "&delivery_status_value=successful";
2209 $searchFilter .= "&mailing_delivery_status=Y";
2213 $url = "mailing/bounce";
2214 $searchFilter .= "&mailing_delivery_status=N";
2218 $reportFilter .= "&is_forwarded_value=1";
2219 $searchFilter .= "&mailing_forward=1";
2223 $reportFilter .= "&is_replied_value=1";
2224 $searchFilter .= "&mailing_reply_status=Y";
2228 $reportFilter .= "&is_unsubscribed_value=1";
2229 $searchFilter .= "&mailing_unsubscribe=1";
2233 $reportFilter .= "&is_optout_value=1";
2234 $searchFilter .= "&mailing_optout=1";
2238 $url = "mailing/opened";
2239 $searchFilter .= "&mailing_open_status=Y";
2243 case 'clicks_unique':
2244 $url = "mailing/clicks";
2245 $searchFilter .= "&mailing_click_status=Y";
2248 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2249 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2250 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2252 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2255 array('mid' => $mailing_id),
2258 'mailing.report.action',
2268 * Get the count of mailings.
2275 public function getCount() {
2277 $this->selectAdd('COUNT(id) as count');
2279 $session = CRM_Core_Session
::singleton();
2282 return $this->count
;
2290 public static function checkPermission($id) {
2295 $mailingIDs = self
::mailingACLIDs();
2296 if ($mailingIDs === TRUE) {
2300 if (!in_array($id, $mailingIDs)) {
2301 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2306 * @param null $alias
2310 public static function mailingACL($alias = NULL) {
2311 $mailingACL = " ( 0 ) ";
2313 $mailingIDs = self
::mailingACLIDs();
2314 if ($mailingIDs === TRUE) {
2318 if (!empty($mailingIDs)) {
2319 $mailingIDs = implode(',', $mailingIDs);
2320 $tableName = !$alias ? self
::getTableName() : $alias;
2321 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2327 * Returns all the mailings that this user can access. This is dependent on
2328 * all the groups that the user has access to.
2329 * However since most civi installs dont use ACL's we special case the condition
2330 * where the user has access to ALL groups, and hence ALL mailings and return a
2331 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2333 * @return bool|array
2334 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2336 public static function mailingACLIDs() {
2338 // optimize common case where admin has access
2341 CRM_Core_Permission
::check('view all contacts') ||
2342 CRM_Core_Permission
::check('edit all contacts')
2347 $mailingIDs = array();
2349 // get all the groups that this user can access
2350 // if they dont have universal access
2351 $groupNames = civicrm_api3('Group', 'get', array(
2352 'check_permissions' => TRUE,
2353 'return' => array('title', 'id'),
2354 'options' => array('limit' => 0),
2356 foreach ($groupNames['values'] as $group) {
2357 $groups[$group['id']] = $group['title'];
2359 if (!empty($groups)) {
2360 $groupIDs = implode(',', array_keys($groups));
2361 $domain_id = CRM_Core_Config
::domainID();
2363 // get all the mailings that are in this subset of groups
2365 SELECT DISTINCT( m.id ) as id
2366 FROM civicrm_mailing m
2367 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2368 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2369 OR ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2371 $dao = CRM_Core_DAO
::executeQuery($query);
2373 $mailingIDs = array();
2374 while ($dao->fetch()) {
2375 $mailingIDs[] = $dao->id
;
2377 //CRM-18181 Get all mailings that use the mailings found earlier as receipients
2378 if (!empty($mailingIDs)) {
2379 $mailings = implode(',', $mailingIDs);
2381 SELECT DISTINCT ( m.id ) as id
2382 FROM civicrm_mailing m
2383 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2384 WHERE g.entity_table like 'civicrm_mailing%' AND g.entity_id IN ($mailings)";
2385 $mailingDao = CRM_Core_DAO
::executeQuery($mailingQuery);
2386 while ($mailingDao->fetch()) {
2387 $mailingIDs[] = $mailingDao->id
;
2396 * Get the rows for a browse operation.
2398 * @param int $offset
2399 * The row number to start from.
2400 * @param int $rowCount
2401 * The nmber of rows to return.
2402 * @param string $sort
2403 * The sql string that describes the sort order.
2405 * @param null $additionalClause
2406 * @param array $additionalParams
2411 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2412 $mailing = self
::getTableName();
2413 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2414 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2415 $session = CRM_Core_Session
::singleton();
2417 $mailingACL = self
::mailingACL();
2419 //get all campaigns.
2420 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2422 "$mailing.id", "$mailing.name", "$job.status",
2423 "$mailing.approval_status_id", "createdContact.sort_name as created_by", "scheduledContact.sort_name as scheduled_by",
2424 "$mailing.created_id as created_id", "$mailing.scheduled_id as scheduled_id", "$mailing.is_archived as archived",
2425 "$mailing.created_date as created_date", "campaign_id", "$mailing.sms_provider_id as sms_provider_id",
2426 "$mailing.language",
2429 // we only care about parent jobs, since that holds all the info on
2431 $selectClause = implode(', ', $select);
2432 $groupFromSelect = CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($select, "$mailing.id");
2434 SELECT {$selectClause},
2435 MIN($job.scheduled_date) as scheduled_date,
2436 MIN($job.start_date) as start_date,
2437 MAX($job.end_date) as end_date
2439 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2440 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2441 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2442 WHERE $mailingACL $additionalClause";
2444 if (!empty($groupFromSelect)) {
2445 $query .= $groupFromSelect;
2449 $orderBy = trim($sort->orderBy());
2450 if (!empty($orderBy)) {
2451 $query .= " ORDER BY $orderBy";
2456 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2457 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2459 $query .= " LIMIT $offset, $rowCount ";
2462 if (!$additionalParams) {
2463 $additionalParams = array();
2466 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2469 while ($dao->fetch()) {
2472 'name' => $dao->name
,
2473 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2474 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2475 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2476 'scheduled_iso' => $dao->scheduled_date
,
2477 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2478 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2479 'created_by' => $dao->created_by
,
2480 'scheduled_by' => $dao->scheduled_by
,
2481 'created_id' => $dao->created_id
,
2482 'scheduled_id' => $dao->scheduled_id
,
2483 'archived' => $dao->archived
,
2484 'approval_status_id' => $dao->approval_status_id
,
2485 'campaign_id' => $dao->campaign_id
,
2486 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2487 'sms_provider_id' => $dao->sms_provider_id
,
2488 'language' => $dao->language
,
2495 * Show detail Mailing report.
2501 public static function showEmailDetails($id) {
2502 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2506 * Delete Mails and all its associated records.
2509 * Id of the mail to delete.
2513 public static function del($id) {
2515 CRM_Core_Error
::fatal();
2518 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2520 // delete all file attachments
2521 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2525 $dao = new CRM_Mailing_DAO_Mailing();
2529 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2531 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2536 * Use CRM_Mailing_BAO_MailingJob::del($id)
2539 * Id of the Job to delete.
2543 public static function delJob($id) {
2545 CRM_Core_Error
::fatal();
2548 \Civi
::log('This function is deprecated, use CRM_Mailing_BAO_MailingJob::del instead', ['civi.tag' => 'deprecated']);
2550 CRM_Mailing_BAO_MailingJob
::del($id);
2555 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
2558 public function getReturnProperties() {
2559 $tokens = &$this->getTokens();
2561 $properties = array();
2562 if (isset($tokens['html']) &&
2563 isset($tokens['html']['contact'])
2565 $properties = array_merge($properties, $tokens['html']['contact']);
2568 if (isset($tokens['text']) &&
2569 isset($tokens['text']['contact'])
2571 $properties = array_merge($properties, $tokens['text']['contact']);
2574 if (isset($tokens['subject']) &&
2575 isset($tokens['subject']['contact'])
2577 $properties = array_merge($properties, $tokens['subject']['contact']);
2580 $returnProperties = array();
2581 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2583 foreach ($properties as $p) {
2584 $returnProperties[$p] = 1;
2587 return $returnProperties;
2591 * Build the compose mail form.
2593 * @param CRM_Core_Form $form
2597 public static function commonCompose(&$form) {
2601 if (method_exists($form, 'listTokens')) {
2602 $tokens = array_merge($form->listTokens(), $tokens);
2605 //sorted in ascending order tokens by ignoring word case
2606 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2608 $templates = array();
2610 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2611 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2613 $className = CRM_Utils_System
::getClassName($form);
2615 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2616 $className != 'CRM_Contact_Form_Task_SMS'
2618 $form->add('wysiwyg', 'html_message',
2619 strstr($className, 'PDF') ?
ts('Document Body') : ts('HTML Format'),
2623 'onkeyup' => "return verify(this)",
2627 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2628 unset($modePrefixes['SMS']);
2632 unset($textFields['text_message']);
2633 unset($modePrefixes['Mail']);
2636 //insert message Text by selecting "Select Template option"
2637 foreach ($textFields as $id => $label) {
2639 if ($id == 'sms_text_message') {
2641 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2643 $form->add('textarea', $id, $label,
2647 'onkeyup' => "return verify(this, '{$prefix}')",
2652 foreach ($modePrefixes as $prefix) {
2653 if ($prefix == 'SMS') {
2654 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2657 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2659 if (!empty($templates[$prefix])) {
2660 $form->assign('templates', TRUE);
2662 $form->add('select', "{$prefix}template", ts('Use Template'),
2663 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2664 array('onChange' => "selectValue( this.value, '{$prefix}');")
2667 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2669 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2670 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2672 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2675 // I'm not sure this is ever called.
2676 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2677 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2678 $action == CRM_Core_Action
::VIEW
2680 $form->freeze('html_message');
2685 * Get the search based mailing Ids.
2688 * , searched base mailing ids.
2690 public function searchMailingIDs() {
2691 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2692 $mailing = self
::getTableName();
2695 SELECT $mailing.id as mailing_id
2696 FROM $mailing, $group
2697 WHERE $group.mailing_id = $mailing.id
2698 AND $group.group_type = 'Base'";
2700 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2701 $mailingIDs = array();
2702 while ($searchDAO->fetch()) {
2703 $mailingIDs[] = $searchDAO->mailing_id
;
2710 * Get the content/components of mailing based on mailing Id
2712 * @param array $report
2713 * of mailing report.
2716 * Reference of this.
2718 * @param bool $isSMS
2721 * array content/component.
2723 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2724 $htmlHeader = $textHeader = NULL;
2725 $htmlFooter = $textFooter = NULL;
2728 if ($report['mailing']['header_id']) {
2729 $header = new CRM_Mailing_BAO_MailingComponent();
2730 $header->id
= $report['mailing']['header_id'];
2731 $header->find(TRUE);
2732 $htmlHeader = $header->body_html
;
2733 $textHeader = $header->body_text
;
2736 if ($report['mailing']['footer_id']) {
2737 $footer = new CRM_Mailing_BAO_MailingComponent();
2738 $footer->id
= $report['mailing']['footer_id'];
2739 $footer->find(TRUE);
2740 $htmlFooter = $footer->body_html
;
2741 $textFooter = $footer->body_text
;
2745 $mailingKey = $form->_mailing_id
;
2747 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2748 $mailingKey = $hash;
2752 if (!empty($report['mailing']['body_text'])) {
2753 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2754 $form->assign('textViewURL', $url);
2758 if (!empty($report['mailing']['body_html'])) {
2759 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2760 $form->assign('htmlViewURL', $url);
2765 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2775 public static function overrideVerp($jobID) {
2776 static $_cache = array();
2778 if (!isset($_cache[$jobID])) {
2780 SELECT override_verp
2781 FROM civicrm_mailing
2782 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2783 WHERE civicrm_mailing_job.id = %1
2785 $params = array(1 => array($jobID, 'Integer'));
2786 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2788 return $_cache[$jobID];
2797 public static function processQueue($mode = NULL) {
2798 $config = CRM_Core_Config
::singleton();
2800 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2801 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(
2802 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2803 2 => "https://docs.civicrm.org/sysadmin/en/latest/setup/civimail/",
2807 // check if we are enforcing number of parallel cron jobs
2809 $gotCronLock = FALSE;
2811 $mailerJobsMax = Civi
::settings()->get('mailerJobsMax');
2812 if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2813 $lockArray = range(1, $mailerJobsMax);
2815 // Shuffle the array to improve chances of quickly finding an open thread
2816 shuffle($lockArray);
2818 // Check if we are using global locks
2819 foreach ($lockArray as $lockID) {
2820 $cronLock = Civi
::lockManager()->acquire("worker.mailing.send.{$lockID}");
2821 if ($cronLock->isAcquired()) {
2822 $gotCronLock = TRUE;
2827 // Exit here since we have enough mailing processes running
2828 if (!$gotCronLock) {
2829 CRM_Core_Error
::debug_log_message('Returning early, since the maximum number of mailing processes are running');
2833 if (getenv('CIVICRM_CRON_HOLD')) {
2834 // In testing, we may need to simulate some slow activities.
2835 sleep(getenv('CIVICRM_CRON_HOLD'));
2839 // Split up the parent jobs into multiple child jobs
2840 $mailerJobSize = Civi
::settings()->get('mailerJobSize');
2841 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2842 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2843 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2845 // Release the global lock if we do have one
2847 $cronLock->release();
2854 * @param int $mailingID
2856 private static function addMultipleEmails($mailingID) {
2858 INSERT INTO civicrm_mailing_recipients
2859 (mailing_id, email_id, contact_id)
2860 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2862 AND e.is_bulkmail = 1
2864 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2865 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2867 $params = array(1 => array($mailingID, 'Integer'));
2869 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2873 * @param bool $isSMS
2877 public static function getMailingsList($isSMS = FALSE) {
2878 static $list = array();
2881 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2884 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2889 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2890 FROM civicrm_mailing
2891 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2892 ORDER BY civicrm_mailing.name";
2893 $mailing = CRM_Core_DAO
::executeQuery($query);
2895 while ($mailing->fetch()) {
2896 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2904 * wrapper for ajax activity selector.
2906 * @param array $params
2907 * Associated array for params record id.
2910 * associated array of contact activities
2912 public static function getContactMailingSelector(&$params) {
2913 // format the params
2914 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2915 $params['rowCount'] = $params['rp'];
2916 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2917 $params['caseId'] = NULL;
2919 // get contact mailings
2920 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2923 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2926 if (!empty($mailings)) {
2927 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2928 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2931 // format params and add links
2932 $contactMailings = array();
2933 foreach ($mailings as $mailingId => $values) {
2935 $mailing['subject'] = $values['subject'];
2936 $mailing['creator_name'] = CRM_Utils_System
::href(
2937 $values['creator_name'],
2938 'civicrm/contact/view',
2939 "reset=1&cid={$values['creator_id']}");
2940 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2941 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2942 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2944 $mailing['openstats'] = "Opens: " .
2945 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
2947 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
2949 $actionLinks = array(
2950 CRM_Core_Action
::VIEW
=> array(
2951 'name' => ts('View'),
2952 'url' => 'civicrm/mailing/view',
2953 'qs' => "reset=1&id=%%mkey%%",
2954 'title' => ts('View Mailing'),
2955 'class' => 'crm-popup',
2957 CRM_Core_Action
::BROWSE
=> array(
2958 'name' => ts('Mailing Report'),
2959 'url' => 'civicrm/mailing/report',
2960 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
2961 'title' => ts('View Mailing Report'),
2965 $mailingKey = $values['mailing_id'];
2966 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2967 $mailingKey = $hash;
2970 $mailing['links'] = CRM_Core_Action
::formLink(
2974 'mid' => $values['mailing_id'],
2975 'cid' => $params['contact_id'],
2976 'mkey' => $mailingKey,
2980 'mailing.contact.action',
2982 $values['mailing_id']
2985 array_push($contactMailings, $mailing);
2988 $contactMailingsDT = array();
2989 $contactMailingsDT['data'] = $contactMailings;
2990 $contactMailingsDT['recordsTotal'] = $params['total'];
2991 $contactMailingsDT['recordsFiltered'] = $params['total'];
2993 return $contactMailingsDT;
2997 * Retrieve contact mailing.
2999 * @param array $params
3002 * Array of mailings for a contact
3005 static public function getContactMailings(&$params) {
3006 $params['version'] = 3;
3007 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3008 $params['limit'] = $params['rp'];
3009 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3011 $result = civicrm_api('MailingContact', 'get', $params);
3012 return $result['values'];
3016 * Retrieve contact mailing count.
3018 * @param array $params
3021 * count of mailings for a contact
3024 static public function getContactMailingsCount(&$params) {
3025 $params['version'] = 3;
3026 return civicrm_api('MailingContact', 'getcount', $params);
3030 * Get a list of permissions required for CRUD'ing each field
3031 * (when workflow is enabled).
3034 * Array (string $fieldName => string $permName)
3036 public static function getWorkflowFieldPerms() {
3037 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3038 $fieldPerms = array();
3039 foreach ($fieldNames as $fieldName) {
3040 if ($fieldName == 'id') {
3041 $fieldPerms[$fieldName] = array(
3042 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3045 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3046 $fieldPerms[$fieldName] = array(
3047 array('access CiviMail', 'schedule mailings'), // OR
3050 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3051 $fieldPerms[$fieldName] = array(
3052 array('access CiviMail', 'approve mailings'), // OR
3056 $fieldPerms[$fieldName] = array(
3057 array('access CiviMail', 'create mailings'), // OR
3065 * White-list of possible values for the entity_table field.
3069 public static function mailingGroupEntityTables() {
3071 CRM_Contact_BAO_Group
::getTableName() => 'Group',
3072 CRM_Mailing_BAO_Mailing
::getTableName() => 'Mailing',
3077 * Get the public view url.
3080 * @param bool $absolute
3084 public static function getPublicViewUrl($id, $absolute = TRUE) {
3085 if ((civicrm_api3('Mailing', 'getvalue', array('id' => $id, 'return' => 'visibility'))) === 'Public Pages') {
3086 return CRM_Utils_System
::url('civicrm/mailing/view', array('id' => $id), $absolute, NULL, TRUE, TRUE);
3091 * Get a list of template types which can be used as `civicrm_mailing.template_type`.
3094 * A list of template-types, keyed numerically. Each defines:
3095 * - name: string, a short symbolic name
3096 * - editorUrl: string, Angular template name
3098 * Ex: $templateTypes[0] === array('name' => 'mosaico', 'editorUrl' => '~/crmMosaico/editor.html').
3100 public static function getTemplateTypes() {
3101 if (!isset(Civi
::$statics[__CLASS__
]['templateTypes'])) {
3104 'name' => 'traditional',
3105 'editorUrl' => CRM_Mailing_Info
::workflowEnabled() ?
'~/crmMailing/EditMailingCtrl/workflow.html' : '~/crmMailing/EditMailingCtrl/2step.html',
3109 CRM_Utils_Hook
::mailingTemplateTypes($types);
3111 $defaults = array('weight' => 0);
3112 foreach (array_keys($types) as $typeName) {
3113 $types[$typeName] = array_merge($defaults, $types[$typeName]);
3115 usort($types, function ($a, $b) {
3116 if ($a['weight'] === $b['weight']) {
3119 return $a['weight'] < $b['weight'] ?
-1 : 1;
3122 Civi
::$statics[__CLASS__
]['templateTypes'] = $types;
3125 return Civi
::$statics[__CLASS__
]['templateTypes'];
3129 * Get a list of template types.
3132 * Array(string $name => string $label).
3134 public static function getTemplateTypeNames() {
3136 foreach (self
::getTemplateTypes() as $type) {
3137 $r[$type['name']] = $type['name'];