api/v3/Mailing.php

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