[civicrm-core.git] / api / v3 / MailSettings.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 * This api exposes CiviCRM mail settings.
 *
 * @package CiviCRM_APIv3
 */

/**
 * Create or update a mail_settings.
 *
 * @param array $params
 *   name/value pairs to insert in new 'mail_settings'
 *
 * @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.
 *
 * The metadata is used for setting defaults, documentation & validation.
 *
 * @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.
 *
 * @param array $params
 *   Array of one or more property_name=>value pairs.
 *   If $params is set as null, all mail_settings will be returned
 *
 * @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.
 *
 * @param array $params
 *   [id]
 *
 * @return array
 *   API result array.
 */
function civicrm_api3_mail_settings_delete($params) {
  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
Commit	Line	Data
	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
	4	\| CiviCRM version 4.6 \|
	5	+--------------------------------------------------------------------+
	6	\| Copyright CiviCRM LLC (c) 2004-2014 \|
	7	+--------------------------------------------------------------------+
	8	\| This file is a part of CiviCRM. \|
	9	\| \|
	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. \|
	13	\| \|
	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. \|
	18	\| \|
	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	+--------------------------------------------------------------------+
	26	*/
	27
	28	/**
	29	* This api exposes CiviCRM mail settings.
	30	*
	31	* @package CiviCRM_APIv3
	32	*/
	33
	34	/**
	35	* Create or update a mail_settings.
	36	*
	37	* @param array $params
	38	* name/value pairs to insert in new 'mail_settings'
	39	*
	40	* @return array
	41	* API result array.
	42	*/
	43	function civicrm_api3_mail_settings_create($params) {
	44	return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
	45	}
	46
	47	/**
	48	* Adjust Metadata for Create action.
	49	*
	50	* The metadata is used for setting defaults, documentation & validation.
	51	*
	52	* @param array $params
	53	* Array of parameters determined by getfields.
	54	*/
	55	function _civicrm_api3_mail_settings_create_spec(&$params) {
	56
	57	}
	58
	59	/**
	60	* Returns array of mail_settings matching a set of one or more group properties.
	61	*
	62	* @param array $params
	63	* Array of one or more property_name=>value pairs.
	64	* If $params is set as null, all mail_settings will be returned
	65	*
	66	* @return array
	67	* API result array.
	68	*/
	69	function civicrm_api3_mail_settings_get($params) {
	70	return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
	71	}
	72
	73	/**
	74	* Delete an existing mail_settings.
	75	*
	76	* @param array $params
	77	* [id]
	78	*
	79	* @return array
	80	* API result array.
	81	*/
	82	function civicrm_api3_mail_settings_delete($params) {
	83	return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
	84	}