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