<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
- * APIv3 functions for registering/processing mailing events.
+ * APIv3 functions for registering/processing mailing jobs.
*
* @package CiviCRM_APIv3
- * @subpackage API_Mailing
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
- */
-
-/**
- * Files required for this package
*/
/**
- * Handle creation of a Mailing Job for a Mailing.
+ * Handle creation of a MailingJob for a Mailing.
+ *
+ * @param array $params
+ *
+ * @return array
+ * @throws \API_Exception
*/
function civicrm_api3_mailing_job_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_mailing_job_create_spec(&$params) {
$params['status']['api.default'] = 'Scheduled';
}
/**
- * Returns array of Mailing Jobs matching a set of one or more group properties
+ * Returns array of Mailing Jobs matching a set of one or more group properties.
*
* @param array $params
- * Array of one or more valid.
- * @param array $ids
*
* @return array
- * API return Array of matching mailing jobs
- * {@getfields mailing_job_get}
- * @access public
+ * API return Array of matching mailing jobs.
*/
-function civicrm_api3_mailing_job_get($params, $ids = array()) {
+function civicrm_api3_mailing_job_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Handle deletion of a Mailing Job for a Mailing.
+ *
+ * @param array $params
+ *
+ * @return array
+ * @throws \API_Exception
*/
function civicrm_api3_mailing_job_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);