3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * APIv3 functions for registering/processing mailing events.
32 * @package CiviCRM_APIv3
33 * @subpackage API_Mailing
34 * @copyright CiviCRM LLC (c) 2004-2014
40 * Handle creation of a Mailing Job for a Mailing.
43 * @throws \API_Exception
45 function civicrm_api3_mailing_job_create($params) {
46 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
50 * Adjust Metadata for Create action
52 * The metadata is used for setting defaults, documentation & validation
53 * @param array $params
54 * Array or parameters determined by getfields.
56 function _civicrm_api3_mailing_job_create_spec(&$params) {
57 $params['status']['api.default'] = 'Scheduled';
58 $params['scheduled_date']['api.default'] = 'now';
59 $params['is_test']['api.default'] = 0;
63 * Returns array of Mailing Jobs matching a set of one or more group properties
65 * @param array $params
66 * Array of one or more valid.
70 * API return Array of matching mailing jobs
71 * {@getfields mailing_job_get}
74 function civicrm_api3_mailing_job_get($params, $ids = array()) {
75 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * Handle deletion of a Mailing Job for a Mailing.
82 * @throws \API_Exception
84 function civicrm_api3_mailing_job_delete($params) {
85 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);