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