projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 | 1 | <?php |
| 6a488035 TO |
2 | |
| 3 | /* | |
| 4 | +--------------------------------------------------------------------+ | |
| 731a0992 | 5 | | CiviCRM version 4.5 | |
| 6a488035 | 6 | +--------------------------------------------------------------------+ |
| 731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 6a488035 TO |
8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | | |
| 10 | | | | |
| 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. | | |
| 14 | | | | |
| 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. | | |
| 19 | | | | |
| 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 | +--------------------------------------------------------------------+ | |
| 27 | */ | |
| 28 | ||
| 29 | /** | |
| 30 | * File for the CiviCRM APIv3 group functions | |
| 31 | * | |
| 32 | * @package CiviCRM_APIv3 | |
| 33 | * @subpackage API_mail_settings | |
| 731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 6a488035 TO |
35 | */ |
| 36 | ||
| 37 | /** | |
| 38 | * Create or update a mail_settings | |
| 39 | * | |
| 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 | |
| 43 | * | |
| 44 | * @return array api result array | |
| 45 | * {@getfields mail_settings_create} | |
| 46 | * @access public | |
| 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 | |
| 56 | * @param array $params array or parameters determined by getfields | |
| 57 | */ | |
| 58 | function _civicrm_api3_mail_settings_create_spec(&$params) { | |
| 59 | ||
| 60 | } | |
| 61 | ||
| 62 | /** | |
| 63 | * Returns array of mail_settingss matching a set of one or more group properties | |
| 64 | * | |
| 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 | |
| 68 | * | |
| 69 | * @return array (referance) Array of matching mail_settingss | |
| 70 | * {@getfields mail_settings_get} | |
| 71 | * @access public | |
| 72 | */ | |
| 73 | function civicrm_api3_mail_settings_get($params) { | |
| 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 75 | } | |
| 76 | ||
| 77 | /** | |
| 78 | * delete an existing mail_settings | |
| 79 | * | |
| 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 | |
| 82 | * | |
| 7c285037 | 83 | * @param array $params array containing id of the group |
| 6a488035 TO |
84 | * to be deleted |
| 85 | * | |
| 7c285037 | 86 | * @return array api result array |
| 6a488035 TO |
87 | * {@getfields mail_settings_delete} |
| 88 | * @access public | |
| 89 | */ | |
| 90 | function civicrm_api3_mail_settings_delete($params) { | |
| 91 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 92 | } | |
| 93 |