5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_mail_settings
35 * @copyright CiviCRM LLC (c) 2004-2013
39 * Create or update a mail_settings
41 * @param array $params Associative array of property
42 * name/value pairs to insert in new 'mail_settings'
43 * @example mail_settingsCreate.php Std Create example
45 * @return array api result array
46 * {@getfields mail_settings_create}
49 function civicrm_api3_mail_settings_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Adjust Metadata for Create action
56 * The metadata is used for setting defaults, documentation & validation
57 * @param array $params array or parameters determined by getfields
59 function _civicrm_api3_mail_settings_create_spec(&$params) {
64 * Returns array of mail_settingss matching a set of one or more group properties
66 * @param array $params (referance) Array of one or more valid
67 * property_name=>value pairs. If $params is set
68 * as null, all mail_settingss will be returned
70 * @return array (referance) Array of matching mail_settingss
71 * {@getfields mail_settings_get}
74 function civicrm_api3_mail_settings_get($params) {
75 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * delete an existing mail_settings
81 * This method is used to delete any existing mail_settings. id of the group
82 * to be deleted is required field in $params array
84 * @param array $params (reference) array containing id of the group
87 * @return array returns flag true if successfull, error
89 * {@getfields mail_settings_delete}
92 function civicrm_api3_mail_settings_delete($params) {
93 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);