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