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