api/v3/Mailing.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * APIv3 functions for registering/processing mailing events.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Handle a create event.
  37  *
  38  * @param array $params
  39  *
  40  * @return array
  41  *    API Success Array
  42  * @throws \API_Exception
  43  * @throws \Civi\API\Exception\UnauthorizedException
  44  */
  45 function civicrm_api3_mailing_create($params) {
  46   if (CRM_Mailing_Info::workflowEnabled()) {
  47     // Note: 'schedule mailings' and 'approve mailings' can update certain fields, but can't create.
  48
  49     if (empty($params['id'])) {
  50       if (!CRM_Core_Permission::check('access CiviMail') && !CRM_Core_Permission::check('create mailings')) {
  51         throw new \Civi\API\Exception\UnauthorizedException("Cannot create new mailing. Required permission: 'access CiviMail' or 'create mailings'");
  52       }
  53     }
  54
  55     $safeParams = array();
  56     $fieldPerms = CRM_Mailing_BAO_Mailing::getWorkflowFieldPerms();
  57     foreach (array_keys($params) as $field) {
  58       if (CRM_Core_Permission::check($fieldPerms[$field])) {
  59         $safeParams[$field] = $params[$field];
  60       }
  61     }
  62   }
  63   else {
  64     $safeParams = $params;
  65   }
  66   $safeParams['_evil_bao_validator_'] = 'CRM_Mailing_BAO_Mailing::checkSendable';
  67   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $safeParams);
  68
  69 }
  70
  71 /**
  72  * Get tokens for one or more entity type
  73  *
  74  * Output will be formatted either as a flat list,
  75  * or pass sequential=1 to retrieve as a hierarchy formatted for select2.
  76  *
  77  * @param array $params
  78  *   Should contain an array of entities to retrieve tokens for.
  79  *
  80  * @return array
  81  * @throws \API_Exception
  82  */
  83 function civicrm_api3_mailing_gettokens($params) {
  84   $tokens = array();
  85   foreach ((array) $params['entity'] as $ent) {
  86     $func = lcfirst($ent) . 'Tokens';
  87     if (!method_exists('CRM_Core_SelectValues', $func)) {
  88       throw new API_Exception('Unknown token entity: ' . $ent);
  89     }
  90     $tokens = array_merge(CRM_Core_SelectValues::$func(), $tokens);
  91   }
  92   if (!empty($params['sequential'])) {
  93     $tokens = CRM_Utils_Token::formatTokensForDisplay($tokens);
  94   }
  95   return civicrm_api3_create_success($tokens, $params, 'Mailing', 'gettokens');
  96 }
  97
  98 /**
  99  * Adjust Metadata for Create action.
 100  *
 101  * The metadata is used for setting defaults, documentation & validation.
 102  *
 103  * @param array $params
 104  *   Array of parameters determined by getfields.
 105  */
 106 function _civicrm_api3_mailing_gettokens_spec(&$params) {
 107   $params['entity'] = array(
 108     'api.default' => array('contact'),
 109     'api.required' => 1,
 110     'api.multiple' => 1,
 111     'title' => 'Entity',
 112     'options' => array(),
 113   );
 114   // Fetch a list of token functions and format to look like entity names
 115   foreach (get_class_methods('CRM_Core_SelectValues') as $func) {
 116     if (strpos($func, 'Tokens')) {
 117       $ent = ucfirst(str_replace('Tokens', '', $func));
 118       $params['entity']['options'][$ent] = $ent;
 119     }
 120   }
 121 }
 122
 123 /**
 124  * Adjust Metadata for Create action.
 125  *
 126  * The metadata is used for setting defaults, documentation & validation.
 127  *
 128  * @param array $params
 129  *   Array of parameters determined by getfields.
 130  */
 131 function _civicrm_api3_mailing_create_spec(&$params) {
 132   $params['created_id']['api.required'] = 1;
 133   $params['created_id']['api.default'] = 'user_contact_id';
 134
 135   $params['override_verp']['api.default'] = !CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'track_civimail_replies');
 136   $params['visibility']['api.default'] = 'Public Pages';
 137   $params['dedupe_email']['api.default'] = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'dedupe_email_default');
 138
 139   $params['forward_replies']['api.default'] = FALSE;
 140   $params['auto_responder']['api.default'] = FALSE;
 141   $params['open_tracking']['api.default'] = TRUE;
 142   $params['url_tracking']['api.default'] = TRUE;
 143
 144   $params['header_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Header', '');
 145   $params['footer_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Footer', '');
 146   $params['optout_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('OptOut', '');
 147   $params['reply_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Reply', '');
 148   $params['resubscribe_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Resubscribe', '');
 149   $params['unsubscribe_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Unsubscribe', '');
 150   $params['mailing_type']['api.default'] = 'standalone';
 151   $defaultAddress = CRM_Core_OptionGroup::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
 152   foreach ($defaultAddress as $id => $value) {
 153     if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
 154       $params['from_email']['api.default'] = $match[2];
 155       $params['from_name']['api.default'] = $match[1];
 156     }
 157   }
 158 }
 159
 160 /**
 161  * Adjust metadata for clone spec action.
 162  *
 163  * @param array $spec
 164  */
 165 function _civicrm_api3_mailing_clone_spec(&$spec) {
 166   $mailingFields = CRM_Mailing_DAO_Mailing::fields();
 167   $spec['id'] = $mailingFields['id'];
 168   $spec['id']['api.required'] = 1;
 169 }
 170
 171 /**
 172  * Clone mailing.
 173  *
 174  * @param array $params
 175  *
 176  * @return array
 177  * @throws \CiviCRM_API3_Exception
 178  */
 179 function civicrm_api3_mailing_clone($params) {
 180   $BLACKLIST = array(
 181     'id',
 182     'is_completed',
 183     'created_id',
 184     'created_date',
 185     'scheduled_id',
 186     'scheduled_date',
 187     'approver_id',
 188     'approval_date',
 189     'approval_status_id',
 190     'approval_note',
 191     'is_archived',
 192     'hash',
 193   );
 194
 195   $get = civicrm_api3('Mailing', 'getsingle', array('id' => $params['id']));
 196
 197   $newParams = array();
 198   $newParams['debug'] = CRM_Utils_Array::value('debug', $params);
 199   $newParams['groups']['include'] = array();
 200   $newParams['groups']['exclude'] = array();
 201   $newParams['mailings']['include'] = array();
 202   $newParams['mailings']['exclude'] = array();
 203   foreach ($get as $field => $value) {
 204     if (!in_array($field, $BLACKLIST)) {
 205       $newParams[$field] = $value;
 206     }
 207   }
 208
 209   $dao = new CRM_Mailing_DAO_MailingGroup();
 210   $dao->mailing_id = $params['id'];
 211   $dao->find();
 212   while ($dao->fetch()) {
 213     // CRM-11431; account for multi-lingual
 214     $entity = (substr($dao->entity_table, 0, 15) == 'civicrm_mailing') ? 'mailings' : 'groups';
 215     $newParams[$entity][strtolower($dao->group_type)][] = $dao->entity_id;
 216   }
 217
 218   return civicrm_api3('Mailing', 'create', $newParams);
 219 }
 220
 221 /**
 222  * Handle a delete event.
 223  *
 224  * @param array $params
 225  *
 226  * @return array
 227  *   API Success Array
 228  */
 229 function civicrm_api3_mailing_delete($params) {
 230   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 231 }
 232
 233 /**
 234  * Handle a get event.
 235  *
 236  * @param array $params
 237  *
 238  * @return array
 239  */
 240 function civicrm_api3_mailing_get($params) {
 241   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 242 }
 243
 244 /**
 245  * Adjust metadata for mailing submit api function.
 246  *
 247  * @param array $spec
 248  */
 249 function _civicrm_api3_mailing_submit_spec(&$spec) {
 250   $mailingFields = CRM_Mailing_DAO_Mailing::fields();
 251   $spec['id'] = $mailingFields['id'];
 252   $spec['scheduled_date'] = $mailingFields['scheduled_date'];
 253   $spec['approval_date'] = $mailingFields['approval_date'];
 254   $spec['approval_status_id'] = $mailingFields['approval_status_id'];
 255   $spec['approval_note'] = $mailingFields['approval_note'];
 256   // _skip_evil_bao_auto_recipients_: bool
 257 }
 258
 259 /**
 260  * Mailing submit.
 261  *
 262  * @param array $params
 263  *
 264  * @return array
 265  * @throws API_Exception
 266  */
 267 function civicrm_api3_mailing_submit($params) {
 268   civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_Mailing', array('id'));
 269
 270   if (!isset($params['scheduled_date']) && !isset($updateParams['approval_date'])) {
 271     throw new API_Exception("Missing parameter scheduled_date and/or approval_date");
 272   }
 273   if (!is_numeric(CRM_Core_Session::getLoggedInContactID())) {
 274     throw new API_Exception("Failed to determine current user");
 275   }
 276
 277   $updateParams = array();
 278   $updateParams['id'] = $params['id'];
 279
 280   // Note: we'll pass along scheduling/approval fields, but they may get ignored
 281   // if we don't have permission.
 282   if (isset($params['scheduled_date'])) {
 283     $updateParams['scheduled_date'] = $params['scheduled_date'];
 284     $updateParams['scheduled_id'] = CRM_Core_Session::getLoggedInContactID();
 285   }
 286   if (isset($params['approval_date'])) {
 287     $updateParams['approval_date'] = $params['approval_date'];
 288     $updateParams['approver_id'] = CRM_Core_Session::getLoggedInContactID();
 289     $updateParams['approval_status_id'] = CRM_Utils_Array::value('approval_status_id', $updateParams, CRM_Core_OptionGroup::getDefaultValue('mail_approval_status'));
 290   }
 291   if (isset($params['approval_note'])) {
 292     $updateParams['approval_note'] = $params['approval_note'];
 293   }
 294   if (isset($params['_skip_evil_bao_auto_recipients_'])) {
 295     $updateParams['_skip_evil_bao_auto_recipients_'] = $params['_skip_evil_bao_auto_recipients_'];
 296   }
 297
 298   $updateParams['options']['reload'] = 1;
 299   return civicrm_api3('Mailing', 'create', $updateParams);
 300 }
 301
 302 /**
 303  * Process a bounce event by passing through to the BAOs.
 304  *
 305  * @param array $params
 306  *
 307  * @throws API_Exception
 308  * @return array
 309  */
 310 function civicrm_api3_mailing_event_bounce($params) {
 311   $body = $params['body'];
 312   unset($params['body']);
 313
 314   $params += CRM_Mailing_BAO_BouncePattern::match($body);
 315
 316   if (CRM_Mailing_Event_BAO_Bounce::create($params)) {
 317     return civicrm_api3_create_success($params);
 318   }
 319   else {
 320     throw new API_Exception(ts('Queue event could not be found'), 'no_queue_event');
 321   }
 322 }
 323
 324 /**
 325  * Adjust Metadata for bounce_spec action.
 326  *
 327  * The metadata is used for setting defaults, documentation & validation.
 328  *
 329  * @param array $params
 330  *   Array of parameters determined by getfields.
 331  */
 332 function _civicrm_api3_mailing_event_bounce_spec(&$params) {
 333   $params['job_id']['api.required'] = 1;
 334   $params['job_id']['title'] = 'Job ID';
 335   $params['event_queue_id']['api.required'] = 1;
 336   $params['event_queue_id']['title'] = 'Event Queue ID';
 337   $params['hash']['api.required'] = 1;
 338   $params['hash']['title'] = 'Hash';
 339   $params['body']['api.required'] = 1;
 340   $params['body']['title'] = 'Body';
 341 }
 342
 343 /**
 344  * Handle a confirm event.
 345  *
 346  * @deprecated
 347  *
 348  * @param array $params
 349  *
 350  * @return array
 351  */
 352 function civicrm_api3_mailing_event_confirm($params) {
 353   return civicrm_api('MailingEventConfirm', 'create', $params);
 354 }
 355
 356 /**
 357  * Declare deprecated functions.
 358  *
 359  * @deprecated api notice
 360  * @return array
 361  *   Array of deprecated actions
 362  */
 363 function _civicrm_api3_mailing_deprecation() {
 364   return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.');
 365 }
 366
 367 /**
 368  * Handle a reply event.
 369  *
 370  * @param array $params
 371  *
 372  * @return array
 373  */
 374 function civicrm_api3_mailing_event_reply($params) {
 375   $job       = $params['job_id'];
 376   $queue     = $params['event_queue_id'];
 377   $hash      = $params['hash'];
 378   $replyto   = $params['replyTo'];
 379   $bodyTxt   = CRM_Utils_Array::value('bodyTxt', $params);
 380   $bodyHTML  = CRM_Utils_Array::value('bodyHTML', $params);
 381   $fullEmail = CRM_Utils_Array::value('fullEmail', $params);
 382
 383   $mailing = CRM_Mailing_Event_BAO_Reply::reply($job, $queue, $hash, $replyto);
 384
 385   if (empty($mailing)) {
 386     return civicrm_api3_create_error('Queue event could not be found');
 387   }
 388
 389   CRM_Mailing_Event_BAO_Reply::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail);
 390
 391   return civicrm_api3_create_success($params);
 392 }
 393
 394 /**
 395  * Adjust Metadata for event_reply action.
 396  *
 397  * The metadata is used for setting defaults, documentation & validation.
 398  *
 399  * @param array $params
 400  *   Array of parameters determined by getfields.
 401  */
 402 function _civicrm_api3_mailing_event_reply_spec(&$params) {
 403   $params['job_id']['api.required'] = 1;
 404   $params['job_id']['title'] = 'Job ID';
 405   $params['event_queue_id']['api.required'] = 1;
 406   $params['event_queue_id']['title'] = 'Event Queue ID';
 407   $params['hash']['api.required'] = 1;
 408   $params['hash']['title'] = 'Hash';
 409   $params['replyTo']['api.required'] = 0;
 410   $params['replyTo']['title'] = 'Reply To';//doesn't really explain adequately
 411 }
 412
 413 /**
 414  * Handle a forward event.
 415  *
 416  * @param array $params
 417  *
 418  * @return array
 419  */
 420 function civicrm_api3_mailing_event_forward($params) {
 421   $job       = $params['job_id'];
 422   $queue     = $params['event_queue_id'];
 423   $hash      = $params['hash'];
 424   $email     = $params['email'];
 425   $fromEmail = CRM_Utils_Array::value('fromEmail', $params);
 426   $params    = CRM_Utils_Array::value('params', $params);
 427
 428   $forward = CRM_Mailing_Event_BAO_Forward::forward($job, $queue, $hash, $email, $fromEmail, $params);
 429
 430   if ($forward) {
 431     return civicrm_api3_create_success($params);
 432   }
 433
 434   return civicrm_api3_create_error('Queue event could not be found');
 435 }
 436
 437 /**
 438  * Adjust Metadata for event_forward action.
 439  *
 440  * The metadata is used for setting defaults, documentation & validation.
 441  *
 442  * @param array $params
 443  *   Array of parameters determined by getfields.
 444  */
 445 function _civicrm_api3_mailing_event_forward_spec(&$params) {
 446   $params['job_id']['api.required'] = 1;
 447   $params['job_id']['title'] = 'Job ID';
 448   $params['event_queue_id']['api.required'] = 1;
 449   $params['event_queue_id']['title'] = 'Event Queue ID';
 450   $params['hash']['api.required'] = 1;
 451   $params['hash']['title'] = 'Hash';
 452   $params['email']['api.required'] = 1;
 453   $params['email']['title'] = 'Forwarded to Email';
 454 }
 455
 456 /**
 457  * Handle a click event.
 458  *
 459  * @param array $params
 460  *
 461  * @return array
 462  */
 463 function civicrm_api3_mailing_event_click($params) {
 464   civicrm_api3_verify_mandatory($params,
 465     'CRM_Mailing_Event_DAO_TrackableURLOpen',
 466     array('event_queue_id', 'url_id'),
 467     FALSE
 468   );
 469
 470   $url_id = $params['url_id'];
 471   $queue = $params['event_queue_id'];
 472
 473   $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($queue, $url_id);
 474
 475   $values             = array();
 476   $values['url']      = $url;
 477   $values['is_error'] = 0;
 478
 479   return civicrm_api3_create_success($values);
 480 }
 481
 482 /**
 483  * Handle an open event.
 484  *
 485  * @param array $params
 486  *
 487  * @return array
 488  */
 489 function civicrm_api3_mailing_event_open($params) {
 490
 491   civicrm_api3_verify_mandatory($params,
 492     'CRM_Mailing_Event_DAO_Opened',
 493     array('event_queue_id'),
 494     FALSE
 495   );
 496
 497   $queue = $params['event_queue_id'];
 498   $success = CRM_Mailing_Event_BAO_Opened::open($queue);
 499
 500   if (!$success) {
 501     return civicrm_api3_create_error('mailing open event failed');
 502   }
 503
 504   return civicrm_api3_create_success($params);
 505 }
 506
 507 /**
 508  * Preview mailing.
 509  *
 510  * @param array $params
 511  *   Array per getfields metadata.
 512  *
 513  * @return array
 514  * @throws \API_Exception
 515  */
 516 function civicrm_api3_mailing_preview($params) {
 517   civicrm_api3_verify_mandatory($params,
 518     'CRM_Mailing_DAO_Mailing',
 519     array('id'),
 520     FALSE
 521   );
 522
 523   $fromEmail = NULL;
 524   if (!empty($params['from_email'])) {
 525     $fromEmail = $params['from_email'];
 526   }
 527
 528   $session = CRM_Core_Session::singleton();
 529   $mailing = new CRM_Mailing_BAO_Mailing();
 530   $mailing->id = $params['id'];
 531   $mailing->find(TRUE);
 532
 533   CRM_Mailing_BAO_Mailing::tokenReplace($mailing);
 534
 535   // get and format attachments
 536   $attachments = CRM_Core_BAO_File::getEntityFile('civicrm_mailing', $mailing->id);
 537
 538   $returnProperties = $mailing->getReturnProperties();
 539   $contactID = CRM_Utils_Array::value('contact_id', $params);
 540   if (!$contactID) {
 541     $contactID = $session->get('userID');
 542   }
 543   $mailingParams = array('contact_id' => $contactID);
 544
 545   $details = CRM_Utils_Token::getTokenDetails($mailingParams, $returnProperties, TRUE, TRUE, NULL, $mailing->getFlattenedTokens());
 546
 547   $mime = &$mailing->compose(NULL, NULL, NULL, $session->get('userID'), $fromEmail, $fromEmail,
 548     TRUE, $details[0][$contactID], $attachments
 549   );
 550
 551   return civicrm_api3_create_success(array(
 552     'id' => $params['id'],
 553     'contact_id' => $contactID,
 554     'subject' => $mime->_headers['Subject'],
 555     'body_html' => $mime->getHTMLBody(),
 556     'body_text' => $mime->getTXTBody(),
 557   ));
 558 }
 559
 560 /**
 561  * Adjust metadata for send test function.
 562  *
 563  * @param array $spec
 564  */
 565 function _civicrm_api3_mailing_send_test_spec(&$spec) {
 566   $spec['test_group']['title'] = 'Test Group ID';
 567   $spec['test_email']['title'] = 'Test Email Address';
 568 }
 569
 570 /**
 571  * Send test mailing.
 572  *
 573  * @param array $params
 574  *
 575  * @return array
 576  * @throws \API_Exception
 577  * @throws \CiviCRM_API3_Exception
 578  */
 579 function civicrm_api3_mailing_send_test($params) {
 580   if (!array_key_exists('test_group', $params) && !array_key_exists('test_email', $params)) {
 581     throw new API_Exception("Mandatory key(s) missing from params array: test_group and/or test_email field are required");
 582   }
 583   civicrm_api3_verify_mandatory($params,
 584     'CRM_Mailing_DAO_MailingJob',
 585     array('mailing_id'),
 586     FALSE
 587   );
 588
 589   $testEmailParams = _civicrm_api3_generic_replace_base_params($params);
 590   $testEmailParams['is_test'] = 1;
 591   $job = civicrm_api3('MailingJob', 'create', $testEmailParams);
 592   $testEmailParams['job_id'] = $job['id'];
 593   $testEmailParams['emails'] = explode(',', $testEmailParams['test_email']);
 594   if (!empty($params['test_email'])) {
 595     $query = CRM_Utils_SQL_Select::from('civicrm_email e')
 596         ->select(array('e.id', 'e.contact_id', 'e.email'))
 597         ->join('c', 'INNER JOIN civicrm_contact c ON e.contact_id = c.id')
 598         ->where('e.email IN (@emails)', array('@emails' => $testEmailParams['emails']))
 599         ->where('e.on_hold = 0')
 600         ->where('c.is_opt_out = 0')
 601         ->where('c.do_not_email = 0')
 602         ->where('c.is_deceased = 0')
 603         ->where('c.is_deleted = 0')
 604         ->groupBy('e.id')
 605         ->orderBy(array('e.is_bulkmail DESC', 'e.is_primary DESC'))
 606         ->toSQL();
 607     $dao = CRM_Core_DAO::executeQuery($query);
 608     $emailDetail = array();
 609     // fetch contact_id and email id for all existing emails
 610     while ($dao->fetch()) {
 611       $emailDetail[$dao->email] = array(
 612         'contact_id' => $dao->contact_id,
 613         'email_id' => $dao->id,
 614       );
 615     }
 616     $dao->free();
 617     foreach ($testEmailParams['emails'] as $key => $email) {
 618       $email = trim($email);
 619       $contactId = $emailId = NULL;
 620       if (array_key_exists($email, $emailDetail)) {
 621         $emailId = $emailDetail[$email]['email_id'];
 622         $contactId = $emailDetail[$email]['contact_id'];
 623       }
 624       if (!$contactId) {
 625         //create new contact.
 626         $contact   = civicrm_api3('Contact', 'create',
 627           array(
 628             'contact_type' => 'Individual',
 629             'email' => $email,
 630             'api.Email.get' => array('return' => 'id'),
 631           )
 632         );
 633         $contactId = $contact['id'];
 634         $emailId   = $contact['values'][$contactId]['api.Email.get']['id'];
 635       }
 636       civicrm_api3('MailingEventQueue', 'create',
 637         array(
 638           'job_id' => $job['id'],
 639           'email_id' => $emailId,
 640           'contact_id' => $contactId,
 641         )
 642       );
 643     }
 644   }
 645
 646   $isComplete = FALSE;
 647   $config = CRM_Core_Config::singleton();
 648   $mailerJobSize = Civi::settings()->get('mailerJobSize');
 649   while (!$isComplete) {
 650     // Q: In CRM_Mailing_BAO_Mailing::processQueue(), the three runJobs*()
 651     // functions are all called. Why does Mailing.send_test only call one?
 652     // CRM_Mailing_BAO_MailingJob::runJobs_pre($mailerJobSize, NULL);
 653     $isComplete = CRM_Mailing_BAO_MailingJob::runJobs($testEmailParams);
 654     // CRM_Mailing_BAO_MailingJob::runJobs_post(NULL);
 655   }
 656
 657   //return delivered mail info
 658   $mailDelivered = CRM_Mailing_Event_BAO_Delivered::getRows($params['mailing_id'], $job['id'], TRUE, NULL, NULL, NULL, TRUE);
 659
 660   return civicrm_api3_create_success($mailDelivered);
 661 }
 662
 663 /**
 664  * Adjust Metadata for send_mail action.
 665  *
 666  * The metadata is used for setting defaults, documentation & validation.
 667  *
 668  * @param array $params
 669  *   Array of parameters determined by getfields.
 670  */
 671 function _civicrm_api3_mailing_stats_spec(&$params) {
 672   $params['date']['api.default'] = 'now';
 673   $params['date']['title'] = 'Date';
 674 }
 675
 676 /**
 677  * Function which needs to be explained.
 678  *
 679  * @param array $params
 680  *
 681  * @return array
 682  * @throws \API_Exception
 683  */
 684 function civicrm_api3_mailing_stats($params) {
 685   civicrm_api3_verify_mandatory($params,
 686     'CRM_Mailing_DAO_MailingJob',
 687     array('mailing_id'),
 688     FALSE
 689   );
 690
 691   if ($params['date'] == 'now') {
 692     $params['date'] = date('YmdHis');
 693   }
 694   else {
 695     $params['date'] = CRM_Utils_Date::processDate($params['date'] . ' ' . $params['date_time']);
 696   }
 697
 698   $stats[$params['mailing_id']] = array();
 699   if (empty($params['job_id'])) {
 700     $params['job_id'] = NULL;
 701   }
 702   foreach (array('Delivered', 'Bounces', 'Unsubscribers', 'Unique Clicks', 'Opened') as $detail) {
 703     switch ($detail) {
 704       case 'Delivered':
 705         $stats[$params['mailing_id']] += array(
 706           $detail => CRM_Mailing_Event_BAO_Delivered::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
 707         );
 708         break;
 709
 710       case 'Bounces':
 711         $stats[$params['mailing_id']] += array(
 712           $detail => CRM_Mailing_Event_BAO_Bounce::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
 713         );
 714         break;
 715
 716       case 'Unsubscribers':
 717         $stats[$params['mailing_id']] += array(
 718           $detail => CRM_Mailing_Event_BAO_Unsubscribe::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date']),
 719         );
 720         break;
 721
 722       case 'Unique Clicks':
 723         $stats[$params['mailing_id']] += array(
 724           $detail => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date']),
 725         );
 726         break;
 727
 728       case 'Opened':
 729         $stats[$params['mailing_id']] += array(
 730           $detail => CRM_Mailing_Event_BAO_Opened::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
 731         );
 732         break;
 733     }
 734   }
 735   return civicrm_api3_create_success($stats);
 736 }
 737
 738 /**
 739  * Fix the reset dates on the email record based on when a mail was last delivered.
 740  *
 741  * We only consider mailings that were completed and finished in the last 3 to 7 days
 742  * Both the min and max days can be set via the params
 743  *
 744  * @param array $params
 745  *
 746  * @return array
 747  */
 748 function civicrm_api3_mailing_update_email_resetdate($params) {
 749   CRM_Mailing_Event_BAO_Delivered::updateEmailResetDate(
 750     CRM_Utils_Array::value('minDays', $params, 3),
 751     CRM_Utils_Array::value('maxDays', $params, 3)
 752   );
 753   return civicrm_api3_create_success();
 754 }