4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_mail_settings
34 * @copyright CiviCRM LLC (c) 2004-2013
38 * Create or update a mail_settings
40 * @param array $params Associative array of property
41 * name/value pairs to insert in new 'mail_settings'
42 * @example mail_settingsCreate.php Std Create example
44 * @return array api result array
45 * {@getfields mail_settings_create}
48 function civicrm_api3_mail_settings_create($params) {
49 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
53 * Adjust Metadata for Create action
55 * The metadata is used for setting defaults, documentation & validation
56 * @param array $params array or parameters determined by getfields
58 function _civicrm_api3_mail_settings_create_spec(&$params) {
63 * Returns array of mail_settingss matching a set of one or more group properties
65 * @param array $params (referance) Array of one or more valid
66 * property_name=>value pairs. If $params is set
67 * as null, all mail_settingss will be returned
69 * @return array (referance) Array of matching mail_settingss
70 * {@getfields mail_settings_get}
73 function civicrm_api3_mail_settings_get($params) {
74 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
78 * delete an existing mail_settings
80 * This method is used to delete any existing mail_settings. id of the group
81 * to be deleted is required field in $params array
83 * @param array $params (reference) array containing id of the group
86 * @return array returns flag true if successfull, error
88 * {@getfields mail_settings_delete}
91 function civicrm_api3_mail_settings_delete($params) {
92 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);