Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
232624b1 | 5 | | CiviCRM version 4.4 | |
6a488035 TO |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
36 | * $Id$ | |
37 | * | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Files required for this package | |
42 | */ | |
43 | ||
6a488035 TO |
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 | ||
11e09c59 | 51 | /** |
6a488035 | 52 | * Adjust Metadata for Create action |
11e09c59 TO |
53 | * |
54 | * The metadata is used for setting defaults, documentation & validation | |
55 | * @param array $params array or parameters determined by getfields | |
56 | */ | |
6a488035 TO |
57 | function _civicrm_api3_mailing_job_create_spec(&$params) { |
58 | $params['status']['api.default'] = 'Scheduled'; | |
59 | $params['scheduled_date']['api.default'] = 'now'; | |
60 | $params['is_test']['api.default'] = 0; | |
61 | } | |
62 | ||
63 | /** | |
64 | * Returns array of Mailing Jobs matching a set of one or more group properties | |
65 | * | |
66 | * @param array $params Array of one or more valid | |
67 | * @return array API return Array of matching mailing jobs | |
68 | * {@getfields mailing_job_get} | |
69 | * @access public | |
70 | */ | |
71 | function civicrm_api3_mailing_job_get($params, $ids = array()) { | |
72 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
73 | } | |
74 | ||
c43d01f3 | 75 | /** |
76 | * Handle deletion of a Mailing Job for a Mailing. | |
77 | */ | |
78 | function civicrm_api3_mailing_job_delete($params) { | |
79 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
80 | } | |
81 |