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("contact_id, $entityColumn")
286 ->where('mailing_id IN (#mailings)')
287 ->param('#mailings', $priorMailingIDs['Include'])
288 ->insertIgnoreInto($includedTempTablename, array('contact_id', $entityColumn))
292 if (count($includeSmartGroupIDs)) {
293 $query = CRM_Utils_SQL_Select
::from($contact)
294 ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
295 ->join($entityTable, " INNER JOIN $entityTable ON $entityTable.contact_id = $contact.id ")
296 ->join('gc', " INNER JOIN civicrm_group_contact_cache gc ON $contact.id = gc.contact_id ")
297 ->join('mg', " INNER JOIN civicrm_mailing_group mg ON gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
298 ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
299 ->where('gc.group_id IN (#groups)')
301 ->replaceInto($includedTempTablename, array('contact_id', $entityColumn))
302 ->param('#groups', $includeSmartGroupIDs)
303 ->param('#mailingID', $mailingID)
307 // Construct the filtered search queries.
308 $dao = CRM_Utils_SQL_Select
::from('civicrm_mailing_group')
309 ->select('search_id, search_args, entity_id')
310 ->where('search_id IS NOT NULL AND mailing_id = #mailingID')
311 ->param('#mailingID', $mailingID)
313 while ($dao->fetch()) {
314 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
318 $query = "REPLACE INTO {$includedTempTablename} ($entityColumn, contact_id) {$customSQL} ";
319 $mailingGroup->query($query);
322 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
324 // clear all the mailing recipients before populating
325 CRM_Core_DAO
::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE mailing_id = %1 ", array(1 => array($mailingID, 'Integer')));
327 $selectClause = array('#mailingID', 'i.contact_id', "i.$entityColumn");
329 $orderBy = array("i.contact_id", "i.$entityColumn");
331 $query = CRM_Utils_SQL_Select
::from('civicrm_contact contact_a')->join('i', " INNER JOIN {$includedTempTablename} i ON contact_a.id = i.contact_id ");
332 if (!$isSMSmode && $mailingObj->dedupe_email
) {
333 $orderBy = array("MIN(i.contact_id)", "MIN(i.$entityColumn)");
334 $query = $query->join('e', " INNER JOIN civicrm_email e ON e.id = i.email_id ")->groupBy("e.email");
335 if (CRM_Utils_SQL
::supportsFullGroupBy()) {
336 $selectClause = array('#mailingID', 'ANY_VALUE(i.contact_id) contact_id', "ANY_VALUE(i.$entityColumn) $entityColumn", "e.email");
340 $query = $query->select($selectClause)->orderBy($orderBy);
341 if (!CRM_Utils_System
::isNull($aclFrom)) {
342 $query = $query->join('acl', $aclFrom);
344 if (!CRM_Utils_System
::isNull($aclWhere)) {
345 $query = $query->where($aclWhere);
348 // this mean if dedupe_email AND the mysql 5.7 supports ONLY_FULL_GROUP_BY mode then as
349 // SELECT must contain 'email' column as its used in GROUP BY, so in order to resolve This
350 // here the whole SQL code is wrapped up in FROM table i and not selecting email column for INSERT
351 if ($key = array_search('e.email', $selectClause)) {
352 unset($selectClause[$key]);
353 $sql = $query->toSQL();
354 CRM_Utils_SQL_Select
::from("( $sql ) AS i ")
355 ->select($selectClause)
356 ->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
357 ->param('#mailingID', $mailingID)
361 $query->insertInto('civicrm_mailing_recipients', array('mailing_id', 'contact_id', $entityColumn))
362 ->param('#mailingID', $mailingID)
366 // if we need to add all emails marked bulk, do it as a post filter
367 // on the mailing recipients table
368 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
369 self
::addMultipleEmails($mailingID);
372 // Delete the temp table.
373 $mailingGroup->reset();
374 $mailingGroup->query(" DROP TEMPORARY TABLE $excludeTempTablename ");
375 $mailingGroup->query(" DROP TEMPORARY TABLE $includedTempTablename ");
377 CRM_Utils_Hook
::alterMailingRecipients($mailingObj, $criteria, 'post');
381 * Function to retrieve location filter and order by clause later used by SQL query that is used to fetch and include mailing recipients
383 * @param string $email_selection_method
384 * @param int $location_type_id
388 public static function getLocationFilterAndOrderBy($email_selection_method, $location_type_id) {
389 $email = CRM_Core_DAO_Email
::getTableName();
390 // Note: When determining the ORDER that results are returned, it's
391 // the record that comes last that counts. That's because we are
392 // INSERT'ing INTO a table with a primary id so that last record
393 // over writes any previous record.
394 switch ($email_selection_method) {
395 case 'location-exclude':
396 $location_filter = "($email.location_type_id != $location_type_id)";
397 // If there is more than one email that doesn't match the location,
398 // prefer the one marked is_bulkmail, followed by is_primary.
399 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
402 case 'location-only':
403 $location_filter = "($email.location_type_id = $location_type_id)";
404 // If there is more than one email of the desired location, prefer
405 // the one marked is_bulkmail, followed by is_primary.
406 $orderBy = array("$email.is_bulkmail", "$email.is_primary");
409 case 'location-prefer':
410 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
411 // ORDER BY is more complicated because we have to set an arbitrary
412 // order that prefers the location that we want. We do that using
413 // the FIELD function. For more info, see:
414 // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
415 // We assign the location type we want the value "1" by putting it
416 // in the first position after we name the field. All other location
417 // types are left out, so they will be assigned the value 0. That
418 // means, they will all be equally tied for first place, with our
419 // location being last.
420 $orderBy = array("FIELD($email.location_type_id, $location_type_id)", "$email.is_bulkmail", "$email.is_primary");
424 // fall through to default
426 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
427 $orderBy = array("$email.is_bulkmail");
430 return array($location_filter, $orderBy);
434 * @param string $type
438 private function _getMailingGroupIds($type = 'Include') {
439 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
440 $group = CRM_Contact_DAO_Group
::getTableName();
441 if (!isset($this->id
)) {
442 // we're just testing tokens, so return any group
443 $query = "SELECT id AS entity_id
449 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
450 $query = "SELECT entity_id
452 WHERE mailing_id = {$this->id}
453 AND group_type = '$type'
454 AND entity_table = '$group'";
456 $mailingGroup->query($query);
459 while ($mailingGroup->fetch()) {
460 $groupIds[] = $mailingGroup->entity_id
;
467 * Returns the regex patterns that are used for preparing the text and html templates.
469 * @param bool $onlyHrefs
471 * @return array|string
473 private function getPatterns($onlyHrefs = FALSE) {
477 $protos = '(https?|ftp|mailto)';
479 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
481 $any = "{$letters}{$gunk}{$punc}";
483 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
486 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
489 $patterns[] = $pattern;
490 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
491 $patterns[] = '\{\w+\.\w+\}';
493 $patterns = '{' . implode('|', $patterns) . '}imu';
499 * Returns an array that denotes the type of token that we are dealing with
500 * we use the type later on when we are doing a token replacement lookup
502 * @param string $token
503 * The token for which we will be doing adata lookup.
506 * An array that holds the token itself and the type.
507 * the type will tell us which function to use for the data lookup
508 * if we need to do a lookup at all
510 public function &getDataFunc($token) {
511 static $_categories = NULL;
512 static $_categoryString = NULL;
514 $_categories = array(
521 CRM_Utils_Hook
::tokens($_categories);
522 $_categoryString = implode('|', array_keys($_categories));
525 $funcStruct = array('type' => NULL, 'token' => $token);
527 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
528 // it is a url so we need to check to see if there are any tokens embedded
529 // if so then call this function again to get the token dataFunc
530 // and assign the type 'embedded' so that the data retrieving function
531 // will know what how to handle this token.
532 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
533 $funcStruct['type'] = 'embedded_url';
534 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
535 foreach ($matches[1] as $match) {
536 $preg_token = '/' . preg_quote($match, '/') . '/';
537 $list = preg_split($preg_token, $token, 2);
538 $funcStruct['embed_parts'][] = $list[0];
540 $funcStruct['token'][] = $this->getDataFunc($match);
542 // fixed truncated url, CRM-7113
544 $funcStruct['embed_parts'][] = $token;
548 $funcStruct['type'] = 'url';
551 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
552 $funcStruct['type'] = $matches[1];
553 $funcStruct['token'] = $matches[2];
555 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
556 // we are an escaped token
557 // so remove the escape chars
558 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
559 $funcStruct['token'] = '{' . $unescaped_token . '}';
565 * Prepares the text and html templates
566 * for generating the emails and returns a copy of the
570 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
572 private function getPreparedTemplates() {
573 if (!$this->preparedTemplates
) {
574 $patterns['html'] = $this->getPatterns(TRUE);
575 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
576 $templates = $this->getTemplates();
578 $this->preparedTemplates
= array();
585 if (!isset($templates[$key])) {
591 $split_template = array();
593 $email = $templates[$key];
594 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
595 foreach ($matches[0] as $idx => $token) {
596 $preg_token = '/' . preg_quote($token, '/') . '/im';
597 list($split_template[], $email) = preg_split($preg_token, $email, 2);
598 array_push($tokens, $this->getDataFunc($token));
601 $split_template[] = $email;
603 $this->preparedTemplates
[$key]['template'] = $split_template;
604 $this->preparedTemplates
[$key]['tokens'] = $tokens;
607 return ($this->preparedTemplates
);
611 * Retrieve a ref to an array that holds the email and text templates for this email
612 * assembles the complete template including the header and footer
613 * that the user has uploaded or declared (if they have done that)
616 * reference to an assoc array
618 public function getTemplates() {
619 if (!$this->templates
) {
620 $this->getHeaderFooter();
621 $this->templates
= array();
622 if ($this->body_text ||
!empty($this->header
)) {
624 if (!empty($this->header
->body_text
)) {
625 $template[] = $this->header
->body_text
;
627 elseif (!empty($this->header
->body_html
)) {
628 $template[] = CRM_Utils_String
::htmlToText($this->header
->body_html
);
631 if ($this->body_text
) {
632 $template[] = $this->body_text
;
635 $template[] = CRM_Utils_String
::htmlToText($this->body_html
);
638 if (!empty($this->footer
->body_text
)) {
639 $template[] = $this->footer
->body_text
;
641 elseif (!empty($this->footer
->body_html
)) {
642 $template[] = CRM_Utils_String
::htmlToText($this->footer
->body_html
);
645 $this->templates
['text'] = implode("\n", $template);
648 // To check for an html part strip tags
649 if (trim(strip_tags($this->body_html
, '<img>'))) {
653 $template[] = $this->header
->body_html
;
656 $template[] = $this->body_html
;
659 $template[] = $this->footer
->body_html
;
662 $this->templates
['html'] = implode("\n", $template);
664 // this is where we create a text template from the html template if the text template did not exist
665 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
666 // user uploads an html email only
667 if (empty($this->templates
['text'])) {
668 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
672 if ($this->subject
) {
674 $template[] = $this->subject
;
675 $this->templates
['subject'] = implode("\n", $template);
678 CRM_Utils_Hook
::alterMailContent($this->templates
);
680 return $this->templates
;
685 * Retrieve a ref to an array that holds all of the tokens in the email body
686 * where the keys are the type of token and the values are ordinal arrays
687 * that hold the token names (even repeated tokens) in the order in which
688 * they appear in the body of the email.
690 * note: the real work is done in the _getTokens() function
692 * this function needs to have some sort of a body assigned
693 * either text or html for this to have any meaningful impact
696 * reference to an assoc array
698 public function &getTokens() {
699 if (!$this->tokens
) {
701 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
703 if ($this->body_html
) {
704 $this->_getTokens('html');
705 if (!$this->body_text
) {
706 // Since the text template was created from html, use the html tokens.
707 // @see CRM_Mailing_BAO_Mailing::getTemplates()
708 $this->tokens
['text'] = $this->tokens
['html'];
712 if ($this->body_text
) {
713 $this->_getTokens('text');
716 if ($this->subject
) {
717 $this->_getTokens('subject');
721 return $this->tokens
;
725 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
726 * hook in one call and standardizes it across other token workflows
729 * reference to an assoc array
731 public function &getFlattenedTokens() {
732 if (!$this->flattenedTokens
) {
733 $tokens = $this->getTokens();
735 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
738 return $this->flattenedTokens
;
743 * _getTokens parses out all of the tokens that have been
744 * included in the html and text bodies of the email
745 * we get the tokens and then separate them into an
746 * internal structure named tokens that has the same
747 * form as the static tokens property(?) of the CRM_Utils_Token class.
748 * The difference is that there might be repeated token names as we want the
749 * structures to represent the order in which tokens were found from left to right, top to bottom.
752 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
753 * Name of the property that holds the text that we want to scan for tokens (html, text).
757 private function _getTokens($prop) {
758 $templates = $this->getTemplates();
760 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
762 foreach ($newTokens as $type => $names) {
763 if (!isset($this->tokens
[$prop][$type])) {
764 $this->tokens
[$prop][$type] = array();
766 foreach ($names as $key => $name) {
767 $this->tokens
[$prop][$type][] = $name;
773 * Generate an event queue for a test job.
775 * @param array $testParams
776 * Contains form values.
780 public function getTestRecipients($testParams) {
781 if (!empty($testParams['test_group']) && array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
782 $contacts = civicrm_api('contact', 'get', array(
784 'group' => $testParams['test_group'],
787 'limit' => 100000000000,
792 foreach (array_keys($contacts['values']) as $groupContact) {
794 SELECT civicrm_email.id AS email_id,
795 civicrm_email.is_primary as is_primary,
796 civicrm_email.is_bulkmail as is_bulkmail
798 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
799 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
800 AND civicrm_contact.id = {$groupContact}
801 AND civicrm_contact.do_not_email = 0
802 AND civicrm_contact.is_deceased <> 1
803 AND civicrm_email.on_hold = 0
804 AND civicrm_contact.is_opt_out = 0
805 GROUP BY civicrm_email.id
806 ORDER BY civicrm_email.is_bulkmail DESC
808 $dao = CRM_Core_DAO
::executeQuery($query);
811 'job_id' => $testParams['job_id'],
812 'email_id' => $dao->email_id
,
813 'contact_id' => $groupContact,
815 CRM_Mailing_Event_BAO_Queue
::create($params);
822 * Load this->header and this->footer.
824 private function getHeaderFooter() {
825 if (!$this->header
and $this->header_id
) {
826 $this->header
= new CRM_Mailing_BAO_Component();
827 $this->header
->id
= $this->header_id
;
828 $this->header
->find(TRUE);
829 $this->header
->free();
832 if (!$this->footer
and $this->footer_id
) {
833 $this->footer
= new CRM_Mailing_BAO_Component();
834 $this->footer
->id
= $this->footer_id
;
835 $this->footer
->find(TRUE);
836 $this->footer
->free();
841 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
842 * add a Message-ID header if needed.
844 * i.e. if the global includeMessageId is set and there isn't already a
845 * Message-ID in the array.
846 * The message ID is structured the same way as a verp. However no interpretation
847 * is placed on the values received, so they do not need to follow the verp
850 * @param array $headers
851 * Array of message headers to update, in-out.
852 * @param string $prefix
853 * Prefix for the message ID, use same prefixes as verp.
855 * @param string $job_id
856 * Job ID component of the generated message ID.
857 * @param string $event_queue_id
858 * Event Queue ID component of the generated message ID.
859 * @param string $hash
860 * Hash component of the generated message ID.
864 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
865 $config = CRM_Core_Config
::singleton();
866 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
867 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
868 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
870 $fields[] = 'Message-ID';
871 // CRM-17754 check if Resent-Message-id is set also if not add it in when re-laying reply email
872 if ($prefix == 'r') {
873 $fields[] = 'Resent-Message-ID';
875 foreach ($fields as $field) {
876 if ($includeMessageId && (!array_key_exists($field, $headers))) {
877 $headers[$field] = '<' . implode($config->verpSeparator
,
879 $localpart . $prefix,
884 ) . "@{$emailDomain}>";
891 * Static wrapper for getting verp and urls.
894 * ID of the Job associated with this message.
895 * @param int $event_queue_id
896 * ID of the EventQueue.
897 * @param string $hash
898 * Hash of the EventQueue.
899 * @param string $email
900 * Destination address.
903 * (reference) array array ref that hold array refs to the verp info and urls
905 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
906 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
907 $config = CRM_Core_Config
::singleton();
908 $bao = new CRM_Mailing_BAO_Mailing();
909 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
910 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
912 // use $bao's instance method to get verp and urls
913 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
914 return array($verp, $urls);
918 * Get verp, urls and headers
921 * ID of the Job associated with this message.
922 * @param int $event_queue_id
923 * ID of the EventQueue.
924 * @param string $hash
925 * Hash of the EventQueue.
926 * @param string $email
927 * Destination address.
929 * @param bool $isForward
932 * array ref that hold array refs to the verp info, urls, and headers
934 public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
935 $config = CRM_Core_Config
::singleton();
939 * reply: user replied to mailing
940 * bounce: email address bounced
941 * unsubscribe: contact opts out of all target lists for the mailing
942 * resubscribe: contact opts back into all target lists for the mailing
943 * optOut: contact unsubscribes from the domain
949 'unsubscribe' => 'u',
950 'resubscribe' => 'e',
954 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
955 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
956 // 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
957 if (empty($emailDomain)) {
958 CRM_Core_Error
::debug_log_message('Error setting verp parameters, defaultDomain is NULL. Did you configure the bounce processing account for this domain?');
961 foreach ($verpTokens as $key => $value) {
962 $verp[$key] = implode($config->verpSeparator
,
972 //handle should override VERP address.
976 self
::overrideVerp($job_id)
978 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
982 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
983 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
984 TRUE, NULL, TRUE, TRUE
986 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
987 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
988 TRUE, NULL, TRUE, TRUE
990 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
991 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
992 TRUE, NULL, TRUE, TRUE
994 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
995 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
996 TRUE, NULL, TRUE, TRUE
998 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1000 TRUE, NULL, TRUE, TRUE
1005 'Reply-To' => $verp['reply'],
1006 'Return-Path' => $verp['bounce'],
1007 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1008 'Subject' => $this->subject
,
1009 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1011 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1013 $headers['Subject'] = "[Fwd:{$this->subject}]";
1015 return array(&$verp, &$urls, &$headers);
1019 * Compose a message.
1022 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1023 * @param int $job_id
1024 * ID of the Job associated with this message.
1025 * @param int $event_queue_id
1026 * ID of the EventQueue.
1027 * @param string $hash
1028 * Hash of the EventQueue.
1029 * @param string $contactId
1030 * ID of the Contact.
1031 * @param string $email
1032 * Destination address.
1033 * @param string $recipient
1034 * To: of the recipient.
1036 * Is this mailing a test?.
1037 * @param $contactDetails
1038 * @param $attachments
1039 * @param bool $isForward
1040 * Is this mailing compose for forward?.
1041 * @param string $fromEmail
1042 * Email address of who is forwardinf it.
1044 * @param null $replyToEmail
1046 * @return Mail_mime The mail object
1048 public function compose(
1049 $job_id, $event_queue_id, $hash, $contactId,
1050 $email, &$recipient, $test,
1051 $contactDetails, &$attachments, $isForward = FALSE,
1052 $fromEmail = NULL, $replyToEmail = NULL
1054 $config = CRM_Core_Config
::singleton();
1057 if ($this->_domain
== NULL) {
1058 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1061 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1069 //set from email who is forwarding it and not original one.
1071 unset($headers['From']);
1072 $headers['From'] = "<{$fromEmail}>";
1075 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1076 $headers['Reply-To'] = "{$replyToEmail}";
1079 if ($contactDetails) {
1080 $contact = $contactDetails;
1082 elseif ($contactId === 0) {
1085 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1088 $params = array(array('contact_id', '=', $contactId, 0, 0));
1089 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1092 $contact = reset($contact);
1094 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1095 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1096 array(1 => $contactId)
1098 // setting this because function is called by reference
1099 //@todo test not calling function by reference
1104 // also call the hook to get contact details
1105 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1108 $pTemplates = $this->getPreparedTemplates();
1111 foreach ($pTemplates as $type => $pTemplate) {
1112 $html = ($type == 'html') ?
TRUE : FALSE;
1113 $pEmails[$type] = array();
1114 $pEmail = &$pEmails[$type];
1115 $template = &$pTemplates[$type]['template'];
1116 $tokens = &$pTemplates[$type]['tokens'];
1118 if (!empty($tokens)) {
1119 foreach ($tokens as $idx => $token) {
1120 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1121 array_push($pEmail, $template[$idx]);
1122 array_push($pEmail, $token_data);
1126 array_push($pEmail, $template[$idx]);
1129 if (isset($template[($idx +
1)])) {
1130 array_push($pEmail, $template[($idx +
1)]);
1135 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1136 $html = &$pEmails['html'];
1140 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1141 $text = &$pEmails['text'];
1144 // push the tracking url on to the html email if necessary
1145 if ($this->open_tracking
&& $html) {
1146 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1147 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1151 $message = new Mail_mime("\n");
1153 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1155 $smarty = CRM_Core_Smarty
::singleton();
1156 // also add the contact tokens to the template
1157 $smarty->assign_by_ref('contact', $contact);
1160 $mailParams = $headers;
1161 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1162 $contact['preferred_mail_format'] == 'Both' ||
1163 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1166 $textBody = implode('', $text);
1168 $textBody = $smarty->fetch("string:$textBody");
1170 $mailParams['text'] = $textBody;
1173 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1174 $contact['preferred_mail_format'] == 'Both'
1177 $htmlBody = implode('', $html);
1179 $htmlBody = $smarty->fetch("string:$htmlBody");
1181 $mailParams['html'] = $htmlBody;
1184 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1186 // something went wrong, lets log it and return null (by reference)
1187 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1194 $mailParams['attachments'] = $attachments;
1196 $mailParams['Subject'] = CRM_Utils_Array
::value('subject', $pEmails);
1197 if (is_array($mailParams['Subject'])) {
1198 $mailParams['Subject'] = implode('', $mailParams['Subject']);
1201 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1204 $mailParams['toEmail'] = $email;
1206 // Add job ID to mailParams for external email delivery service to utilise
1207 $mailParams['job_id'] = $job_id;
1209 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1211 // CRM-10699 support custom email headers
1212 if (!empty($mailParams['headers'])) {
1213 $headers = array_merge($headers, $mailParams['headers']);
1215 //cycle through mailParams and set headers array
1216 foreach ($mailParams as $paramKey => $paramValue) {
1217 //exclude values not intended for the header
1218 if (!in_array($paramKey, array(
1226 $headers[$paramKey] = $paramValue;
1230 if (!empty($mailParams['text'])) {
1231 $message->setTxtBody($mailParams['text']);
1234 if (!empty($mailParams['html'])) {
1235 $message->setHTMLBody($mailParams['html']);
1238 if (!empty($mailParams['attachments'])) {
1239 foreach ($mailParams['attachments'] as $fileID => $attach) {
1240 $message->addAttachment($attach['fullPath'],
1241 $attach['mime_type'],
1242 $attach['cleanName']
1247 //pickup both params from mail params.
1248 $toName = trim($mailParams['toName']);
1249 $toEmail = trim($mailParams['toEmail']);
1250 if ($toName == $toEmail ||
1251 strpos($toName, '@') !== FALSE
1256 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1259 $headers['To'] = "$toName <$toEmail>";
1261 $headers['Precedence'] = 'bulk';
1262 // Will test in the mail processor if the X-VERP is set in the bounced email.
1263 // (As an option to replace real VERP for those that can't set it up)
1264 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1267 //token replacement of subject
1268 $headers['Subject'] = $mailParams['Subject'];
1270 CRM_Utils_Mail
::setMimeParams($message);
1271 $headers = $message->headers($headers);
1273 //get formatted recipient
1274 $recipient = $headers['To'];
1276 // make sure we unset a lot of stuff
1289 * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
1292 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1293 * @param CRM_Mailing_BAO_Mailing $mailing
1295 public static function tokenReplace(&$mailing) {
1296 $domain = CRM_Core_BAO_Domain
::getDomain();
1298 foreach (array('text', 'html') as $type) {
1299 $tokens = $mailing->getTokens();
1300 if (isset($mailing->templates
[$type])) {
1301 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1302 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1303 $mailing->templates
[$type],
1305 $type == 'html' ?
TRUE : FALSE,
1308 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1314 * Get data to resolve tokens.
1317 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1319 * @param array $token_a
1321 * Whether to encode the token result for use in HTML email
1322 * @param array $contact
1323 * @param string $verp
1324 * @param array $urls
1325 * @param int $event_queue_id
1327 * @return bool|mixed|null|string
1329 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1330 $type = $token_a['type'];
1331 $token = $token_a['token'];
1334 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1336 if ($type == 'embedded_url') {
1337 $embed_data = array();
1338 foreach ($token as $t) {
1339 $embed_data[] = $this->getTokenData($t, $html, $contact, $verp, $urls, $event_queue_id);
1341 $numSlices = count($embed_data);
1343 for ($i = 0; $i < $numSlices; $i++
) {
1344 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1346 if (isset($token_a['embed_parts'][$numSlices])) {
1347 $url .= $token_a['embed_parts'][$numSlices];
1349 // add trailing quote since we've gobbled it up in a previous regex
1350 // function getPatterns, line 431
1351 if (preg_match("/^href[ ]*=[ ]*'.*[^']$/", $url)) {
1354 elseif (preg_match('/^href[ ]*=[ ]*".*[^"]$/', $url)) {
1358 // CRM-20206 Fix ampersand encoding in plain text emails
1360 $data = CRM_Utils_String
::unstupifyUrl($data);
1363 elseif ($type == 'url') {
1364 if ($this->url_tracking
) {
1365 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1366 if (!empty($html)) {
1367 $data = htmlentities($data, ENT_NOQUOTES
);
1374 elseif ($type == 'contact') {
1375 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1377 elseif ($type == 'action') {
1378 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1380 elseif ($type == 'domain') {
1381 $domain = CRM_Core_BAO_Domain
::getDomain();
1382 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1384 elseif ($type == 'mailing') {
1385 if ($token == 'name') {
1386 $data = $this->name
;
1388 elseif ($token == 'group') {
1389 $groups = $this->getGroupNames();
1390 $data = implode(', ', $groups);
1394 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1400 * Return a list of group names for this mailing. Does not work with
1401 * prior-mailing targets.
1404 * Names of groups receiving this mailing
1406 public function &getGroupNames() {
1407 if (!isset($this->id
)) {
1410 $mg = new CRM_Mailing_DAO_MailingGroup();
1411 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1412 $group = CRM_Contact_BAO_Group
::getTableName();
1414 $mg->query("SELECT $group.title as name FROM $mgtable
1415 INNER JOIN $group ON $mgtable.entity_id = $group.id
1416 WHERE $mgtable.mailing_id = {$this->id}
1417 AND $mgtable.entity_table = '$group'
1418 AND $mgtable.group_type = 'Include'
1419 ORDER BY $group.name");
1422 while ($mg->fetch()) {
1423 $groups[] = $mg->name
;
1432 * @param array $params
1433 * Reference array contains the values submitted by the form.
1435 * Reference array contains the id.
1438 * @return CRM_Mailing_DAO_Mailing
1440 public static function add(&$params, $ids = array()) {
1441 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('mailing_id', $ids));
1443 if (empty($params['id']) && !empty($ids)) {
1444 \Civi
::log('Parameter $ids is no longer used by Mailing::add. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1448 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1451 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1454 $mailing = new static();
1457 $mailing->find(TRUE);
1459 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1461 if (((!$id && empty($params['replyto_email'])) ||
!isset($params['replyto_email'])) &&
1462 isset($params['from_email'])
1464 $params['replyto_email'] = $params['from_email'];
1466 $mailing->copyValues($params);
1468 // CRM-20892 Unset Modifed Date here so that MySQL can correctly set an updated modfied date.
1469 unset($mailing->modified_date
);
1470 $result = $mailing->save();
1472 // CRM-20892 Re find record after saing so we can set the updated modified date in the result.
1473 $mailing->find(TRUE);
1475 if (isset($mailing->modified_date
)) {
1476 $result->modified_date
= $mailing->modified_date
;
1480 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1483 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1490 * Construct a new mailing object, along with job and mailing_group
1491 * objects, from the form values of the create mailing wizard.
1493 * This function is a bit evil. It not only merges $params and saves
1494 * the mailing -- it also schedules the mailing and chooses the recipients.
1495 * Since it merges $params, it's also the only place to correctly trigger
1496 * multi-field validation. It should be broken up.
1498 * In the mean time, use-cases which break under the weight of this
1499 * evil may find reprieve in these extra evil params:
1501 * - _skip_evil_bao_auto_recipients_: bool
1502 * - _skip_evil_bao_auto_schedule_: bool
1503 * - _evil_bao_validator_: string|callable
1505 * </twowrongsmakesaright>
1507 * @params array $params
1510 * @param array $params
1514 * $mailing The new mailing object
1515 * @throws \Exception
1517 public static function create(&$params, $ids = array()) {
1519 if (empty($params['id']) && (array_filter($ids) !== [])) {
1520 $params['id'] = isset($ids['mailing_id']) ?
$ids['mailing_id'] : $ids['id'];
1521 \Civi
::log('Parameter $ids is no longer used by Mailing::create. Use the api or just pass $params', ['civi.tag' => 'deprecated']);
1525 // Do the below only for an insert
1526 // for an update, we should not set the defaults
1527 if (!isset($params['id'])) {
1528 // Retrieve domain email and name for default sender
1529 $domain = civicrm_api(
1534 'current_domain' => 1,
1538 if (isset($domain['from_email'])) {
1539 $domain_email = $domain['from_email'];
1540 $domain_name = $domain['from_name'];
1543 $domain_email = 'info@EXAMPLE.ORG';
1544 $domain_name = 'EXAMPLE.ORG';
1546 if (!isset($params['created_id'])) {
1547 $session =& CRM_Core_Session
::singleton();
1548 $params['created_id'] = $session->get('userID');
1551 // load the default config settings for each
1552 // eg reply_id, unsubscribe_id need to use
1553 // correct template IDs here
1554 'override_verp' => TRUE,
1555 'forward_replies' => FALSE,
1556 'open_tracking' => TRUE,
1557 'url_tracking' => TRUE,
1558 'visibility' => 'Public Pages',
1559 'replyto_email' => $domain_email,
1560 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1561 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1562 'from_email' => $domain_email,
1563 'from_name' => $domain_name,
1564 'msg_template_id' => NULL,
1565 'created_id' => $params['created_id'],
1566 'approver_id' => NULL,
1567 'auto_responder' => 0,
1568 'created_date' => date('YmdHis'),
1569 'scheduled_date' => NULL,
1570 'approval_date' => NULL,
1573 // Get the default from email address, if not provided.
1574 if (empty($defaults['from_email'])) {
1575 $defaultAddress = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE, TRUE);
1576 foreach ($defaultAddress as $id => $value) {
1577 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1578 $defaults['from_email'] = $match[2];
1579 $defaults['from_name'] = $match[1];
1584 $params = array_merge($defaults, $params);
1588 * Could check and warn for the following cases:
1590 * - groups OR mailings should be populated.
1591 * - body html OR body text should be populated.
1594 $transaction = new CRM_Core_Transaction();
1596 $mailing = self
::add($params);
1598 if (is_a($mailing, 'CRM_Core_Error')) {
1599 $transaction->rollback();
1602 // update mailings with hash values
1603 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1605 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1607 /* Create the mailing group record */
1608 $mg = new CRM_Mailing_DAO_MailingGroup();
1609 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1610 foreach (array('groups', 'mailings') as $entity) {
1611 foreach (array('include', 'exclude', 'base') as $type) {
1612 if (isset($params[$entity][$type])) {
1613 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1618 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1620 $mg->mailing_id
= $mailing->id
;
1621 $mg->entity_table
= $groupTableName;
1622 $mg->entity_id
= $params['group_id'];
1623 $mg->search_id
= $params['search_id'];
1624 $mg->search_args
= $params['search_args'];
1625 $mg->group_type
= 'Include';
1629 // check and attach and files as needed
1630 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1632 // If we're going to autosend, then check validity before saving.
1633 if (empty($params['is_completed']) && !empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1634 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1635 $errors = call_user_func($cb, $mailing);
1636 if (!empty($errors)) {
1637 $fields = implode(',', array_keys($errors));
1638 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1642 $transaction->commit();
1644 // Create parent job if not yet created.
1645 // Condition on the existence of a scheduled date.
1646 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1647 $job = new CRM_Mailing_BAO_MailingJob();
1648 $job->mailing_id
= $mailing->id
;
1649 // If we are creating a new Completed mailing (e.g. import from another system) set the job to completed.
1650 // Keeping former behaviour when an id is present is precautionary and may warrant reconsideration later.
1651 $job->status
= ((empty($params['is_completed']) ||
!empty($params['id'])) ?
'Scheduled' : 'Complete');
1654 if (!$job->find(TRUE)) {
1655 // Don't schedule job until we populate the recipients.
1656 $job->scheduled_date
= NULL;
1659 // Schedule the job now that it has recipients.
1660 $job->scheduled_date
= $params['scheduled_date'];
1664 // Populate the recipients.
1665 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1666 self
::getRecipients($mailing->id
);
1674 * This is used by CiviMail but will be made redundant by FlexMailer.
1675 * @param CRM_Mailing_DAO_Mailing $mailing
1676 * The mailing which may or may not be sendable.
1678 * List of error messages.
1680 public static function checkSendable($mailing) {
1682 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1683 if (empty($mailing->{$field})) {
1684 $errors[$field] = ts('Field "%1" is required.', array(
1689 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1690 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1693 if (!Civi
::settings()->get('disable_mandatory_tokens_check')) {
1694 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->header_id
) : NULL;
1695 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->footer_id
) : NULL;
1696 foreach (array('body_html', 'body_text') as $field) {
1697 if (empty($mailing->{$field})) {
1700 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1701 $err = CRM_Utils_Token
::requiredTokens($str);
1702 if ($err !== TRUE) {
1703 foreach ($err as $token => $desc) {
1704 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1705 array(1 => $token, 2 => $desc)
1716 * Replace the list of recipients on a given mailing.
1718 * @param int $mailingId
1719 * @param string $type
1720 * 'include' or 'exclude'.
1721 * @param string $entity
1722 * 'groups' or 'mailings'.
1723 * @param array <int> $entityIds
1724 * @throws CiviCRM_API3_Exception
1726 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1728 foreach ($entityIds as $entityId) {
1729 $values[] = array('entity_id' => $entityId);
1731 civicrm_api3('mailing_group', 'replace', array(
1732 'mailing_id' => $mailingId,
1733 'group_type' => $type,
1734 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1735 'values' => $values,
1740 * Get hash value of the mailing.
1744 * @return null|string
1746 public static function getMailingHash($id) {
1748 if (Civi
::settings()->get('hash_mailing_url')) {
1749 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1755 * Generate a report. Fetch event count information, mailing data, and job
1759 * The mailing id to report.
1760 * @param bool $skipDetails
1761 * Whether return all detailed report.
1763 * @param bool $isSMS
1766 * Associative array of reporting data
1768 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1769 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1771 $mailing = new CRM_Mailing_BAO_Mailing();
1774 'mailing' => self
::getTableName(),
1775 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1776 'group' => CRM_Contact_BAO_Group
::getTableName(),
1777 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1778 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1779 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1780 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1781 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1782 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1783 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1784 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1785 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1786 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1787 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1788 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1792 $additionalWhereClause = " AND ";
1794 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1797 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1800 /* Get the mailing info */
1803 SELECT {$t['mailing']}.*
1804 FROM {$t['mailing']}
1805 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1809 $report['mailing'] = array();
1810 foreach (array_keys(self
::fields()) as $field) {
1811 $report['mailing'][$field] = $mailing->$field;
1815 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1816 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1817 $report['mailing']['campaign'] = $campaigns[$campaignId];
1820 //mailing report is called by activity
1821 //we dont need all detail report
1826 /* Get the component info */
1830 $components = array(
1831 'header' => ts('Header'),
1832 'footer' => ts('Footer'),
1833 'reply' => ts('Reply'),
1834 'optout' => ts('Opt-Out'),
1835 'resubscribe' => ts('Resubscribe'),
1836 'unsubscribe' => ts('Unsubscribe'),
1838 foreach (array_keys($components) as $type) {
1839 $query[] = "SELECT {$t['component']}.name as name,
1841 {$t['component']}.id as id
1842 FROM {$t['component']}
1843 INNER JOIN {$t['mailing']}
1844 ON {$t['mailing']}.{$type}_id =
1845 {$t['component']}.id
1846 WHERE {$t['mailing']}.id = $mailing_id";
1848 $q = '(' . implode(') UNION (', $query) . ')';
1849 $mailing->query($q);
1851 $report['component'] = array();
1852 while ($mailing->fetch()) {
1853 $report['component'][] = array(
1854 'type' => $components[$mailing->type
],
1855 'name' => $mailing->name
,
1856 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1857 "reset=1&action=update&id={$mailing->id}"
1862 /* Get the recipient group info */
1865 SELECT {$t['mailing_group']}.group_type as group_type,
1866 {$t['group']}.id as group_id,
1867 {$t['group']}.title as group_title,
1868 {$t['group']}.is_hidden as group_hidden,
1869 {$t['mailing']}.id as mailing_id,
1870 {$t['mailing']}.name as mailing_name
1871 FROM {$t['mailing_group']}
1872 LEFT JOIN {$t['group']}
1873 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1874 AND {$t['mailing_group']}.entity_table =
1876 LEFT JOIN {$t['mailing']}
1877 ON {$t['mailing_group']}.entity_id =
1879 AND {$t['mailing_group']}.entity_table =
1882 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1885 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1886 while ($mailing->fetch()) {
1888 if (isset($mailing->group_id
)) {
1889 $row['id'] = $mailing->group_id
;
1890 $row['name'] = $mailing->group_title
;
1891 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1892 "reset=1&force=1&context=smog&gid={$row['id']}"
1896 $row['id'] = $mailing->mailing_id
;
1897 $row['name'] = $mailing->mailing_name
;
1898 $row['mailing'] = TRUE;
1899 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1904 /* Rename hidden groups */
1906 if ($mailing->group_hidden
== 1) {
1907 $row['name'] = "Search Results";
1910 if ($mailing->group_type
== 'Include') {
1911 $report['group']['include'][] = $row;
1913 elseif ($mailing->group_type
== 'Base') {
1914 $report['group']['base'][] = $row;
1917 $report['group']['exclude'][] = $row;
1921 /* Get the event totals, grouped by job (retries) */
1924 SELECT {$t['job']}.*,
1925 COUNT(DISTINCT {$t['queue']}.id) as queue,
1926 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1927 COUNT(DISTINCT {$t['reply']}.id) as reply,
1928 COUNT(DISTINCT {$t['forward']}.id) as forward,
1929 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1930 COUNT(DISTINCT {$t['urlopen']}.id) as url,
1931 COUNT(DISTINCT {$t['spool']}.id) as spool
1933 LEFT JOIN {$t['queue']}
1934 ON {$t['queue']}.job_id = {$t['job']}.id
1935 LEFT JOIN {$t['reply']}
1936 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
1937 LEFT JOIN {$t['forward']}
1938 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
1939 LEFT JOIN {$t['bounce']}
1940 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
1941 LEFT JOIN {$t['delivered']}
1942 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
1943 AND {$t['bounce']}.id IS null
1944 LEFT JOIN {$t['urlopen']}
1945 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1946 LEFT JOIN {$t['spool']}
1947 ON {$t['spool']}.job_id = {$t['job']}.id
1948 WHERE {$t['job']}.mailing_id = $mailing_id
1949 AND {$t['job']}.is_test = 0
1950 GROUP BY {$t['job']}.id");
1952 $report['jobs'] = array();
1953 $report['event_totals'] = array();
1968 // initialize various counters
1969 foreach ($elements as $field) {
1970 $report['event_totals'][$field] = 0;
1973 while ($mailing->fetch()) {
1975 foreach ($elements as $field) {
1976 if (isset($mailing->$field)) {
1977 $row[$field] = $mailing->$field;
1978 $report['event_totals'][$field] +
= $mailing->$field;
1982 // compute open total separately to discount duplicates
1984 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
1985 $report['event_totals']['opened'] +
= $row['opened'];
1986 $row['total_opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
);
1987 $report['event_totals']['total_opened'] +
= $row['total_opened'];
1989 // compute unsub total separately to discount duplicates
1991 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
1992 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
1994 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
1995 $report['event_totals']['optout'] +
= $row['optout'];
1997 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
1998 $row[$field] = $mailing->$field;
2001 if ($mailing->queue
) {
2002 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2003 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2004 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2005 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2006 $row['opened_rate'] = $mailing->delivered ?
(($row['opened'] / $mailing->delivered
) * 100.0) : 0;
2007 $row['clickthrough_rate'] = $mailing->delivered ?
(($mailing->url
/ $mailing->delivered
) * 100.0) : 0;
2010 $row['delivered_rate'] = 0;
2011 $row['bounce_rate'] = 0;
2012 $row['unsubscribe_rate'] = 0;
2013 $row['optout_rate'] = 0;
2014 $row['opened_rate'] = 0;
2015 $row['clickthrough_rate'] = 0;
2018 $row['links'] = array(
2019 'clicks' => CRM_Utils_System
::url(
2020 'civicrm/mailing/report/event',
2021 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2023 'queue' => CRM_Utils_System
::url(
2024 'civicrm/mailing/report/event',
2025 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2027 'delivered' => CRM_Utils_System
::url(
2028 'civicrm/mailing/report/event',
2029 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2031 'bounce' => CRM_Utils_System
::url(
2032 'civicrm/mailing/report/event',
2033 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2035 'unsubscribe' => CRM_Utils_System
::url(
2036 'civicrm/mailing/report/event',
2037 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2039 'forward' => CRM_Utils_System
::url(
2040 'civicrm/mailing/report/event',
2041 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2043 'reply' => CRM_Utils_System
::url(
2044 'civicrm/mailing/report/event',
2045 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2047 'opened' => CRM_Utils_System
::url(
2048 'civicrm/mailing/report/event',
2049 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2058 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2060 $report['jobs'][] = $row;
2063 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2065 // we need to do this for backward compatibility, since old mailings did not
2066 // use the mailing_recipients table
2067 if ($newTableSize > 0) {
2068 $report['event_totals']['queue'] = $newTableSize;
2071 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id);
2074 if (!empty($report['event_totals']['queue'])) {
2075 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2076 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2077 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2078 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2079 $report['event_totals']['opened_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['opened'] / $report['event_totals']['delivered']) * 100.0) : 0;
2080 $report['event_totals']['clickthrough_rate'] = !empty($report['event_totals']['delivered']) ?
(($report['event_totals']['url'] / $report['event_totals']['delivered']) * 100.0) : 0;
2083 $report['event_totals']['delivered_rate'] = 0;
2084 $report['event_totals']['bounce_rate'] = 0;
2085 $report['event_totals']['unsubscribe_rate'] = 0;
2086 $report['event_totals']['optout_rate'] = 0;
2087 $report['event_totals']['opened_rate'] = 0;
2088 $report['event_totals']['clickthrough_rate'] = 0;
2091 /* Get the click-through totals, grouped by URL */
2094 SELECT {$t['url']}.url,
2096 COUNT({$t['urlopen']}.id) as clicks,
2097 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2099 LEFT JOIN {$t['urlopen']}
2100 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2101 LEFT JOIN {$t['queue']}
2102 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2103 LEFT JOIN {$t['job']}
2104 ON {$t['queue']}.job_id = {$t['job']}.id
2105 WHERE {$t['url']}.mailing_id = $mailing_id
2106 AND {$t['job']}.is_test = 0
2107 GROUP BY {$t['url']}.id
2108 ORDER BY unique_clicks DESC");
2110 $report['click_through'] = array();
2112 while ($mailing->fetch()) {
2113 $report['click_through'][] = array(
2114 'url' => $mailing->url
,
2115 'link' => CRM_Utils_System
::url(
2116 'civicrm/mailing/report/event',
2117 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2119 'link_unique' => CRM_Utils_System
::url(
2120 'civicrm/mailing/report/event',
2121 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2123 'clicks' => $mailing->clicks
,
2124 'unique' => $mailing->unique_clicks
,
2125 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2126 'report' => CRM_Report_Utils_Report
::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2130 $report['event_totals']['links'] = array(
2131 'clicks' => CRM_Utils_System
::url(
2132 'civicrm/mailing/report/event',
2133 "reset=1&event=click&mid=$mailing_id"
2135 'clicks_unique' => CRM_Utils_System
::url(
2136 'civicrm/mailing/report/event',
2137 "reset=1&event=click&mid=$mailing_id&distinct=1"
2139 'queue' => CRM_Utils_System
::url(
2140 'civicrm/mailing/report/event',
2141 "reset=1&event=queue&mid=$mailing_id"
2143 'delivered' => CRM_Utils_System
::url(
2144 'civicrm/mailing/report/event',
2145 "reset=1&event=delivered&mid=$mailing_id"
2147 'bounce' => CRM_Utils_System
::url(
2148 'civicrm/mailing/report/event',
2149 "reset=1&event=bounce&mid=$mailing_id"
2151 'unsubscribe' => CRM_Utils_System
::url(
2152 'civicrm/mailing/report/event',
2153 "reset=1&event=unsubscribe&mid=$mailing_id"
2155 'optout' => CRM_Utils_System
::url(
2156 'civicrm/mailing/report/event',
2157 "reset=1&event=optout&mid=$mailing_id"
2159 'forward' => CRM_Utils_System
::url(
2160 'civicrm/mailing/report/event',
2161 "reset=1&event=forward&mid=$mailing_id"
2163 'reply' => CRM_Utils_System
::url(
2164 'civicrm/mailing/report/event',
2165 "reset=1&event=reply&mid=$mailing_id"
2167 'opened' => CRM_Utils_System
::url(
2168 'civicrm/mailing/report/event',
2169 "reset=1&event=opened&mid=$mailing_id"
2173 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2174 if (CRM_Core_Permission
::check('view all contacts')) {
2175 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2176 'name' => ts('Advanced Search'),
2177 'url' => 'civicrm/contact/search/advanced',
2180 $action = array_sum(array_keys($actionLinks));
2182 $report['event_totals']['actionlinks'] = array();
2195 $url = 'mailing/detail';
2196 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2197 $searchFilter = "force=1&mailing_id=%%mid%%";
2200 $reportFilter .= "&delivery_status_value=successful";
2201 $searchFilter .= "&mailing_delivery_status=Y";
2205 $url = "mailing/bounce";
2206 $searchFilter .= "&mailing_delivery_status=N";
2210 $reportFilter .= "&is_forwarded_value=1";
2211 $searchFilter .= "&mailing_forward=1";
2215 $reportFilter .= "&is_replied_value=1";
2216 $searchFilter .= "&mailing_reply_status=Y";
2220 $reportFilter .= "&is_unsubscribed_value=1";
2221 $searchFilter .= "&mailing_unsubscribe=1";
2225 $reportFilter .= "&is_optout_value=1";
2226 $searchFilter .= "&mailing_optout=1";
2230 $url = "mailing/opened";
2231 $searchFilter .= "&mailing_open_status=Y";
2235 case 'clicks_unique':
2236 $url = "mailing/clicks";
2237 $searchFilter .= "&mailing_click_status=Y";
2240 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2241 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2242 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2244 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2247 array('mid' => $mailing_id),
2250 'mailing.report.action',
2260 * Get the count of mailings.
2267 public function getCount() {
2269 $this->selectAdd('COUNT(id) as count');
2271 $session = CRM_Core_Session
::singleton();
2274 return $this->count
;
2282 public static function checkPermission($id) {
2287 $mailingIDs = self
::mailingACLIDs();
2288 if ($mailingIDs === TRUE) {
2292 if (!in_array($id, $mailingIDs)) {
2293 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2298 * @param null $alias
2302 public static function mailingACL($alias = NULL) {
2303 $mailingACL = " ( 0 ) ";
2305 $mailingIDs = self
::mailingACLIDs();
2306 if ($mailingIDs === TRUE) {
2310 if (!empty($mailingIDs)) {
2311 $mailingIDs = implode(',', $mailingIDs);
2312 $tableName = !$alias ? self
::getTableName() : $alias;
2313 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2319 * Returns all the mailings that this user can access. This is dependent on
2320 * all the groups that the user has access to.
2321 * However since most civi installs dont use ACL's we special case the condition
2322 * where the user has access to ALL groups, and hence ALL mailings and return a
2323 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2325 * @return bool|array
2326 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2328 public static function mailingACLIDs() {
2330 // optimize common case where admin has access
2333 CRM_Core_Permission
::check('view all contacts') ||
2334 CRM_Core_Permission
::check('edit all contacts')
2339 $mailingIDs = array();
2341 // get all the groups that this user can access
2342 // if they dont have universal access
2343 $groupNames = civicrm_api3('Group', 'get', array(
2344 'check_permissions' => TRUE,
2345 'return' => array('title', 'id'),
2346 'options' => array('limit' => 0),
2348 foreach ($groupNames['values'] as $group) {
2349 $groups[$group['id']] = $group['title'];
2351 if (!empty($groups)) {
2352 $groupIDs = implode(',', array_keys($groups));
2353 $domain_id = CRM_Core_Config
::domainID();
2355 // get all the mailings that are in this subset of groups
2357 SELECT DISTINCT( m.id ) as id
2358 FROM civicrm_mailing m
2359 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2360 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2361 OR ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2363 $dao = CRM_Core_DAO
::executeQuery($query);
2365 $mailingIDs = array();
2366 while ($dao->fetch()) {
2367 $mailingIDs[] = $dao->id
;
2369 //CRM-18181 Get all mailings that use the mailings found earlier as receipients
2370 if (!empty($mailingIDs)) {
2371 $mailings = implode(',', $mailingIDs);
2373 SELECT DISTINCT ( m.id ) as id
2374 FROM civicrm_mailing m
2375 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2376 WHERE g.entity_table like 'civicrm_mailing%' AND g.entity_id IN ($mailings)";
2377 $mailingDao = CRM_Core_DAO
::executeQuery($mailingQuery);
2378 while ($mailingDao->fetch()) {
2379 $mailingIDs[] = $mailingDao->id
;
2388 * Get the rows for a browse operation.
2390 * @param int $offset
2391 * The row number to start from.
2392 * @param int $rowCount
2393 * The nmber of rows to return.
2394 * @param string $sort
2395 * The sql string that describes the sort order.
2397 * @param null $additionalClause
2398 * @param array $additionalParams
2403 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2404 $mailing = self
::getTableName();
2405 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2406 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2407 $session = CRM_Core_Session
::singleton();
2409 $mailingACL = self
::mailingACL();
2411 //get all campaigns.
2412 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2414 "$mailing.id", "$mailing.name", "$job.status",
2415 "$mailing.approval_status_id", "createdContact.sort_name as created_by", "scheduledContact.sort_name as scheduled_by",
2416 "$mailing.created_id as created_id", "$mailing.scheduled_id as scheduled_id", "$mailing.is_archived as archived",
2417 "$mailing.created_date as created_date", "campaign_id", "$mailing.sms_provider_id as sms_provider_id",
2418 "$mailing.language",
2421 // we only care about parent jobs, since that holds all the info on
2423 $selectClause = implode(', ', $select);
2424 $groupFromSelect = CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($select, "$mailing.id");
2426 SELECT {$selectClause},
2427 MIN($job.scheduled_date) as scheduled_date,
2428 MIN($job.start_date) as start_date,
2429 MAX($job.end_date) as end_date
2431 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2432 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2433 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2434 WHERE $mailingACL $additionalClause";
2436 if (!empty($groupFromSelect)) {
2437 $query .= $groupFromSelect;
2441 $orderBy = trim($sort->orderBy());
2442 if (!empty($orderBy)) {
2443 $query .= " ORDER BY $orderBy";
2448 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2449 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2451 $query .= " LIMIT $offset, $rowCount ";
2454 if (!$additionalParams) {
2455 $additionalParams = array();
2458 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2461 while ($dao->fetch()) {
2464 'name' => $dao->name
,
2465 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2466 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2467 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2468 'scheduled_iso' => $dao->scheduled_date
,
2469 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2470 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2471 'created_by' => $dao->created_by
,
2472 'scheduled_by' => $dao->scheduled_by
,
2473 'created_id' => $dao->created_id
,
2474 'scheduled_id' => $dao->scheduled_id
,
2475 'archived' => $dao->archived
,
2476 'approval_status_id' => $dao->approval_status_id
,
2477 'campaign_id' => $dao->campaign_id
,
2478 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2479 'sms_provider_id' => $dao->sms_provider_id
,
2480 'language' => $dao->language
,
2487 * Show detail Mailing report.
2493 public static function showEmailDetails($id) {
2494 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2498 * Delete Mails and all its associated records.
2501 * Id of the mail to delete.
2505 public static function del($id) {
2507 CRM_Core_Error
::fatal();
2510 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2512 // delete all file attachments
2513 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2517 $dao = new CRM_Mailing_DAO_Mailing();
2521 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2523 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2528 * Use CRM_Mailing_BAO_MailingJob::del($id)
2531 * Id of the Job to delete.
2535 public static function delJob($id) {
2537 CRM_Core_Error
::fatal();
2540 \Civi
::log('This function is deprecated, use CRM_Mailing_BAO_MailingJob::del instead', ['civi.tag' => 'deprecated']);
2542 CRM_Mailing_BAO_MailingJob
::del($id);
2547 * This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
2550 public function getReturnProperties() {
2551 $tokens = &$this->getTokens();
2553 $properties = array();
2554 if (isset($tokens['html']) &&
2555 isset($tokens['html']['contact'])
2557 $properties = array_merge($properties, $tokens['html']['contact']);
2560 if (isset($tokens['text']) &&
2561 isset($tokens['text']['contact'])
2563 $properties = array_merge($properties, $tokens['text']['contact']);
2566 if (isset($tokens['subject']) &&
2567 isset($tokens['subject']['contact'])
2569 $properties = array_merge($properties, $tokens['subject']['contact']);
2572 $returnProperties = array();
2573 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2575 foreach ($properties as $p) {
2576 $returnProperties[$p] = 1;
2579 return $returnProperties;
2583 * Build the compose mail form.
2585 * @param CRM_Core_Form $form
2589 public static function commonCompose(&$form) {
2593 if (method_exists($form, 'listTokens')) {
2594 $tokens = array_merge($form->listTokens(), $tokens);
2597 //sorted in ascending order tokens by ignoring word case
2598 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2600 $templates = array();
2602 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2603 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2605 $className = CRM_Utils_System
::getClassName($form);
2607 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2608 $className != 'CRM_Contact_Form_Task_SMS'
2610 $form->add('wysiwyg', 'html_message',
2611 strstr($className, 'PDF') ?
ts('Document Body') : ts('HTML Format'),
2615 'onkeyup' => "return verify(this)",
2619 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2620 unset($modePrefixes['SMS']);
2624 unset($textFields['text_message']);
2625 unset($modePrefixes['Mail']);
2628 //insert message Text by selecting "Select Template option"
2629 foreach ($textFields as $id => $label) {
2631 if ($id == 'sms_text_message') {
2633 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2635 $form->add('textarea', $id, $label,
2639 'onkeyup' => "return verify(this, '{$prefix}')",
2644 foreach ($modePrefixes as $prefix) {
2645 if ($prefix == 'SMS') {
2646 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2649 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2651 if (!empty($templates[$prefix])) {
2652 $form->assign('templates', TRUE);
2654 $form->add('select', "{$prefix}template", ts('Use Template'),
2655 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2656 array('onChange' => "selectValue( this.value, '{$prefix}');")
2659 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2661 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2662 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2664 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2667 // I'm not sure this is ever called.
2668 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2669 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2670 $action == CRM_Core_Action
::VIEW
2672 $form->freeze('html_message');
2677 * Get the search based mailing Ids.
2680 * , searched base mailing ids.
2682 public function searchMailingIDs() {
2683 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2684 $mailing = self
::getTableName();
2687 SELECT $mailing.id as mailing_id
2688 FROM $mailing, $group
2689 WHERE $group.mailing_id = $mailing.id
2690 AND $group.group_type = 'Base'";
2692 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2693 $mailingIDs = array();
2694 while ($searchDAO->fetch()) {
2695 $mailingIDs[] = $searchDAO->mailing_id
;
2702 * Get the content/components of mailing based on mailing Id
2704 * @param array $report
2705 * of mailing report.
2708 * Reference of this.
2710 * @param bool $isSMS
2713 * array content/component.
2715 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2716 $htmlHeader = $textHeader = NULL;
2717 $htmlFooter = $textFooter = NULL;
2720 if ($report['mailing']['header_id']) {
2721 $header = new CRM_Mailing_BAO_Component();
2722 $header->id
= $report['mailing']['header_id'];
2723 $header->find(TRUE);
2724 $htmlHeader = $header->body_html
;
2725 $textHeader = $header->body_text
;
2728 if ($report['mailing']['footer_id']) {
2729 $footer = new CRM_Mailing_BAO_Component();
2730 $footer->id
= $report['mailing']['footer_id'];
2731 $footer->find(TRUE);
2732 $htmlFooter = $footer->body_html
;
2733 $textFooter = $footer->body_text
;
2737 $mailingKey = $form->_mailing_id
;
2739 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2740 $mailingKey = $hash;
2744 if (!empty($report['mailing']['body_text'])) {
2745 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2746 $form->assign('textViewURL', $url);
2750 if (!empty($report['mailing']['body_html'])) {
2751 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2752 $form->assign('htmlViewURL', $url);
2757 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2767 public static function overrideVerp($jobID) {
2768 static $_cache = array();
2770 if (!isset($_cache[$jobID])) {
2772 SELECT override_verp
2773 FROM civicrm_mailing
2774 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2775 WHERE civicrm_mailing_job.id = %1
2777 $params = array(1 => array($jobID, 'Integer'));
2778 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2780 return $_cache[$jobID];
2789 public static function processQueue($mode = NULL) {
2790 $config = CRM_Core_Config
::singleton();
2792 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2793 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(
2794 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2795 2 => "https://docs.civicrm.org/sysadmin/en/latest/setup/civimail/",
2799 // check if we are enforcing number of parallel cron jobs
2801 $gotCronLock = FALSE;
2803 $mailerJobsMax = Civi
::settings()->get('mailerJobsMax');
2804 if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2805 $lockArray = range(1, $mailerJobsMax);
2807 // Shuffle the array to improve chances of quickly finding an open thread
2808 shuffle($lockArray);
2810 // Check if we are using global locks
2811 foreach ($lockArray as $lockID) {
2812 $cronLock = Civi
::lockManager()->acquire("worker.mailing.send.{$lockID}");
2813 if ($cronLock->isAcquired()) {
2814 $gotCronLock = TRUE;
2819 // Exit here since we have enough mailing processes running
2820 if (!$gotCronLock) {
2821 CRM_Core_Error
::debug_log_message('Returning early, since the maximum number of mailing processes are running');
2825 if (getenv('CIVICRM_CRON_HOLD')) {
2826 // In testing, we may need to simulate some slow activities.
2827 sleep(getenv('CIVICRM_CRON_HOLD'));
2831 // Split up the parent jobs into multiple child jobs
2832 $mailerJobSize = Civi
::settings()->get('mailerJobSize');
2833 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2834 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2835 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2837 // Release the global lock if we do have one
2839 $cronLock->release();
2846 * @param int $mailingID
2848 private static function addMultipleEmails($mailingID) {
2850 INSERT INTO civicrm_mailing_recipients
2851 (mailing_id, email_id, contact_id)
2852 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2854 AND e.is_bulkmail = 1
2856 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2857 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2859 $params = array(1 => array($mailingID, 'Integer'));
2861 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2865 * @param bool $isSMS
2869 public static function getMailingsList($isSMS = FALSE) {
2870 static $list = array();
2873 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2876 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2881 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2882 FROM civicrm_mailing
2883 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2884 ORDER BY civicrm_mailing.name";
2885 $mailing = CRM_Core_DAO
::executeQuery($query);
2887 while ($mailing->fetch()) {
2888 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2896 * wrapper for ajax activity selector.
2898 * @param array $params
2899 * Associated array for params record id.
2902 * associated array of contact activities
2904 public static function getContactMailingSelector(&$params) {
2905 // format the params
2906 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2907 $params['rowCount'] = $params['rp'];
2908 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2909 $params['caseId'] = NULL;
2911 // get contact mailings
2912 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2915 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2918 if (!empty($mailings)) {
2919 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2920 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2923 // format params and add links
2924 $contactMailings = array();
2925 foreach ($mailings as $mailingId => $values) {
2927 $mailing['subject'] = $values['subject'];
2928 $mailing['creator_name'] = CRM_Utils_System
::href(
2929 $values['creator_name'],
2930 'civicrm/contact/view',
2931 "reset=1&cid={$values['creator_id']}");
2932 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2933 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2934 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2936 $mailing['openstats'] = "Opens: " .
2937 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
2939 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
2941 $actionLinks = array(
2942 CRM_Core_Action
::VIEW
=> array(
2943 'name' => ts('View'),
2944 'url' => 'civicrm/mailing/view',
2945 'qs' => "reset=1&id=%%mkey%%",
2946 'title' => ts('View Mailing'),
2947 'class' => 'crm-popup',
2949 CRM_Core_Action
::BROWSE
=> array(
2950 'name' => ts('Mailing Report'),
2951 'url' => 'civicrm/mailing/report',
2952 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
2953 'title' => ts('View Mailing Report'),
2957 $mailingKey = $values['mailing_id'];
2958 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2959 $mailingKey = $hash;
2962 $mailing['links'] = CRM_Core_Action
::formLink(
2966 'mid' => $values['mailing_id'],
2967 'cid' => $params['contact_id'],
2968 'mkey' => $mailingKey,
2972 'mailing.contact.action',
2974 $values['mailing_id']
2977 array_push($contactMailings, $mailing);
2980 $contactMailingsDT = array();
2981 $contactMailingsDT['data'] = $contactMailings;
2982 $contactMailingsDT['recordsTotal'] = $params['total'];
2983 $contactMailingsDT['recordsFiltered'] = $params['total'];
2985 return $contactMailingsDT;
2989 * Retrieve contact mailing.
2991 * @param array $params
2994 * Array of mailings for a contact
2997 static public function getContactMailings(&$params) {
2998 $params['version'] = 3;
2999 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3000 $params['limit'] = $params['rp'];
3001 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3003 $result = civicrm_api('MailingContact', 'get', $params);
3004 return $result['values'];
3008 * Retrieve contact mailing count.
3010 * @param array $params
3013 * count of mailings for a contact
3016 static public function getContactMailingsCount(&$params) {
3017 $params['version'] = 3;
3018 return civicrm_api('MailingContact', 'getcount', $params);
3022 * Get a list of permissions required for CRUD'ing each field
3023 * (when workflow is enabled).
3026 * Array (string $fieldName => string $permName)
3028 public static function getWorkflowFieldPerms() {
3029 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3030 $fieldPerms = array();
3031 foreach ($fieldNames as $fieldName) {
3032 if ($fieldName == 'id') {
3033 $fieldPerms[$fieldName] = array(
3034 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3037 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3038 $fieldPerms[$fieldName] = array(
3039 array('access CiviMail', 'schedule mailings'), // OR
3042 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3043 $fieldPerms[$fieldName] = array(
3044 array('access CiviMail', 'approve mailings'), // OR
3048 $fieldPerms[$fieldName] = array(
3049 array('access CiviMail', 'create mailings'), // OR
3057 * White-list of possible values for the entity_table field.
3061 public static function mailingGroupEntityTables() {
3063 CRM_Contact_BAO_Group
::getTableName() => 'Group',
3064 CRM_Mailing_BAO_Mailing
::getTableName() => 'Mailing',
3069 * Get the public view url.
3072 * @param bool $absolute
3076 public static function getPublicViewUrl($id, $absolute = TRUE) {
3077 if ((civicrm_api3('Mailing', 'getvalue', array('id' => $id, 'return' => 'visibility'))) === 'Public Pages') {
3078 return CRM_Utils_System
::url('civicrm/mailing/view', array('id' => $id), $absolute, NULL, TRUE, TRUE);
3083 * Get a list of template types which can be used as `civicrm_mailing.template_type`.
3086 * A list of template-types, keyed numerically. Each defines:
3087 * - name: string, a short symbolic name
3088 * - editorUrl: string, Angular template name
3090 * Ex: $templateTypes[0] === array('name' => 'mosaico', 'editorUrl' => '~/crmMosaico/editor.html').
3092 public static function getTemplateTypes() {
3093 if (!isset(Civi
::$statics[__CLASS__
]['templateTypes'])) {
3096 'name' => 'traditional',
3097 'editorUrl' => CRM_Mailing_Info
::workflowEnabled() ?
'~/crmMailing/EditMailingCtrl/workflow.html' : '~/crmMailing/EditMailingCtrl/2step.html',
3101 CRM_Utils_Hook
::mailingTemplateTypes($types);
3103 $defaults = array('weight' => 0);
3104 foreach (array_keys($types) as $typeName) {
3105 $types[$typeName] = array_merge($defaults, $types[$typeName]);
3107 usort($types, function ($a, $b) {
3108 if ($a['weight'] === $b['weight']) {
3111 return $a['weight'] < $b['weight'] ?
-1 : 1;
3114 Civi
::$statics[__CLASS__
]['templateTypes'] = $types;
3117 return Civi
::$statics[__CLASS__
]['templateTypes'];
3121 * Get a list of template types.
3124 * Array(string $name => string $label).
3126 public static function getTemplateTypeNames() {
3128 foreach (self
::getTemplateTypes() as $type) {
3129 $r[$type['name']] = $type['name'];