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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
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 | 35 | * $Id$ |
6a488035 TO |
36 | */ |
37 | ||
6a488035 TO |
38 | /** |
39 | * Handle creation of a Mailing Job for a Mailing. | |
22242c87 | 40 | * |
d0997921 | 41 | * @param array $params |
22242c87 | 42 | * |
645ee340 EM |
43 | * @return array |
44 | * @throws \API_Exception | |
6a488035 TO |
45 | */ |
46 | function civicrm_api3_mailing_job_create($params) { | |
47 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
48 | } | |
49 | ||
11e09c59 | 50 | /** |
0aa0303c EM |
51 | * Adjust Metadata for Create action. |
52 | * | |
53 | * The metadata is used for setting defaults, documentation & validation. | |
11e09c59 | 54 | * |
cf470720 TO |
55 | * @param array $params |
56 | * Array or parameters determined by getfields. | |
11e09c59 | 57 | */ |
6a488035 TO |
58 | function _civicrm_api3_mailing_job_create_spec(&$params) { |
59 | $params['status']['api.default'] = 'Scheduled'; | |
60 | $params['scheduled_date']['api.default'] = 'now'; | |
61 | $params['is_test']['api.default'] = 0; | |
62 | } | |
63 | ||
64 | /** | |
22242c87 | 65 | * Returns array of Mailing Jobs matching a set of one or more group properties. |
6a488035 | 66 | * |
cf470720 TO |
67 | * @param array $params |
68 | * Array of one or more valid. | |
69dbd1ba | 69 | * |
a6c01b45 | 70 | * @return array |
795492f3 | 71 | * API return Array of matching mailing jobs. |
6a488035 | 72 | */ |
54f1aa2a | 73 | function civicrm_api3_mailing_job_get($params) { |
6a488035 TO |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
75 | } | |
76 | ||
c43d01f3 | 77 | /** |
78 | * Handle deletion of a Mailing Job for a Mailing. | |
22242c87 | 79 | * |
d0997921 | 80 | * @param array $params |
22242c87 | 81 | * |
645ee340 EM |
82 | * @return array |
83 | * @throws \API_Exception | |
c43d01f3 | 84 | */ |
85 | function civicrm_api3_mailing_job_delete($params) { | |
86 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
87 | } |