api/v3/MailingJob.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * APIv3 functions for registering/processing mailing events.
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Mailing
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * $Id$
  37  *
  38  */
  39
  40 /**
  41  * Files required for this package
  42  */
  43
  44 /**
  45  * Handle creation of a Mailing Job for a Mailing.
  46  */
  47 function civicrm_api3_mailing_job_create($params) {
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Adjust Metadata for Create action
  53  *
  54  * The metadata is used for setting defaults, documentation & validation
  55  * @param array $params
  56  *   Array or parameters determined by getfields.
  57  */
  58 function _civicrm_api3_mailing_job_create_spec(&$params) {
  59   $params['status']['api.default'] = 'Scheduled';
  60   $params['scheduled_date']['api.default'] = 'now';
  61   $params['is_test']['api.default'] = 0;
  62 }
  63
  64 /**
  65  * Returns array of Mailing Jobs  matching a set of one or more group properties
  66  *
  67  * @param array $params
  68  *   Array of one or more valid.
  69  * @param array $ids
  70  *
  71  * @return array
  72    *   API return Array of matching mailing jobs
  73  * {@getfields mailing_job_get}
  74  * @access public
  75  */
  76 function civicrm_api3_mailing_job_get($params, $ids = array()) {
  77   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  78 }
  79
  80 /**
  81  * Handle deletion of a Mailing Job for a Mailing.
  82  */
  83 function civicrm_api3_mailing_job_delete($params) {
  84   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  85 }
  86