3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_mail_settings
33 * @copyright CiviCRM LLC (c) 2004-2014
37 * Create or update a mail_settings.
39 * @param array $params
41 * name/value pairs to insert in new 'mail_settings'
46 function civicrm_api3_mail_settings_create($params) {
47 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
51 * Adjust Metadata for Create action.
53 * The metadata is used for setting defaults, documentation & validation.
55 * @param array $params
56 * Array or parameters determined by getfields.
58 function _civicrm_api3_mail_settings_create_spec(&$params) {
63 * Returns array of mail_settings matching a set of one or more group properties.
65 * @param array $params
66 * Array of one or more valid.
67 * property_name=>value pairs. If $params is set
68 * as null, all mail_settings will be returned
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 * @param array $params
81 * Array containing id of the group.
87 function civicrm_api3_mail_settings_delete($params) {
88 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);