Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | * File for the CiviCRM APIv3 group functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_mail_settings | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | */ |
36 | ||
37 | /** | |
38 | * Create or update a mail_settings | |
39 | * | |
cf470720 TO |
40 | * @param array $params |
41 | * Associative array of property. | |
6a488035 TO |
42 | * name/value pairs to insert in new 'mail_settings' |
43 | * @example mail_settingsCreate.php Std Create example | |
44 | * | |
45 | * @return array api result array | |
46 | * {@getfields mail_settings_create} | |
47 | * @access public | |
48 | */ | |
49 | function civicrm_api3_mail_settings_create($params) { | |
50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
51 | } | |
11e09c59 TO |
52 | |
53 | /** | |
6a488035 TO |
54 | * Adjust Metadata for Create action |
55 | * | |
56 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
57 | * @param array $params |
58 | * Array or parameters determined by getfields. | |
6a488035 TO |
59 | */ |
60 | function _civicrm_api3_mail_settings_create_spec(&$params) { | |
61 | ||
62 | } | |
63 | ||
64 | /** | |
c206647d | 65 | * Returns array of mail_settings matching a set of one or more group properties |
6a488035 | 66 | * |
cf470720 TO |
67 | * @param array $params |
68 | * Array of one or more valid. | |
6a488035 | 69 | * property_name=>value pairs. If $params is set |
c206647d | 70 | * as null, all mail_settings will be returned |
6a488035 | 71 | * |
c206647d | 72 | * @return array Array of matching mail_settings |
6a488035 TO |
73 | * {@getfields mail_settings_get} |
74 | * @access public | |
75 | */ | |
76 | function civicrm_api3_mail_settings_get($params) { | |
77 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } | |
79 | ||
80 | /** | |
81 | * delete an existing mail_settings | |
82 | * | |
83 | * This method is used to delete any existing mail_settings. id of the group | |
84 | * to be deleted is required field in $params array | |
85 | * | |
cf470720 TO |
86 | * @param array $params |
87 | * Array containing id of the group. | |
6a488035 TO |
88 | * to be deleted |
89 | * | |
7c285037 | 90 | * @return array api result array |
6a488035 TO |
91 | * {@getfields mail_settings_delete} |
92 | * @access public | |
93 | */ | |
94 | function civicrm_api3_mail_settings_delete($params) { | |
95 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
96 | } | |
97 |