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