X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailSettings.php;h=686e9acb23fb9d559286d6cf966e11ec66cdc5cd;hb=244bbdd85415317b95f70bf85a3ecb036c4fe840;hp=37d46c697bcb44f7865ae89e3dcf3f452cfe7cff;hpb=bb2a13239be55c916c3eaf2aee9519fd9b1e2823;p=civicrm-core.git diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php index 37d46c697b..686e9acb23 100644 --- a/api/v3/MailSettings.php +++ b/api/v3/MailSettings.php @@ -26,19 +26,16 @@ */ /** - * 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. @@ -53,19 +50,17 @@ function civicrm_api3_mail_settings_create($params) { * 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. @@ -75,11 +70,10 @@ function civicrm_api3_mail_settings_get($params) { } /** - * 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.