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
40 * Associative array of property.
41 * name/value pairs to insert in new 'mail_settings'
42 * @example mail_settingsCreate.php Std Create example
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
58 * Array or parameters determined by getfields.
60 function _civicrm_api3_mail_settings_create_spec(&$params) {
65 * Returns array of mail_settings matching a set of one or more group properties
67 * @param array $params
68 * Array of one or more valid.
69 * property_name=>value pairs. If $params is set
70 * as null, all mail_settings will be returned
73 * Array of matching mail_settings
74 * {@getfields mail_settings_get}
77 function civicrm_api3_mail_settings_get($params) {
78 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
82 * delete an existing mail_settings
84 * This method is used to delete any existing mail_settings. id of the group
85 * to be deleted is required field in $params array
87 * @param array $params
88 * Array containing id of the group.
93 * {@getfields mail_settings_delete}
96 function civicrm_api3_mail_settings_delete($params) {
97 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);