997c28c0d6313936aa641443bf0cdc4fc5a95d95
3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM MailingComponent (header and footer).
31 * @package CiviCRM_APIv3
35 * Save a MailingComponent.
37 * @param array $params
39 * @throws API_Exception
43 function civicrm_api3_mailing_component_create($params) {
44 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Component');
49 * Adjust Metadata for Create action.
51 * The metadata is used for setting defaults, documentation & validation.
54 * Array of parameters determined by getfields.
56 function _civicrm_api3_mailing_component_create_spec(&$spec) {
57 $spec['is_active']['api.default'] = 1;
58 $spec['name']['api.required'] = 1;
59 $spec['component_type']['api.required'] = 1;
63 * Get a MailingComponent.
65 * @param array $params
70 function civicrm_api3_mailing_component_get($params) {
71 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
75 * Adjust metadata for get.
77 * @param array $params
79 function _civicrm_api3_mailing_component_get_spec(&$params) {
80 // fetch active records by default
81 $params['is_active']['api.default'] = 1;
85 * Delete a MailingComponent.
87 * @param array $params
89 * @throws API_Exception
93 function civicrm_api3_mailing_component_delete($params) {
94 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);