Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | ||
6a488035 TO |
39 | /** |
40 | * Handle creation of a Mailing Job for a Mailing. | |
645ee340 EM |
41 | * @param $params |
42 | * @return array | |
43 | * @throws \API_Exception | |
6a488035 TO |
44 | */ |
45 | function civicrm_api3_mailing_job_create($params) { | |
46 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
47 | } | |
48 | ||
11e09c59 | 49 | /** |
6a488035 | 50 | * Adjust Metadata for Create action |
11e09c59 TO |
51 | * |
52 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
53 | * @param array $params |
54 | * Array or parameters determined by getfields. | |
11e09c59 | 55 | */ |
6a488035 TO |
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; | |
60 | } | |
61 | ||
62 | /** | |
63 | * Returns array of Mailing Jobs matching a set of one or more group properties | |
64 | * | |
cf470720 TO |
65 | * @param array $params |
66 | * Array of one or more valid. | |
69dbd1ba EM |
67 | * @param array $ids |
68 | * | |
a6c01b45 | 69 | * @return array |
72b3a70c | 70 | * API return Array of matching mailing jobs |
6a488035 TO |
71 | * {@getfields mailing_job_get} |
72 | * @access public | |
73 | */ | |
74 | function civicrm_api3_mailing_job_get($params, $ids = array()) { | |
75 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
76 | } | |
77 | ||
c43d01f3 | 78 | /** |
79 | * Handle deletion of a Mailing Job for a Mailing. | |
645ee340 EM |
80 | * @param $params |
81 | * @return array | |
82 | * @throws \API_Exception | |
c43d01f3 | 83 | */ |
84 | function civicrm_api3_mailing_job_delete($params) { | |
85 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
86 | } |