+--------------------------------------------------------------------+
| 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
- * Array of property.
- * name/value pairs to insert in new 'mail_settings'
+ * name/value pairs to insert in new 'MailSettings'
*
* @return array
* API result array.
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * 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
+ * Array of one or more property_name=>value pairs.
+ * If $params is set as null, all MailSettings will be returned.
*
* @return array
* API result array.
}
/**
- * Delete an existing mail_settings.
+ * Delete an existing MailSettings.
*
* @param array $params
- * Array containing id of the group.
- * to be deleted
+ * [id]
*
* @return array
* API result array.