3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * APIv3 functions for registering/processing mailing jobs.
16 * @package CiviCRM_APIv3
20 * Handle creation of a MailingJob for a Mailing.
22 * @param array $params
25 * @throws \API_Exception
27 function civicrm_api3_mailing_job_create($params) {
28 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'MailingJob');
32 * Adjust Metadata for Create action.
34 * The metadata is used for setting defaults, documentation & validation.
36 * @param array $params
37 * Array of parameters determined by getfields.
39 function _civicrm_api3_mailing_job_create_spec(&$params) {
40 $params['status']['api.default'] = 'Scheduled';
41 $params['scheduled_date']['api.default'] = 'now';
42 $params['is_test']['api.default'] = 0;
46 * Returns array of Mailing Jobs matching a set of one or more group properties.
48 * @param array $params
51 * API return Array of matching mailing jobs.
53 function civicrm_api3_mailing_job_get($params) {
54 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'MailingJob');
58 * Handle deletion of a Mailing Job for a Mailing.
60 * @param array $params
63 * @throws \API_Exception
65 function civicrm_api3_mailing_job_delete($params) {
66 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'MailingJob');