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