<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM mail settings.
*
* @package CiviCRM_APIv3
- * @subpackage API_mail_settings
- * @copyright CiviCRM LLC (c) 2004-2014
*/
/**
- * Create or update a mail_settings
+ * Create or update a MailSettings.
*
- * @param array $params Associative array of property
- * name/value pairs to insert in new 'mail_settings'
- * @example mail_settingsCreate.php Std Create example
+ * @param array $params
+ * name/value pairs to insert in new 'MailSettings'
*
- * @return array api result array
- * {@getfields mail_settings_create}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_mail_settings_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_mail_settings_create_spec(&$params) {
-
}
/**
- * Returns array of mail_settings matching a set of one or more group properties
+ * Returns array of MailSettings matching a set of one or more properties.
*
- * @param array $params Array of one or more valid
- * property_name=>value pairs. If $params is set
- * as null, all mail_settings will be returned
+ * @param array $params
+ * Array of one or more property_name=>value pairs.
+ * If $params is set as null, all MailSettings will be returned.
*
- * @return array Array of matching mail_settings
- * {@getfields mail_settings_get}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_mail_settings_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * delete an existing mail_settings
+ * Delete an existing MailSettings.
*
- * This method is used to delete any existing mail_settings. id of the group
- * to be deleted is required field in $params array
+ * @param array $params
+ * [id]
*
- * @param array $params array containing id of the group
- * to be deleted
- *
- * @return array api result array
- * {@getfields mail_settings_delete}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_mail_settings_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
-