api/v3/MailingJob.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 /**
  40  * Handle creation of a Mailing Job for a Mailing.
  41  * @param array $params
  42  * @return array
  43  * @throws \API_Exception
  44  */
  45 function civicrm_api3_mailing_job_create($params) {
  46   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  47 }
  48
  49 /**
  50  * Adjust Metadata for Create action.
  51  *
  52  * The metadata is used for setting defaults, documentation & validation.
  53  *
  54  * @param array $params
  55  *   Array or parameters determined by getfields.
  56  */
  57 function _civicrm_api3_mailing_job_create_spec(&$params) {
  58   $params['status']['api.default'] = 'Scheduled';
  59   $params['scheduled_date']['api.default'] = 'now';
  60   $params['is_test']['api.default'] = 0;
  61 }
  62
  63 /**
  64  * Returns array of Mailing Jobs  matching a set of one or more group properties
  65  *
  66  * @param array $params
  67  *   Array of one or more valid.
  68  *
  69  * @return array
  70  *   API return Array of matching mailing jobs.
  71  *   {@getfields mailing_job_get}
  72  */
  73 function civicrm_api3_mailing_job_get($params) {
  74   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  75 }
  76
  77 /**
  78  * Handle deletion of a Mailing Job for a Mailing.
  79  * @param array $params
  80  * @return array
  81  * @throws \API_Exception
  82  */
  83 function civicrm_api3_mailing_job_delete($params) {
  84   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  85 }