api/v3/Mailing.php

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